Merge pull request #138 from appwrite/dev

Author: abnegate

CHANGELOG.md

@@ -1,5 +1,24 @@
 # Change Log
 
+## 17.0.0
+
+* [BREAKING] Changed `$sequence` type from `float` to `str` for `Row` and `Document` models
+* [BREAKING] Renamed `IndexType` enum: split into `DatabasesIndexType` (with new `SPATIAL` value) and `TablesDBIndexType`
+* [BREAKING] Replaced `specification` parameter with `build_specification` and `runtime_specification` in `functions.create()`, `functions.update()`, `sites.create()`, `sites.update()`
+* Added new `Project` service with full CRUD for project-level environment variables
+* Added new `Webhooks` service with full CRUD for project webhooks (including `update_signature`)
+* Added `Webhook` and `WebhookList` models
+* Added `users.update_impersonator()` method for enabling/disabling user impersonation
+* Added impersonation support: `set_impersonate_user_id()`, `set_impersonate_user_email()`, `set_impersonate_user_phone()` on `Client`
+* Added `impersonator` and `impersonatoruserid` optional fields to `User` model
+* Added `deployment_retention` parameter to Functions and Sites create/update
+* Added `start_command` parameter to Sites create/update
+* Added `Documentsdb`, `Vectorsdb` values to `BackupServices` and `DatabaseType` enums
+* Added `WebhooksRead`, `WebhooksWrite`, `ProjectRead`, `ProjectWrite` scopes
+* Removed `get_queue_billing_project_aggregation`, `get_queue_billing_team_aggregation`, `get_queue_priority_builds`, `get_queue_region_manager`, `get_queue_threats` from `Health` service
+* Updated `Log` model field descriptions to clarify impersonation behavior
+* Updated `X-Appwrite-Response-Format` header to `1.9.0`
+
 ## 16.0.0
 
 * Breaking change: All service methods now return typed Pydantic models instead of `Dict[str, Any]`

README.md

@@ -1,12 +1,12 @@
 # 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.8.1-blue.svg?style=flat-square)
