add backups service

Author: ChiragAgg5k

README.md

@@ -6,7 +6,7 @@
 [![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 latest. 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/encoders/value_class_encoder.py

@@ -1,4 +1,5 @@
 import json
+from ..enums.scopes import Scopes
 from ..enums.authenticator_type import AuthenticatorType
 from ..enums.authentication_factor import AuthenticationFactor
 from ..enums.o_auth_provider import OAuthProvider
@@ -9,12 +10,12 @@
 from ..enums.timezone import Timezone
 from ..enums.browser_permission import BrowserPermission
 from ..enums.image_format import ImageFormat
+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.order_by import OrderBy
 from ..enums.runtime import Runtime
-from ..enums.scopes import Scopes
 from ..enums.template_reference_type import TemplateReferenceType
 from ..enums.vcs_reference_type import VCSReferenceType
 from ..enums.deployment_download_type import DeploymentDownloadType
@@ -42,6 +43,9 @@
 
 class ValueClassEncoder(json.JSONEncoder):
     def default(self, o):
+        if isinstance(o, Scopes):
+            return o.value
+
         if isinstance(o, AuthenticatorType):
             return o.value
 
@@ -72,6 +76,9 @@ def default(self, o):
         if isinstance(o, ImageFormat):
             return o.value
 
+        if isinstance(o, BackupServices):
+            return o.value
+
         if isinstance(o, RelationshipType):
             return o.value
 
@@ -87,9 +94,6 @@ def default(self, o):
         if isinstance(o, Runtime):
             return o.value
 
-        if isinstance(o, Scopes):
-            return o.value
-
         if isinstance(o, TemplateReferenceType):
             return o.value
 

appwrite/enums/backup_services.py

@@ -0,0 +1,6 @@
+from enum import Enum
+
+class BackupServices(Enum):
+    DATABASES = "databases"
+    FUNCTIONS = "functions"
+    STORAGE = "storage"

appwrite/enums/build_runtime.py

@@ -23,9 +23,6 @@ class BuildRuntime(Enum):
     PYTHON_3_12 = "python-3.12"
     PYTHON_ML_3_11 = "python-ml-3.11"
     PYTHON_ML_3_12 = "python-ml-3.12"
-    DENO_1_21 = "deno-1.21"
-    DENO_1_24 = "deno-1.24"
-    DENO_1_35 = "deno-1.35"
     DENO_1_40 = "deno-1.40"
     DENO_1_46 = "deno-1.46"
     DENO_2_0 = "deno-2.0"

appwrite/enums/o_auth_provider.py

@@ -40,3 +40,5 @@ class OAuthProvider(Enum):
     YANDEX = "yandex"
     ZOHO = "zoho"
     ZOOM = "zoom"
+    GITHUBIMAGINE = "githubImagine"
+    GOOGLEIMAGINE = "googleImagine"

appwrite/enums/runtime.py

@@ -23,9 +23,6 @@ class Runtime(Enum):
     PYTHON_3_12 = "python-3.12"
     PYTHON_ML_3_11 = "python-ml-3.11"
     PYTHON_ML_3_12 = "python-ml-3.12"
-    DENO_1_21 = "deno-1.21"
-    DENO_1_24 = "deno-1.24"
-    DENO_1_35 = "deno-1.35"
     DENO_1_40 = "deno-1.40"
     DENO_1_46 = "deno-1.46"
     DENO_2_0 = "deno-2.0"

appwrite/enums/scopes.py

@@ -56,3 +56,11 @@ class Scopes(Enum):
     ASSISTANT_READ = "assistant.read"
     TOKENS_READ = "tokens.read"
     TOKENS_WRITE = "tokens.write"
+    POLICIES_WRITE = "policies.write"
+    POLICIES_READ = "policies.read"
+    ARCHIVES_READ = "archives.read"
+    ARCHIVES_WRITE = "archives.write"
+    RESTORATIONS_READ = "restorations.read"
+    RESTORATIONS_WRITE = "restorations.write"
+    DOMAINS_READ = "domains.read"
+    DOMAINS_WRITE = "domains.write"

appwrite/services/account.py

@@ -2,6 +2,7 @@
 from typing import List, Dict, Any, Optional
 from ..exception import AppwriteException
 from appwrite.utils.deprecated import deprecated
+from ..enums.scopes import Scopes;
 from ..enums.authenticator_type import AuthenticatorType;
 from ..enums.authentication_factor import AuthenticationFactor;
 from ..enums.o_auth_provider import OAuthProvider;
@@ -215,6 +216,186 @@ def create_jwt(self, duration: Optional[float] = None) -> Dict[str, Any]:
             'content-type': 'application/json',
         }, api_params)
 
