Merge pull request #113 from appwrite/dev

Add inc/dec

Author: loks0n

CHANGELOG.md

@@ -1 +1,28 @@
-# Change Log
+# Change Log
+
+## 11.1.0
+
+* Add `incrementDocumentAttribute` and `decrementDocumentAttribute` support to `Databases` service
+* Add `dart38` and `flutter332` support to runtime models
+* Add `gif` support to `ImageFormat` enum
+* Add `upsertDocument` support to `Databases` service
+
+## 11.0.0
+
+* Add `<REGION>` to doc examples due to the new multi region endpoints
+* Add doc examples and methods for bulk api transactions: `createDocuments`, `deleteDocuments` etc.
+* Add doc examples, class and methods for new `Sites` service
+* Add doc examples, class and methods for new `Tokens` service
+* Add enums for `BuildRuntime `, `Adapter`, `Framework`, `DeploymentDownloadType` and `VCSDeploymentType`
+* Update enum for `runtimes` with Pythonml312, Dart219, Flutter327 and Flutter329
+* Add `token` param to `getFilePreview` and `getFileView` for File tokens usage
+* Add `queries` and `search` params to `listMemberships` method
+* Remove `search` param from `listExecutions` method
+
+## 10.0.0
+
+* Fix requests failing by removing `Content-Type` header from `GET` and `HEAD` requests
+
+## 9.0.3
+
+* Update sdk to use Numpy-style docstrings

README.md

