appwrite-console 0.1.0__py3-none-any.whl

appwrite_console/services/webhooks.py

@@ -0,0 +1,344 @@
+from ..service import Service
+from urllib.parse import quote
+from typing import Any, Dict, List, Optional, Union
+from ..exception import AppwriteException
+from appwrite_console.utils.deprecated import deprecated
+from ..models.webhook_list import WebhookList
+from ..models.webhook import Webhook
+
+class Webhooks(Service):
+
+    def __init__(self, client) -> None:
+        super(Webhooks, self).__init__(client)
+
+    def list(
+        self,
+        queries: Optional[List[str]] = None,
+        total: Optional[bool] = None
+    ) -> WebhookList:
+        """
+        Get a list of all webhooks belonging to the project. You can use the query params to filter your results.
+
+        Parameters
+        ----------
+        queries : Optional[List[str]]
+            Array of query strings generated using the Query 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, url, authUsername, tls, events, enabled, logs, attempts
+        total : Optional[bool]
+            When set to false, the total count returned will be 0 and will not be calculated.
+        
+        Returns
+        -------
+        WebhookList
+            API response as a typed Pydantic model
+        
+        Raises
+        ------
+        AppwriteException
+            If API request fails
+        """
+
+        api_path = '/webhooks'
+        api_params = {}
+
+        if queries is not None:
+            api_params['queries'] = self._normalize_value(queries)
+        if total is not None:
+            api_params['total'] = self._normalize_value(total)
+
+        response = self.client.call('get', api_path, {
+            'X-Appwrite-Project': self.client.get_config('project'),
+            'accept': 'application/json',
+        }, api_params)
+
+        return self._parse_response(response, model=WebhookList)
+
+
+    def create(
+        self,
+        webhook_id: str,
+        url: str,
+        name: str,
+        events: List[str],
+        enabled: Optional[bool] = None,
+        tls: Optional[bool] = None,
+        auth_username: Optional[str] = None,
+        auth_password: Optional[str] = None,
+        secret: Optional[str] = None
+    ) -> Webhook:
+        """
+        Create a new webhook. Use this endpoint to configure a URL that will receive events from Appwrite when specific events occur.
+
+        Parameters
+        ----------
+        webhook_id : str
+            Webhook ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.
+        url : str
+            Webhook URL.
+        name : str
+            Webhook name. Max length: 128 chars.
+        events : List[str]
+            Events list. Maximum of 100 events are allowed.
+        enabled : Optional[bool]
+            Enable or disable a webhook.
+        tls : Optional[bool]
+            Certificate verification, false for disabled or true for enabled.
+        auth_username : Optional[str]
+            Webhook HTTP user. Max length: 256 chars.
+        auth_password : Optional[str]
+            Webhook HTTP password. Max length: 256 chars.
+        secret : Optional[str]
+            Webhook secret key. If not provided, a new key will be generated automatically. Key must be at least 8 characters long, and at max 256 characters.
+        
+        Returns
+        -------
+        Webhook
+            API response as a typed Pydantic model
+        
+        Raises
+        ------
+        AppwriteException
+            If API request fails
+        """
+
+        api_path = '/webhooks'
+        api_params = {}
+        if webhook_id is None:
+            raise AppwriteException('Missing required parameter: "webhook_id"')
+
+        if url is None:
+            raise AppwriteException('Missing required parameter: "url"')
+
+        if name is None:
+            raise AppwriteException('Missing required parameter: "name"')
+
+        if events is None:
+            raise AppwriteException('Missing required parameter: "events"')
+
+
+        api_params['webhookId'] = self._normalize_value(webhook_id)
+        api_params['url'] = self._normalize_value(url)
+        api_params['name'] = self._normalize_value(name)
+        api_params['events'] = self._normalize_value(events)
+        if enabled is not None:
+            api_params['enabled'] = self._normalize_value(enabled)
+        if tls is not None:
+            api_params['tls'] = self._normalize_value(tls)
+        if auth_username is not None:
+            api_params['authUsername'] = self._normalize_value(auth_username)
+        if auth_password is not None:
+            api_params['authPassword'] = self._normalize_value(auth_password)
+        if secret is not None:
+            api_params['secret'] = self._normalize_value(secret)
+
+        response = self.client.call('post', api_path, {
+            'X-Appwrite-Project': self.client.get_config('project'),
+            'content-type': 'application/json',
+            'accept': 'application/json',
+        }, api_params)
+
+        return self._parse_response(response, model=Webhook)
+
+
+    def get(
+        self,
+        webhook_id: str
+    ) -> Webhook:
+        """
+        Get a webhook by its unique ID. This endpoint returns details about a specific webhook configured for a project. 
+
+        Parameters
+        ----------
+        webhook_id : str
+            Webhook ID.
+        
+        Returns
+        -------
+        Webhook
+            API response as a typed Pydantic model
+        
+        Raises
+        ------
+        AppwriteException
+            If API request fails
+        """
+
+        api_path = '/webhooks/{webhookId}'
+        api_params = {}
+        if webhook_id is None:
+            raise AppwriteException('Missing required parameter: "webhook_id"')
+
+        api_path = api_path.replace('{webhookId}', str(self._normalize_value(webhook_id)))
+
+
+        response = self.client.call('get', api_path, {
+            'X-Appwrite-Project': self.client.get_config('project'),
+            'accept': 'application/json',
+        }, api_params)
+
+        return self._parse_response(response, model=Webhook)
+
+
+    def update(
+        self,
+        webhook_id: str,
+        name: str,
+        url: str,
+        events: List[str],
+        enabled: Optional[bool] = None,
+        tls: Optional[bool] = None,
+        auth_username: Optional[str] = None,
+        auth_password: Optional[str] = None
+    ) -> Webhook:
+        """
+        Update a webhook by its unique ID. Use this endpoint to update the URL, events, or status of an existing webhook.
+
+        Parameters
+        ----------
+        webhook_id : str
+            Webhook ID.
+        name : str
+            Webhook name. Max length: 128 chars.
+        url : str
+            Webhook URL.
+        events : List[str]
+            Events list. Maximum of 100 events are allowed.
+        enabled : Optional[bool]
+            Enable or disable a webhook.
+        tls : Optional[bool]
+            Certificate verification, false for disabled or true for enabled.
+        auth_username : Optional[str]
+            Webhook HTTP user. Max length: 256 chars.
+        auth_password : Optional[str]
+            Webhook HTTP password. Max length: 256 chars.
+        
+        Returns
+        -------
+        Webhook
+            API response as a typed Pydantic model
+        
+        Raises
+        ------
+        AppwriteException
+            If API request fails
+        """
+
+        api_path = '/webhooks/{webhookId}'
+        api_params = {}
+        if webhook_id is None:
+            raise AppwriteException('Missing required parameter: "webhook_id"')
+
+        if name is None:
+            raise AppwriteException('Missing required parameter: "name"')
+
+        if url is None:
+            raise AppwriteException('Missing required parameter: "url"')
+
+        if events is None:
+            raise AppwriteException('Missing required parameter: "events"')
+
+        api_path = api_path.replace('{webhookId}', str(self._normalize_value(webhook_id)))
+
+        api_params['name'] = self._normalize_value(name)
+        api_params['url'] = self._normalize_value(url)
+        api_params['events'] = self._normalize_value(events)
+        if enabled is not None:
+            api_params['enabled'] = self._normalize_value(enabled)
+        if tls is not None:
+            api_params['tls'] = self._normalize_value(tls)
+        if auth_username is not None:
+            api_params['authUsername'] = self._normalize_value(auth_username)
+        if auth_password is not None:
+            api_params['authPassword'] = self._normalize_value(auth_password)
+
+        response = self.client.call('put', api_path, {
+            'X-Appwrite-Project': self.client.get_config('project'),
+            'content-type': 'application/json',
+            'accept': 'application/json',
+        }, api_params)
+
+        return self._parse_response(response, model=Webhook)
+
+
+    def delete(
+        self,
+        webhook_id: str
+    ) -> Dict[str, Any]:
+        """
+        Delete a webhook by its unique ID. Once deleted, the webhook will no longer receive project events. 
+
+        Parameters
+        ----------
+        webhook_id : str
+            Webhook ID.
+        
+        Returns
+        -------
+        Dict[str, Any]
+            API response as a dictionary
+        
+        Raises
+        ------
+        AppwriteException
+            If API request fails
+        """
+
+        api_path = '/webhooks/{webhookId}'
+        api_params = {}
+        if webhook_id is None:
+            raise AppwriteException('Missing required parameter: "webhook_id"')
+
+        api_path = api_path.replace('{webhookId}', str(self._normalize_value(webhook_id)))
+
+
+        response = self.client.call('delete', api_path, {
+            'X-Appwrite-Project': self.client.get_config('project'),
+            'content-type': 'application/json',
+        }, api_params)
+
+        return response
+
+
+    def update_secret(
+        self,
+        webhook_id: str,
+        secret: Optional[str] = None
+    ) -> Webhook:
+        """
+        Update the webhook signing key. This endpoint can be used to regenerate the signing key used to sign and validate payload deliveries for a specific webhook.
+
+        Parameters
+        ----------
+        webhook_id : str
+            Webhook ID.
+        secret : Optional[str]
+            Webhook secret key. If not provided, a new key will be generated automatically. Key must be at least 8 characters long, and at max 256 characters.
+        
+        Returns
+        -------
+        Webhook
+            API response as a typed Pydantic model
+        
+        Raises
+        ------
+        AppwriteException
+            If API request fails
+        """
+
+        api_path = '/webhooks/{webhookId}/secret'
+        api_params = {}
+        if webhook_id is None:
+            raise AppwriteException('Missing required parameter: "webhook_id"')
+
+        api_path = api_path.replace('{webhookId}', str(self._normalize_value(webhook_id)))
+
+        if secret is not None:
+            api_params['secret'] = self._normalize_value(secret)
+
+        response = self.client.call('patch', api_path, {
+            'X-Appwrite-Project': self.client.get_config('project'),
+            'content-type': 'application/json',
+            'accept': 'application/json',
+        }, api_params)
+
+        return self._parse_response(response, model=Webhook)
+