+    def list_keys(self, total: Optional[bool] = None) -> Dict[str, Any]:
+        """
+        Get a list of all API keys from the current account. 
+
+        Parameters
+        ----------
+        total : Optional[bool]
+            When set to false, the total count returned will be 0 and will not be calculated.
+        
+        Returns
+        -------
+        Dict[str, Any]
+            API response as a dictionary
+        
+        Raises
+        ------
+        AppwriteException
+            If API request fails
+        """
+
+        api_path = '/account/keys'
+        api_params = {}
+
+        if total is not None:
+            api_params['total'] = total
+
+        return self.client.call('get', api_path, {
+        }, api_params)
+
+    def create_key(self, name: str, scopes: List[Scopes], expire: Optional[str] = None) -> Dict[str, Any]:
+        """
+        Create a new account API key.
+
+        Parameters
+        ----------
+        name : str
+            Key name. Max length: 128 chars.
+        scopes : List[Scopes]
+            Key scopes list. Maximum of 100 scopes are allowed.
+        expire : Optional[str]
+            Expiration time in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. Use null for unlimited expiration.
+        
+        Returns
+        -------
+        Dict[str, Any]
+            API response as a dictionary
+        
+        Raises
+        ------
+        AppwriteException
+            If API request fails
+        """
+
+        api_path = '/account/keys'
+        api_params = {}
+        if name is None:
+            raise AppwriteException('Missing required parameter: "name"')
+
+        if scopes is None:
+            raise AppwriteException('Missing required parameter: "scopes"')
+
+
+        api_params['name'] = name
+        api_params['scopes'] = scopes
+        api_params['expire'] = expire
+
+        return self.client.call('post', api_path, {
+            'content-type': 'application/json',
+        }, api_params)
+
+    def get_key(self, key_id: str) -> Dict[str, Any]:
+        """
+        Get a key by its unique ID. This endpoint returns details about a specific API key in your account including it's scopes.
+
+        Parameters
+        ----------
+        key_id : str
+            Key unique ID.
+        
+        Returns
+        -------
+        Dict[str, Any]
+            API response as a dictionary
+        
+        Raises
+        ------
+        AppwriteException
+            If API request fails
+        """
+
+        api_path = '/account/keys/{keyId}'
+        api_params = {}
+        if key_id is None:
+            raise AppwriteException('Missing required parameter: "key_id"')
+
+        api_path = api_path.replace('{keyId}', key_id)
+
+
+        return self.client.call('get', api_path, {
+        }, api_params)
+
+    def update_key(self, key_id: str, name: str, scopes: List[Scopes], expire: Optional[str] = None) -> Dict[str, Any]:
+        """
+        Update a key by its unique ID. Use this endpoint to update the name, scopes, or expiration time of an API key.
+
+        Parameters
+        ----------
+        key_id : str
+            Key unique ID.
+        name : str
+            Key name. Max length: 128 chars.
+        scopes : List[Scopes]
+            Key scopes list. Maximum of 100 scopes are allowed.
+        expire : Optional[str]
+            Expiration time in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. Use null for unlimited expiration.
+        
+        Returns
+        -------
+        Dict[str, Any]
+            API response as a dictionary
+        
+        Raises
+        ------
+        AppwriteException
+            If API request fails
+        """
+
+        api_path = '/account/keys/{keyId}'
+        api_params = {}
+        if key_id is None:
+            raise AppwriteException('Missing required parameter: "key_id"')
+
+        if name is None:
+            raise AppwriteException('Missing required parameter: "name"')
+
+        if scopes is None:
+            raise AppwriteException('Missing required parameter: "scopes"')
+
+        api_path = api_path.replace('{keyId}', key_id)
+
+        api_params['name'] = name
+        api_params['scopes'] = scopes
+        api_params['expire'] = expire
+
+        return self.client.call('put', api_path, {
+            'content-type': 'application/json',
+        }, api_params)
+
+    def delete_key(self, key_id: str) -> Dict[str, Any]:
+        """
+        Delete a key by its unique ID. Once deleted, the key can no longer be used to authenticate API calls.
+
+        Parameters
+        ----------
+        key_id : str
+            Key unique ID.
+        
+        Returns
+        -------
+        Dict[str, Any]
+            API response as a dictionary
+        
+        Raises
+        ------
+        AppwriteException
+            If API request fails
+        """
+
+        api_path = '/account/keys/{keyId}'
+        api_params = {}
+        if key_id is None:
+            raise AppwriteException('Missing required parameter: "key_id"')
+
+        api_path = api_path.replace('{keyId}', key_id)
+
+
+        return self.client.call('delete', api_path, {
+            'content-type': 'application/json',
+        }, api_params)
+
     def list_logs(self, queries: Optional[List[str]] = None, total: Optional[bool] = 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.
@@ -1228,7 +1409,7 @@ def create_o_auth2_token(self, provider: OAuthProvider, success: Optional[str] =
         Parameters
         ----------
         provider : OAuthProvider
-            OAuth2 Provider. Currently, supported providers are: amazon, apple, auth0, authentik, autodesk, bitbucket, bitly, box, dailymotion, discord, disqus, dropbox, etsy, facebook, figma, github, gitlab, google, linkedin, microsoft, notion, oidc, okta, paypal, paypalSandbox, podio, salesforce, slack, spotify, stripe, tradeshift, tradeshiftBox, twitch, wordpress, yahoo, yammer, yandex, zoho, zoom.
+            OAuth2 Provider. Currently, supported providers are: amazon, apple, auth0, authentik, autodesk, bitbucket, bitly, box, dailymotion, discord, disqus, dropbox, etsy, facebook, figma, github, gitlab, google, linkedin, microsoft, notion, oidc, okta, paypal, paypalSandbox, podio, salesforce, slack, spotify, stripe, tradeshift, tradeshiftBox, twitch, wordpress, yahoo, yammer, yandex, zoho, zoom, githubImagine, googleImagine.
         success : Optional[str]
             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.
         failure : Optional[str]