+![Version](https://img.shields.io/badge/api%20version-1.9.0-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)
 
-**This SDK is compatible with Appwrite server version 1.8.x. For older versions, please check [previous releases](https://github.com/appwrite/sdk-for-python/releases).**
+**This SDK is compatible with Appwrite server version 1.9.x. For older versions, please check [previous releases](https://github.com/appwrite/sdk-for-python/releases).**
 
 Appwrite is an open-source backend as a service server that abstracts and simplifies complex and repetitive development tasks behind a very simple to use REST API. Appwrite aims to help you develop your apps faster and in a more secure way. Use the Python SDK to integrate your app with the Appwrite server to easily start interacting with all of Appwrite backend APIs and tools. For full API documentation and tutorials go to [https://appwrite.io/docs](https://appwrite.io/docs)
 

appwrite/client.py

@@ -15,12 +15,12 @@ def __init__(self):
         self._endpoint = 'https://cloud.appwrite.io/v1'
         self._global_headers = {
             'content-type': '',
-            'user-agent' : f'AppwritePythonSDK/16.0.0 ({platform.uname().system}; {platform.uname().version}; {platform.uname().machine})',
+            'user-agent' : f'AppwritePythonSDK/17.0.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': '16.0.0',
-            'X-Appwrite-Response-Format' : '1.8.0',
+            'x-sdk-version': '17.0.0',
+            'X-Appwrite-Response-Format' : '1.9.0',
         }
 
     def set_self_signed(self, status=True):
@@ -72,6 +72,24 @@ def set_forwarded_user_agent(self, value):
         self._global_headers['x-forwarded-user-agent'] = value
         return self
 
+    def set_impersonate_user_id(self, value):
+        """Impersonate a user by ID on an already user-authenticated request. Requires the current request to be authenticated as a user with impersonator capability; X-Appwrite-Key alone is not sufficient. Impersonator users are intentionally granted users.read so they can discover a target before impersonation begins. Internal audit logs still attribute actions to the original impersonator and record the impersonated target only in internal audit payload data."""
+
+        self._global_headers['x-appwrite-impersonate-user-id'] = value
+        return self
+
+    def set_impersonate_user_email(self, value):
+        """Impersonate a user by email on an already user-authenticated request. Requires the current request to be authenticated as a user with impersonator capability; X-Appwrite-Key alone is not sufficient. Impersonator users are intentionally granted users.read so they can discover a target before impersonation begins. Internal audit logs still attribute actions to the original impersonator and record the impersonated target only in internal audit payload data."""
+
+        self._global_headers['x-appwrite-impersonate-user-email'] = value
+        return self
+
+    def set_impersonate_user_phone(self, value):
+        """Impersonate a user by phone on an already user-authenticated request. Requires the current request to be authenticated as a user with impersonator capability; X-Appwrite-Key alone is not sufficient. Impersonator users are intentionally granted users.read so they can discover a target before impersonation begins. Internal audit logs still attribute actions to the original impersonator and record the impersonated target only in internal audit payload data."""
+
+        self._global_headers['x-appwrite-impersonate-user-phone'] = value
+        return self
+
     def call(self, method, path='', headers=None, params=None, response_type='json'):
         if headers is None:
             headers = {}

appwrite/encoders/value_class_encoder.py

@@ -13,7 +13,7 @@
 from ..enums.backup_services import BackupServices
 from ..enums.relationship_type import RelationshipType
 from ..enums.relation_mutate import RelationMutate
-from ..enums.index_type import IndexType
+from ..enums.databases_index_type import DatabasesIndexType
 from ..enums.order_by import OrderBy
 from ..enums.runtime import Runtime
 from ..enums.scopes import Scopes
@@ -29,6 +29,7 @@
 from ..enums.adapter import Adapter
 from ..enums.compression import Compression
 from ..enums.image_gravity import ImageGravity
+from ..enums.tables_db_index_type import TablesDBIndexType
 from ..enums.password_hash import PasswordHash
 from ..enums.messaging_provider_type import MessagingProviderType
 from ..enums.database_type import DatabaseType
@@ -86,7 +87,7 @@ def default(self, o):
         if isinstance(o, RelationMutate):
             return o.value
 
-        if isinstance(o, IndexType):
+        if isinstance(o, DatabasesIndexType):
             return o.value
 
         if isinstance(o, OrderBy):
@@ -134,6 +135,9 @@ def default(self, o):
         if isinstance(o, ImageGravity):
             return o.value
 
+        if isinstance(o, TablesDBIndexType):
+            return o.value
+
         if isinstance(o, PasswordHash):
             return o.value
 

appwrite/enums/backup_services.py

@@ -2,5 +2,8 @@
 
 class BackupServices(Enum):
     DATABASES = "databases"
+    TABLESDB = "tablesdb"
+    DOCUMENTSDB = "documentsdb"
+    VECTORSDB = "vectorsdb"
     FUNCTIONS = "functions"
     STORAGE = "storage"

appwrite/enums/database_type.py

@@ -3,3 +3,5 @@
 class DatabaseType(Enum):
     LEGACY = "legacy"
     TABLESDB = "tablesdb"
+    DOCUMENTSDB = "documentsdb"
+    VECTORSDB = "vectorsdb"

appwrite/enums/databases_index_type.py

@@ -0,0 +1,7 @@
+from enum import Enum
+
+class DatabasesIndexType(Enum):
+    KEY = "key"
+    FULLTEXT = "fulltext"
+    UNIQUE = "unique"
+    SPATIAL = "spatial"

appwrite/enums/scopes.py

@@ -58,6 +58,10 @@ class Scopes(Enum):
     ASSISTANT_READ = "assistant.read"
     TOKENS_READ = "tokens.read"
     TOKENS_WRITE = "tokens.write"
+    WEBHOOKS_READ = "webhooks.read"
+    WEBHOOKS_WRITE = "webhooks.write"
+    PROJECT_READ = "project.read"
+    PROJECT_WRITE = "project.write"
     POLICIES_WRITE = "policies.write"
     POLICIES_READ = "policies.read"
     ARCHIVES_READ = "archives.read"

appwrite/enums/index_type.py appwrite/enums/tables_db_index_type.pyappwrite/enums/index_type.py renamed to appwrite/enums/tables_db_index_type.py

@@ -1,6 +1,6 @@
 from enum import Enum
 
-class IndexType(Enum):
+class TablesDBIndexType(Enum):
     KEY = "key"
     FULLTEXT = "fulltext"
     UNIQUE = "unique"

appwrite/enums/template_reference_type.py

@@ -1,6 +1,6 @@
 from enum import Enum
 
 class TemplateReferenceType(Enum):
-    BRANCH = "branch"
     COMMIT = "commit"
+    BRANCH = "branch"
     TAG = "tag"