appwrite_console/utils/__init__.py

@@ -0,0 +1 @@
+# This file makes the 'utils' directory a Python package.

appwrite_console/utils/deprecated.py

@@ -0,0 +1,51 @@
+"""
+A decorator to mark functions as deprecated.
+
+When the function is called, a DeprecationWarning is emitted.
+Compatible with Python 2.7+ and Python 3.x.
+"""
+
+import functools
+import warnings
+
+def deprecated(reason=None):
+    """
+    Decorator to mark functions as deprecated.
+    Emits a DeprecationWarning when the function is called.
+
+    Args:
+        reason (str, optional): Reason for deprecation. Defaults to None.
+
+    Usage:
+        @deprecated("Use another_function instead.")
+        def old_function(...):
+            ...
+    """
+    def decorator(func):
+        message = "Call to deprecated function '{}'.{}".format(
+            func.__name__,
+            " " + reason if reason else ""
+        )
+
+        @functools.wraps(func)
+        def wrapped(*args, **kwargs):
+            warnings.simplefilter('always', DeprecationWarning) # show warning every time
+            try:
+                warnings.warn(
+                    message,
+                    category=DeprecationWarning,
+                    stacklevel=2
+                )
+                return func(*args, **kwargs)
+            finally:
+                warnings.simplefilter('default', DeprecationWarning)  # reset filter
+        return wrapped
+
+    # Support both @deprecated and @deprecated("reason")
+    if callable(reason):
+        # Used as @deprecated without arguments
+        func = reason
+        reason = None
+        return decorator(func)
+    else:
+        return decorator