@@ -1,7 +1,7 @@
 # Appwrite Python SDK
 
 ![License](https://img.shields.io/github/license/appwrite/sdk-for-python.svg?style=flat-square)
-![Version](https://img.shields.io/badge/api%20version-1.7.0-blue.svg?style=flat-square)
+![Version](https://img.shields.io/badge/api%20version-1.7.4-blue.svg?style=flat-square)
 [![Build Status](https://img.shields.io/travis/com/appwrite/sdk-generator?style=flat-square)](https://travis-ci.com/appwrite/sdk-generator)
 [![Twitter Account](https://img.shields.io/twitter/follow/appwrite?color=00acee&label=twitter&style=flat-square)](https://twitter.com/appwrite)
 [![Discord](https://img.shields.io/discord/564160730845151244?label=discord&style=flat-square)](https://appwrite.io/discord)

appwrite/client.py

@@ -14,11 +14,11 @@ def __init__(self):
         self._endpoint = 'https://cloud.appwrite.io/v1'
         self._global_headers = {
             'content-type': '',
-            'user-agent' : f'AppwritePythonSDK/11.0.0 ({platform.uname().system}; {platform.uname().version}; {platform.uname().machine})',
+            'user-agent' : f'AppwritePythonSDK/11.1.0 ({platform.uname().system}; {platform.uname().version}; {platform.uname().machine})',
             'x-sdk-name': 'Python',
             'x-sdk-platform': 'server',
             'x-sdk-language': 'python',
-            'x-sdk-version': '11.0.0',
+            'x-sdk-version': '11.1.0',
             'X-Appwrite-Response-Format' : '1.7.0',
         }
 

appwrite/enums/build_runtime.py

@@ -38,6 +38,7 @@ class BuildRuntime(Enum):
     DART_3_1 = "dart-3.1"
     DART_3_3 = "dart-3.3"
     DART_3_5 = "dart-3.5"
+    DART_3_8 = "dart-3.8"
     DOTNET_6_0 = "dotnet-6.0"
     DOTNET_7_0 = "dotnet-7.0"
     DOTNET_8_0 = "dotnet-8.0"
@@ -64,3 +65,4 @@ class BuildRuntime(Enum):
     FLUTTER_3_24 = "flutter-3.24"
     FLUTTER_3_27 = "flutter-3.27"
     FLUTTER_3_29 = "flutter-3.29"
+    FLUTTER_3_32 = "flutter-3.32"

appwrite/enums/image_format.py

@@ -7,3 +7,4 @@ class ImageFormat(Enum):
     WEBP = "webp"
     HEIC = "heic"
     AVIF = "avif"
+    GIF = "gif"

appwrite/enums/runtime.py

@@ -38,6 +38,7 @@ class Runtime(Enum):
     DART_3_1 = "dart-3.1"
     DART_3_3 = "dart-3.3"
     DART_3_5 = "dart-3.5"
+    DART_3_8 = "dart-3.8"
     DOTNET_6_0 = "dotnet-6.0"
     DOTNET_7_0 = "dotnet-7.0"
     DOTNET_8_0 = "dotnet-8.0"
@@ -64,3 +65,4 @@ class Runtime(Enum):
     FLUTTER_3_24 = "flutter-3.24"
     FLUTTER_3_27 = "flutter-3.27"
     FLUTTER_3_29 = "flutter-3.29"
+    FLUTTER_3_32 = "flutter-3.32"

appwrite/services/account.py

@@ -35,6 +35,7 @@ def create(self, user_id: str, email: str, password: str, name: str = None) -> D
         """
         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).
 
+
         Parameters
         ----------
         user_id : str
@@ -84,6 +85,7 @@ def update_email(self, email: str, password: str) -> Dict[str, Any]:
         This endpoint can also be used to convert an anonymous account to a normal one, by passing an email address and a new password.
         
 
+
         Parameters
         ----------
         email : str
@@ -122,6 +124,7 @@ def list_identities(self, queries: List[str] = None) -> Dict[str, Any]:
         """
         Get the list of identities for the currently logged in user.
 
+
         Parameters
         ----------
         queries : List[str]
@@ -150,6 +153,7 @@ def delete_identity(self, identity_id: str) -> Dict[str, Any]:
         """
         Delete an identity by its unique ID.
 
+
         Parameters
         ----------
         identity_id : str
@@ -204,6 +208,7 @@ def list_logs(self, queries: List[str] = None) -> Dict[str, Any]:
         """
         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.
 
+
         Parameters
         ----------
         queries : List[str]
@@ -232,6 +237,7 @@ def update_mfa(self, mfa: bool) -> Dict[str, Any]:
         """
         Enable or disable MFA on an account.
 
+
         Parameters
         ----------
         mfa : bool
@@ -264,6 +270,7 @@ def create_mfa_authenticator(self, type: AuthenticatorType) -> Dict[str, Any]:
         """
         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.
 
+
         Parameters
         ----------
         type : AuthenticatorType
@@ -296,6 +303,7 @@ def update_mfa_authenticator(self, type: AuthenticatorType, otp: str) -> Dict[st
         """
         Verify an authenticator app after adding it using the [add authenticator](/docs/references/cloud/client-web/account#createMfaAuthenticator) method.
 
+
         Parameters
         ----------
         type : AuthenticatorType
@@ -334,6 +342,7 @@ def delete_mfa_authenticator(self, type: AuthenticatorType) -> Dict[str, Any]:
         """
         Delete an authenticator for a user by ID.
 
+
         Parameters
         ----------
         type : AuthenticatorType
@@ -366,6 +375,7 @@ def create_mfa_challenge(self, factor: AuthenticationFactor) -> Dict[str, Any]:
         """
         Begin the process of MFA verification after sign-in. Finish the flow with [updateMfaChallenge](/docs/references/cloud/client-web/account#updateMfaChallenge) method.
 
+
         Parameters
         ----------
         factor : AuthenticationFactor
@@ -398,6 +408,7 @@ def update_mfa_challenge(self, challenge_id: str, otp: str) -> Dict[str, Any]:
         """
         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.
 
+
         Parameters
         ----------
         challenge_id : str
@@ -522,6 +533,7 @@ def update_name(self, name: str) -> Dict[str, Any]:
         """
         Update currently logged in user account name.
 
+
         Parameters
         ----------
         name : str
@@ -554,6 +566,7 @@ def update_password(self, password: str, old_password: str = None) -> Dict[str,
         """
         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.
 
+
         Parameters
         ----------
         password : str
@@ -589,6 +602,7 @@ def update_phone(self, phone: str, password: str) -> Dict[str, Any]:
         """
         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.
 
+
         Parameters
         ----------
         phone : str
@@ -648,6 +662,7 @@ def update_prefs(self, prefs: dict) -> Dict[str, Any]:
         """
         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.
 
+
         Parameters
         ----------
         prefs : dict
@@ -680,6 +695,7 @@ def create_recovery(self, email: str, url: str) -> Dict[str, Any]:
         """
         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.
 
+
         Parameters
         ----------
         email : str
@@ -720,6 +736,7 @@ def update_recovery(self, user_id: str, secret: str, password: str) -> Dict[str,
         
         Please note that in order to avoid a [Redirect Attack](https://github.com/OWASP/CheatSheetSeries/blob/master/cheatsheets/Unvalidated_Redirects_and_Forwards_Cheat_Sheet.md) the only valid redirect URLs are the ones from domains you have set when adding your platforms in the console interface.
 
+
         Parameters
         ----------
         user_id : str
@@ -831,6 +848,7 @@ def create_email_password_session(self, email: str, password: str) -> Dict[str,
         
         A user is limited to 10 active sessions at a time by default. [Learn more about session limits](https://appwrite.io/docs/authentication-security#limits).
 
+
         Parameters
         ----------
         email : str
@@ -869,6 +887,7 @@ def update_magic_url_session(self, user_id: str, secret: str) -> Dict[str, Any]:
         """
         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.
 
+
         Parameters
         ----------
         user_id : str
@@ -907,6 +926,7 @@ def update_phone_session(self, user_id: str, secret: str) -> Dict[str, Any]:
         """
         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.
 
+
         Parameters
         ----------
         user_id : str
@@ -945,6 +965,7 @@ def create_session(self, user_id: str, secret: str) -> Dict[str, Any]:
         """
         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.
 
+
         Parameters
         ----------
         user_id : str
@@ -983,6 +1004,7 @@ def get_session(self, session_id: str) -> Dict[str, Any]:
         """
         Use this endpoint to get a logged in user's session using a Session ID. Inputting 'current' will return the current session being used.
 
+
         Parameters
         ----------
         session_id : str
@@ -1014,6 +1036,7 @@ def update_session(self, session_id: str) -> Dict[str, Any]:
         """
         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.
 
+
         Parameters
         ----------
         session_id : str
@@ -1046,6 +1069,7 @@ def delete_session(self, session_id: str) -> Dict[str, Any]:
         """
         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.
 
+
         Parameters
         ----------
         session_id : str
@@ -1102,6 +1126,7 @@ def create_email_token(self, user_id: str, email: str, phrase: bool = None) -> D
         
         A user is limited to 10 active sessions at a time by default. [Learn more about session limits](https://appwrite.io/docs/authentication-security#limits).
 
+
         Parameters
         ----------
         user_id : str
@@ -1146,6 +1171,7 @@ def create_magic_url_token(self, user_id: str, email: str, url: str = None, phra
         A user is limited to 10 active sessions at a time by default. [Learn more about session limits](https://appwrite.io/docs/authentication-security#limits).
         
 
+
         Parameters
         ----------
         user_id : str
@@ -1194,6 +1220,7 @@ def create_o_auth2_token(self, provider: OAuthProvider, success: str = None, fai
         
         A user is limited to 10 active sessions at a time by default. [Learn more about session limits](https://appwrite.io/docs/authentication-security#limits).
 
+
         Parameters
         ----------
         provider : OAuthProvider
@@ -1236,6 +1263,7 @@ def create_phone_token(self, user_id: str, phone: str) -> Dict[str, Any]:
         
         A user is limited to 10 active sessions at a time by default. [Learn more about session limits](https://appwrite.io/docs/authentication-security#limits).
 
+
         Parameters
         ----------
         user_id : str
@@ -1277,6 +1305,7 @@ def create_verification(self, url: str) -> Dict[str, Any]:
         Please note that in order to avoid a [Redirect Attack](https://github.com/OWASP/CheatSheetSeries/blob/master/cheatsheets/Unvalidated_Redirects_and_Forwards_Cheat_Sheet.md), the only valid redirect URLs are the ones from domains you have set when adding your platforms in the console interface.
         
 
+
         Parameters
         ----------
         url : str
@@ -1309,6 +1338,7 @@ def update_verification(self, user_id: str, secret: str) -> Dict[str, Any]:
         """
         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.
 
+
         Parameters
         ----------
         user_id : str
@@ -1369,6 +1399,7 @@ def update_phone_verification(self, user_id: str, secret: str) -> Dict[str, Any]
         """
         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.
 
+
         Parameters
         ----------
         user_id : str

appwrite/services/avatars.py

@@ -16,6 +16,7 @@ def get_browser(self, code: Browser, width: float = None, height: float = None,
         
         When 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.
 
+
         Parameters
         ----------
         code : Browser
@@ -59,6 +60,7 @@ def get_credit_card(self, code: CreditCard, width: float = None, height: float =
         When 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.
         
 
+
         Parameters
         ----------
         code : CreditCard
@@ -101,6 +103,7 @@ def get_favicon(self, url: str) -> bytes:
         
         This endpoint does not follow HTTP redirects.
 
+
         Parameters
         ----------
         url : str
@@ -135,6 +138,7 @@ def get_flag(self, code: Flag, width: float = None, height: float = None, qualit
         When 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.
         
 
+
         Parameters
         ----------
         code : Flag
@@ -179,6 +183,7 @@ def get_image(self, url: str, width: float = None, height: float = None) -> byte
         
         This endpoint does not follow HTTP redirects.
 
+
         Parameters
         ----------
         url : str
@@ -221,6 +226,7 @@ def get_initials(self, name: str = None, width: float = None, height: float = No
         When 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.
         
 
+
         Parameters
         ----------
         name : str
@@ -259,6 +265,7 @@ def get_qr(self, text: str, size: float = None, margin: float = None, download:
         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.
         
 
+
         Parameters
         ----------
         text : str