appwrite_console-0.1.0.dist-info/METADATA

@@ -0,0 +1,189 @@
+Metadata-Version: 2.4
+Name: appwrite-console
+Version: 0.1.0
+Summary: Appwrite is an open-source self-hosted backend server that abstracts and simplifies complex and repetitive development tasks behind a very simple REST API
+Home-page: https://appwrite.io/support
+Download-URL: https://github.com/appwrite/sdk-for-console-python/archive/0.1.0.tar.gz
+Author: Appwrite Team
+Author-email: Appwrite Team <team@appwrite.io>
+Maintainer: Appwrite Team
+Maintainer-email: Appwrite Team <team@appwrite.io>
+License: BSD-3-Clause
+Project-URL: Homepage, https://appwrite.io/support
+Project-URL: Repository, https://github.com/appwrite/sdk-for-console-python
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: Intended Audience :: Developers
+Classifier: Environment :: Web Environment
+Classifier: Topic :: Software Development
+Classifier: License :: OSI Approved :: BSD License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: requests
+Requires-Dist: pydantic<3,>=2
+Provides-Extra: test
+Requires-Dist: requests_mock==1.11.0; extra == "test"
+Dynamic: author
+Dynamic: download-url
+Dynamic: home-page
+Dynamic: license-file
+Dynamic: maintainer
+Dynamic: requires-python
+
+# Appwrite Console Python SDK
+
+![License](https://img.shields.io/github/license/appwrite/sdk-for-console-python.svg?style=flat-square)
+![Version](https://img.shields.io/badge/api%20version-1.9.5-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.9.x. For older versions, please check [previous releases](https://github.com/appwrite/sdk-for-console-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 Console 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](https://github.com/appwrite/appwrite/raw/main/public/images/github.png)
+
+## Installation
+
+To install via [PyPI](https://pypi.org/):
+
+```bash
+pip install appwrite-console
+```
+
+Or with `uv`:
+
+```bash
+uv add appwrite-console
+```
+
+
+## Getting Started
+
+The Appwrite Console SDK for Python drives the Console API — organizations, projects,
+billing, and everything else the Console itself calls. It is separate from
+[sdk-for-python](https://github.com/appwrite/sdk-for-python), which targets the public
+server API.
+
+### Installation
+
+```bash
+pip install appwrite-console
+```
+
+The package installs as `appwrite-console` and imports as `appwrite_console`, so it can
+sit alongside `appwrite` in the same environment.
+
+**Requirements:** Python 3.9+
+
+### Init your SDK
+
+```python
+from appwrite_console.client import Client
+
+client = Client()
+client.set_endpoint('https://cloud.appwrite.io/v1')
+client.set_project('console')
+client.set_session('your-console-session')
+```
+
+Console endpoints authenticate as a Console user, not with a project API key. Use
+`set_session()` with a Console session, or `set_jwt()` where you hold a token.
+
+For a self-hosted instance with a self-signed certificate:
+
+```python
+client.set_self_signed(True)  # Dev only
+```
+
+### Organizations
+
+```python
+from appwrite_console.services.organizations import Organizations
+
+organizations = Organizations(client)
+
+result = organizations.list()
+for organization in result.teams:
+    print(organization.id, organization.name)
+```
+
+### Projects
+
+Projects are scoped to an organization:
+
+```python
+from appwrite_console.services.organization import Organization
+
+organization = Organization(client)
+organization.client.set_organization('your-organization-id')
+
+projects = organization.list_projects()
+for project in projects.projects:
+    print(project.id, project.name)
+
+project = organization.get_project('your-project-id')
+```
+
+### Queries
+
+```python
+from appwrite_console.query import Query
+
+result = organization.list_projects(queries=[
+    Query.limit(25),
+    Query.order_desc('$createdAt'),
+])
+```
+
+### Error handling
+
+```python
+from appwrite_console.exception import AppwriteException
+
+try:
+    project = organization.get_project('missing-project')
+except AppwriteException as error:
+    print(error.message, error.code, error.type)
+```
+
+### Full example
+
+```python
+from appwrite_console.client import Client
+from appwrite_console.services.organizations import Organizations
+from appwrite_console.services.organization import Organization
+from appwrite_console.exception import AppwriteException
+
+client = Client()
+client.set_endpoint('https://cloud.appwrite.io/v1')
+client.set_project('console')
+client.set_session('your-console-session')
+
+organizations = Organizations(client)
+organization = Organization(client)
+
+try:
+    for team in organizations.list().teams:
+        client.set_organization(team.id)
+
+        for project in organization.list_projects().projects:
+            print(f'{team.name} / {project.name} ({project.id})')
+except AppwriteException as error:
+    print(f'Error: {error.message}')
+```
+
+
+## Contribution
+
+This library is auto-generated by Appwrite custom [SDK Generator](https://github.com/appwrite/sdk-generator). To learn more about how you can help us improve this SDK, please check the [contribution guide](https://github.com/appwrite/sdk-generator/blob/master/CONTRIBUTING.md) before sending a pull-request.
+
+## License
+
+Please see the [BSD-3-Clause license](https://raw.githubusercontent.com/appwrite/appwrite/master/LICENSE) file for more information.