diff --git a/README.md b/README.md index 86bb1c4..9dd9d0c 100644 --- a/README.md +++ b/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.4.2-blue.svg?style=flat-square) +![Version](https://img.shields.io/badge/api%20version-1.4.12-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) diff --git a/appwrite/client.py b/appwrite/client.py index 73f97c1..d5dd8c7 100644 --- a/appwrite/client.py +++ b/appwrite/client.py @@ -11,11 +11,11 @@ def __init__(self): self._endpoint = 'https://HOSTNAME/v1' self._global_headers = { 'content-type': '', - 'user-agent' : 'AppwritePythonSDK/4.0.0 (${os.uname().sysname}; ${os.uname().version}; ${os.uname().machine})', + 'user-agent' : 'AppwritePythonSDK/4.1.0 (${os.uname().sysname}; ${os.uname().version}; ${os.uname().machine})', 'x-sdk-name': 'Python', 'x-sdk-platform': 'server', 'x-sdk-language': 'python', - 'x-sdk-version': '4.0.0', + 'x-sdk-version': '4.1.0', 'X-Appwrite-Response-Format' : '1.4.0', } diff --git a/appwrite/query.py b/appwrite/query.py index da63672..d970bd8 100644 --- a/appwrite/query.py +++ b/appwrite/query.py @@ -33,7 +33,7 @@ def is_not_null(attribute): @staticmethod def between(attribute, start, end): - return Query.add_query(attribute, "between", [start, end]) + return f'between("{attribute}", {Query.parseValues(start)}, {Query.parseValues(end)})' @staticmethod def starts_with(attribute, value): diff --git a/appwrite/services/account.py b/appwrite/services/account.py index 29ab85c..278d890 100644 --- a/appwrite/services/account.py +++ b/appwrite/services/account.py @@ -7,7 +7,7 @@ def __init__(self, client): super(Account, self).__init__(client) def get(self): - """Get Account""" + """Get account""" api_path = '/account' @@ -18,7 +18,7 @@ def get(self): }, api_params) def update_email(self, email, password): - """Update Email""" + """Update email""" api_path = '/account/email' @@ -67,7 +67,7 @@ def delete_identity(self, identity_id): }, api_params) def list_logs(self, queries = None): - """List Logs""" + """List logs""" api_path = '/account/logs' @@ -80,7 +80,7 @@ def list_logs(self, queries = None): }, api_params) def update_name(self, name): - """Update Name""" + """Update name""" api_path = '/account/name' @@ -96,7 +96,7 @@ def update_name(self, name): }, api_params) def update_password(self, password, old_password = None): - """Update Password""" + """Update password""" api_path = '/account/password' @@ -113,7 +113,7 @@ def update_password(self, password, old_password = None): }, api_params) def update_phone(self, phone, password): - """Update Phone""" + """Update phone""" api_path = '/account/phone' @@ -133,7 +133,7 @@ def update_phone(self, phone, password): }, api_params) def get_prefs(self): - """Get Account Preferences""" + """Get account preferences""" api_path = '/account/prefs' @@ -144,7 +144,7 @@ def get_prefs(self): }, api_params) def update_prefs(self, prefs): - """Update Preferences""" + """Update preferences""" api_path = '/account/prefs' @@ -160,7 +160,7 @@ def update_prefs(self, prefs): }, api_params) def create_recovery(self, email, url): - """Create Password Recovery""" + """Create password recovery""" api_path = '/account/recovery' @@ -180,7 +180,7 @@ def create_recovery(self, email, url): }, api_params) def update_recovery(self, user_id, secret, password, password_again): - """Create Password Recovery (confirmation)""" + """Create password recovery (confirmation)""" api_path = '/account/recovery' @@ -208,7 +208,7 @@ def update_recovery(self, user_id, secret, password, password_again): }, api_params) def list_sessions(self): - """List Sessions""" + """List sessions""" api_path = '/account/sessions' @@ -219,7 +219,7 @@ def list_sessions(self): }, api_params) def delete_sessions(self): - """Delete Sessions""" + """Delete sessions""" api_path = '/account/sessions' @@ -230,7 +230,7 @@ def delete_sessions(self): }, api_params) def get_session(self, session_id): - """Get Session""" + """Get session""" api_path = '/account/sessions/{sessionId}' @@ -246,7 +246,7 @@ def get_session(self, session_id): }, api_params) def update_session(self, session_id): - """Update OAuth Session (Refresh Tokens)""" + """Update OAuth session (refresh tokens)""" api_path = '/account/sessions/{sessionId}' @@ -262,7 +262,7 @@ def update_session(self, session_id): }, api_params) def delete_session(self, session_id): - """Delete Session""" + """Delete session""" api_path = '/account/sessions/{sessionId}' @@ -278,7 +278,7 @@ def delete_session(self, session_id): }, api_params) def update_status(self): - """Update Status""" + """Update status""" api_path = '/account/status' @@ -289,7 +289,7 @@ def update_status(self): }, api_params) def create_verification(self, url): - """Create Email Verification""" + """Create email verification""" api_path = '/account/verification' @@ -305,7 +305,7 @@ def create_verification(self, url): }, api_params) def update_verification(self, user_id, secret): - """Create Email Verification (confirmation)""" + """Create email verification (confirmation)""" api_path = '/account/verification' @@ -325,7 +325,7 @@ def update_verification(self, user_id, secret): }, api_params) def create_phone_verification(self): - """Create Phone Verification""" + """Create phone verification""" api_path = '/account/verification/phone' @@ -336,7 +336,7 @@ def create_phone_verification(self): }, api_params) def update_phone_verification(self, user_id, secret): - """Create Phone Verification (confirmation)""" + """Create phone verification (confirmation)""" api_path = '/account/verification/phone' diff --git a/appwrite/services/avatars.py b/appwrite/services/avatars.py index 6b7ed84..0a9b400 100644 --- a/appwrite/services/avatars.py +++ b/appwrite/services/avatars.py @@ -7,7 +7,7 @@ def __init__(self, client): super(Avatars, self).__init__(client) def get_browser(self, code, width = None, height = None, quality = None): - """Get Browser Icon""" + """Get browser icon""" api_path = '/avatars/browsers/{code}' @@ -26,7 +26,7 @@ def get_browser(self, code, width = None, height = None, quality = None): }, api_params) def get_credit_card(self, code, width = None, height = None, quality = None): - """Get Credit Card Icon""" + """Get credit card icon""" api_path = '/avatars/credit-cards/{code}' @@ -45,7 +45,7 @@ def get_credit_card(self, code, width = None, height = None, quality = None): }, api_params) def get_favicon(self, url): - """Get Favicon""" + """Get favicon""" api_path = '/avatars/favicon' @@ -61,7 +61,7 @@ def get_favicon(self, url): }, api_params) def get_flag(self, code, width = None, height = None, quality = None): - """Get Country Flag""" + """Get country flag""" api_path = '/avatars/flags/{code}' @@ -80,7 +80,7 @@ def get_flag(self, code, width = None, height = None, quality = None): }, api_params) def get_image(self, url, width = None, height = None): - """Get Image from URL""" + """Get image from URL""" api_path = '/avatars/image' @@ -98,7 +98,7 @@ def get_image(self, url, width = None, height = None): }, api_params) def get_initials(self, name = None, width = None, height = None, background = None): - """Get User Initials""" + """Get user initials""" api_path = '/avatars/initials' @@ -114,7 +114,7 @@ def get_initials(self, name = None, width = None, height = None, background = No }, api_params) def get_qr(self, text, size = None, margin = None, download = None): - """Get QR Code""" + """Get QR code""" api_path = '/avatars/qr' diff --git a/appwrite/services/databases.py b/appwrite/services/databases.py index 1a8384c..801b19b 100644 --- a/appwrite/services/databases.py +++ b/appwrite/services/databases.py @@ -7,7 +7,7 @@ def __init__(self, client): super(Databases, self).__init__(client) def list(self, queries = None, search = None): - """List Databases""" + """List databases""" api_path = '/databases' @@ -21,7 +21,7 @@ def list(self, queries = None, search = None): }, api_params) def create(self, database_id, name, enabled = None): - """Create Database""" + """Create database""" api_path = '/databases' @@ -42,7 +42,7 @@ def create(self, database_id, name, enabled = None): }, api_params) def get(self, database_id): - """Get Database""" + """Get database""" api_path = '/databases/{databaseId}' @@ -58,7 +58,7 @@ def get(self, database_id): }, api_params) def update(self, database_id, name, enabled = None): - """Update Database""" + """Update database""" api_path = '/databases/{databaseId}' @@ -79,7 +79,7 @@ def update(self, database_id, name, enabled = None): }, api_params) def delete(self, database_id): - """Delete Database""" + """Delete database""" api_path = '/databases/{databaseId}' @@ -95,7 +95,7 @@ def delete(self, database_id): }, api_params) def list_collections(self, database_id, queries = None, search = None): - """List Collections""" + """List collections""" api_path = '/databases/{databaseId}/collections' @@ -113,7 +113,7 @@ def list_collections(self, database_id, queries = None, search = None): }, api_params) def create_collection(self, database_id, collection_id, name, permissions = None, document_security = None, enabled = None): - """Create Collection""" + """Create collection""" api_path = '/databases/{databaseId}/collections' @@ -140,7 +140,7 @@ def create_collection(self, database_id, collection_id, name, permissions = None }, api_params) def get_collection(self, database_id, collection_id): - """Get Collection""" + """Get collection""" api_path = '/databases/{databaseId}/collections/{collectionId}' @@ -160,7 +160,7 @@ def get_collection(self, database_id, collection_id): }, api_params) def update_collection(self, database_id, collection_id, name, permissions = None, document_security = None, enabled = None): - """Update Collection""" + """Update collection""" api_path = '/databases/{databaseId}/collections/{collectionId}' @@ -187,7 +187,7 @@ def update_collection(self, database_id, collection_id, name, permissions = None }, api_params) def delete_collection(self, database_id, collection_id): - """Delete Collection""" + """Delete collection""" api_path = '/databases/{databaseId}/collections/{collectionId}' @@ -207,7 +207,7 @@ def delete_collection(self, database_id, collection_id): }, api_params) def list_attributes(self, database_id, collection_id, queries = None): - """List Attributes""" + """List attributes""" api_path = '/databases/{databaseId}/collections/{collectionId}/attributes' @@ -228,7 +228,7 @@ def list_attributes(self, database_id, collection_id, queries = None): }, api_params) def create_boolean_attribute(self, database_id, collection_id, key, required, default = None, array = None): - """Create Boolean Attribute""" + """Create boolean attribute""" api_path = '/databases/{databaseId}/collections/{collectionId}/attributes/boolean' @@ -258,7 +258,7 @@ def create_boolean_attribute(self, database_id, collection_id, key, required, de }, api_params) def update_boolean_attribute(self, database_id, collection_id, key, required, default): - """Update Boolean Attribute""" + """Update boolean attribute""" api_path = '/databases/{databaseId}/collections/{collectionId}/attributes/boolean/{key}' @@ -287,7 +287,7 @@ def update_boolean_attribute(self, database_id, collection_id, key, required, de }, api_params) def create_datetime_attribute(self, database_id, collection_id, key, required, default = None, array = None): - """Create DateTime Attribute""" + """Create datetime attribute""" api_path = '/databases/{databaseId}/collections/{collectionId}/attributes/datetime' @@ -317,7 +317,7 @@ def create_datetime_attribute(self, database_id, collection_id, key, required, d }, api_params) def update_datetime_attribute(self, database_id, collection_id, key, required, default): - """Update DateTime Attribute""" + """Update dateTime attribute""" api_path = '/databases/{databaseId}/collections/{collectionId}/attributes/datetime/{key}' @@ -346,7 +346,7 @@ def update_datetime_attribute(self, database_id, collection_id, key, required, d }, api_params) def create_email_attribute(self, database_id, collection_id, key, required, default = None, array = None): - """Create Email Attribute""" + """Create email attribute""" api_path = '/databases/{databaseId}/collections/{collectionId}/attributes/email' @@ -376,7 +376,7 @@ def create_email_attribute(self, database_id, collection_id, key, required, defa }, api_params) def update_email_attribute(self, database_id, collection_id, key, required, default): - """Update Email Attribute""" + """Update email attribute""" api_path = '/databases/{databaseId}/collections/{collectionId}/attributes/email/{key}' @@ -405,7 +405,7 @@ def update_email_attribute(self, database_id, collection_id, key, required, defa }, api_params) def create_enum_attribute(self, database_id, collection_id, key, elements, required, default = None, array = None): - """Create Enum Attribute""" + """Create enum attribute""" api_path = '/databases/{databaseId}/collections/{collectionId}/attributes/enum' @@ -439,7 +439,7 @@ def create_enum_attribute(self, database_id, collection_id, key, elements, requi }, api_params) def update_enum_attribute(self, database_id, collection_id, key, elements, required, default): - """Update Enum Attribute""" + """Update enum attribute""" api_path = '/databases/{databaseId}/collections/{collectionId}/attributes/enum/{key}' @@ -472,7 +472,7 @@ def update_enum_attribute(self, database_id, collection_id, key, elements, requi }, api_params) def create_float_attribute(self, database_id, collection_id, key, required, min = None, max = None, default = None, array = None): - """Create Float Attribute""" + """Create float attribute""" api_path = '/databases/{databaseId}/collections/{collectionId}/attributes/float' @@ -504,7 +504,7 @@ def create_float_attribute(self, database_id, collection_id, key, required, min }, api_params) def update_float_attribute(self, database_id, collection_id, key, required, min, max, default): - """Update Float Attribute""" + """Update float attribute""" api_path = '/databases/{databaseId}/collections/{collectionId}/attributes/float/{key}' @@ -541,7 +541,7 @@ def update_float_attribute(self, database_id, collection_id, key, required, min, }, api_params) def create_integer_attribute(self, database_id, collection_id, key, required, min = None, max = None, default = None, array = None): - """Create Integer Attribute""" + """Create integer attribute""" api_path = '/databases/{databaseId}/collections/{collectionId}/attributes/integer' @@ -573,7 +573,7 @@ def create_integer_attribute(self, database_id, collection_id, key, required, mi }, api_params) def update_integer_attribute(self, database_id, collection_id, key, required, min, max, default): - """Update Integer Attribute""" + """Update integer attribute""" api_path = '/databases/{databaseId}/collections/{collectionId}/attributes/integer/{key}' @@ -610,7 +610,7 @@ def update_integer_attribute(self, database_id, collection_id, key, required, mi }, api_params) def create_ip_attribute(self, database_id, collection_id, key, required, default = None, array = None): - """Create IP Address Attribute""" + """Create IP address attribute""" api_path = '/databases/{databaseId}/collections/{collectionId}/attributes/ip' @@ -640,7 +640,7 @@ def create_ip_attribute(self, database_id, collection_id, key, required, default }, api_params) def update_ip_attribute(self, database_id, collection_id, key, required, default): - """Update IP Address Attribute""" + """Update IP address attribute""" api_path = '/databases/{databaseId}/collections/{collectionId}/attributes/ip/{key}' @@ -669,7 +669,7 @@ def update_ip_attribute(self, database_id, collection_id, key, required, default }, api_params) def create_relationship_attribute(self, database_id, collection_id, related_collection_id, type, two_way = None, key = None, two_way_key = None, on_delete = None): - """Create Relationship Attribute""" + """Create relationship attribute""" api_path = '/databases/{databaseId}/collections/{collectionId}/attributes/relationship' @@ -701,7 +701,7 @@ def create_relationship_attribute(self, database_id, collection_id, related_coll }, api_params) def create_string_attribute(self, database_id, collection_id, key, size, required, default = None, array = None, encrypt = None): - """Create String Attribute""" + """Create string attribute""" api_path = '/databases/{databaseId}/collections/{collectionId}/attributes/string' @@ -736,7 +736,7 @@ def create_string_attribute(self, database_id, collection_id, key, size, require }, api_params) def update_string_attribute(self, database_id, collection_id, key, required, default): - """Update String Attribute""" + """Update string attribute""" api_path = '/databases/{databaseId}/collections/{collectionId}/attributes/string/{key}' @@ -765,7 +765,7 @@ def update_string_attribute(self, database_id, collection_id, key, required, def }, api_params) def create_url_attribute(self, database_id, collection_id, key, required, default = None, array = None): - """Create URL Attribute""" + """Create URL attribute""" api_path = '/databases/{databaseId}/collections/{collectionId}/attributes/url' @@ -795,7 +795,7 @@ def create_url_attribute(self, database_id, collection_id, key, required, defaul }, api_params) def update_url_attribute(self, database_id, collection_id, key, required, default): - """Update URL Attribute""" + """Update URL attribute""" api_path = '/databases/{databaseId}/collections/{collectionId}/attributes/url/{key}' @@ -824,7 +824,7 @@ def update_url_attribute(self, database_id, collection_id, key, required, defaul }, api_params) def get_attribute(self, database_id, collection_id, key): - """Get Attribute""" + """Get attribute""" api_path = '/databases/{databaseId}/collections/{collectionId}/attributes/{key}' @@ -848,7 +848,7 @@ def get_attribute(self, database_id, collection_id, key): }, api_params) def delete_attribute(self, database_id, collection_id, key): - """Delete Attribute""" + """Delete attribute""" api_path = '/databases/{databaseId}/collections/{collectionId}/attributes/{key}' @@ -872,7 +872,7 @@ def delete_attribute(self, database_id, collection_id, key): }, api_params) def update_relationship_attribute(self, database_id, collection_id, key, on_delete = None): - """Update Relationship Attribute""" + """Update relationship attribute""" api_path = '/databases/{databaseId}/collections/{collectionId}/attributes/{key}/relationship' @@ -897,7 +897,7 @@ def update_relationship_attribute(self, database_id, collection_id, key, on_dele }, api_params) def list_documents(self, database_id, collection_id, queries = None): - """List Documents""" + """List documents""" api_path = '/databases/{databaseId}/collections/{collectionId}/documents' @@ -918,7 +918,7 @@ def list_documents(self, database_id, collection_id, queries = None): }, api_params) def create_document(self, database_id, collection_id, document_id, data, permissions = None): - """Create Document""" + """Create document""" api_path = '/databases/{databaseId}/collections/{collectionId}/documents' @@ -947,7 +947,7 @@ def create_document(self, database_id, collection_id, document_id, data, permiss }, api_params) def get_document(self, database_id, collection_id, document_id, queries = None): - """Get Document""" + """Get document""" api_path = '/databases/{databaseId}/collections/{collectionId}/documents/{documentId}' @@ -972,7 +972,7 @@ def get_document(self, database_id, collection_id, document_id, queries = None): }, api_params) def update_document(self, database_id, collection_id, document_id, data = None, permissions = None): - """Update Document""" + """Update document""" api_path = '/databases/{databaseId}/collections/{collectionId}/documents/{documentId}' @@ -998,7 +998,7 @@ def update_document(self, database_id, collection_id, document_id, data = None, }, api_params) def delete_document(self, database_id, collection_id, document_id): - """Delete Document""" + """Delete document""" api_path = '/databases/{databaseId}/collections/{collectionId}/documents/{documentId}' @@ -1022,7 +1022,7 @@ def delete_document(self, database_id, collection_id, document_id): }, api_params) def list_indexes(self, database_id, collection_id, queries = None): - """List Indexes""" + """List indexes""" api_path = '/databases/{databaseId}/collections/{collectionId}/indexes' @@ -1043,7 +1043,7 @@ def list_indexes(self, database_id, collection_id, queries = None): }, api_params) def create_index(self, database_id, collection_id, key, type, attributes, orders = None): - """Create Index""" + """Create index""" api_path = '/databases/{databaseId}/collections/{collectionId}/indexes' @@ -1076,7 +1076,7 @@ def create_index(self, database_id, collection_id, key, type, attributes, orders }, api_params) def get_index(self, database_id, collection_id, key): - """Get Index""" + """Get index""" api_path = '/databases/{databaseId}/collections/{collectionId}/indexes/{key}' @@ -1100,7 +1100,7 @@ def get_index(self, database_id, collection_id, key): }, api_params) def delete_index(self, database_id, collection_id, key): - """Delete Index""" + """Delete index""" api_path = '/databases/{databaseId}/collections/{collectionId}/indexes/{key}' diff --git a/appwrite/services/functions.py b/appwrite/services/functions.py index a08e7eb..f5e3d42 100644 --- a/appwrite/services/functions.py +++ b/appwrite/services/functions.py @@ -7,7 +7,7 @@ def __init__(self, client): super(Functions, self).__init__(client) def list(self, queries = None, search = None): - """List Functions""" + """List functions""" api_path = '/functions' @@ -21,7 +21,7 @@ def list(self, queries = None, search = None): }, api_params) def create(self, function_id, name, runtime, execute = None, events = None, schedule = None, timeout = None, enabled = None, logging = None, entrypoint = None, commands = None, installation_id = None, provider_repository_id = None, provider_branch = None, provider_silent_mode = None, provider_root_directory = None, template_repository = None, template_owner = None, template_root_directory = None, template_branch = None): - """Create Function""" + """Create function""" api_path = '/functions' @@ -73,7 +73,7 @@ def list_runtimes(self): }, api_params) def get(self, function_id): - """Get Function""" + """Get function""" api_path = '/functions/{functionId}' @@ -89,7 +89,7 @@ def get(self, function_id): }, api_params) def update(self, function_id, name, runtime = None, execute = None, events = None, schedule = None, timeout = None, enabled = None, logging = None, entrypoint = None, commands = None, installation_id = None, provider_repository_id = None, provider_branch = None, provider_silent_mode = None, provider_root_directory = None): - """Update Function""" + """Update function""" api_path = '/functions/{functionId}' @@ -123,7 +123,7 @@ def update(self, function_id, name, runtime = None, execute = None, events = Non }, api_params) def delete(self, function_id): - """Delete Function""" + """Delete function""" api_path = '/functions/{functionId}' @@ -139,7 +139,7 @@ def delete(self, function_id): }, api_params) def list_deployments(self, function_id, queries = None, search = None): - """List Deployments""" + """List deployments""" api_path = '/functions/{functionId}/deployments' @@ -157,7 +157,7 @@ def list_deployments(self, function_id, queries = None, search = None): }, api_params) def create_deployment(self, function_id, code, activate, entrypoint = None, commands = None, on_progress = None): - """Create Deployment""" + """Create deployment""" api_path = '/functions/{functionId}/deployments' @@ -188,7 +188,7 @@ def create_deployment(self, function_id, code, activate, entrypoint = None, comm }, api_params, param_name, on_progress, upload_id) def get_deployment(self, function_id, deployment_id): - """Get Deployment""" + """Get deployment""" api_path = '/functions/{functionId}/deployments/{deploymentId}' @@ -208,7 +208,7 @@ def get_deployment(self, function_id, deployment_id): }, api_params) def update_deployment(self, function_id, deployment_id): - """Update Function Deployment""" + """Update function deployment""" api_path = '/functions/{functionId}/deployments/{deploymentId}' @@ -228,7 +228,7 @@ def update_deployment(self, function_id, deployment_id): }, api_params) def delete_deployment(self, function_id, deployment_id): - """Delete Deployment""" + """Delete deployment""" api_path = '/functions/{functionId}/deployments/{deploymentId}' @@ -248,7 +248,7 @@ def delete_deployment(self, function_id, deployment_id): }, api_params) def create_build(self, function_id, deployment_id, build_id): - """Create Build""" + """Create build""" api_path = '/functions/{functionId}/deployments/{deploymentId}/builds/{buildId}' @@ -292,7 +292,7 @@ def download_deployment(self, function_id, deployment_id): }, api_params) def list_executions(self, function_id, queries = None, search = None): - """List Executions""" + """List executions""" api_path = '/functions/{functionId}/executions' @@ -310,7 +310,7 @@ def list_executions(self, function_id, queries = None, search = None): }, api_params) def create_execution(self, function_id, body = None, xasync = None, path = None, method = None, headers = None): - """Create Execution""" + """Create execution""" api_path = '/functions/{functionId}/executions' @@ -331,7 +331,7 @@ def create_execution(self, function_id, body = None, xasync = None, path = None, }, api_params) def get_execution(self, function_id, execution_id): - """Get Execution""" + """Get execution""" api_path = '/functions/{functionId}/executions/{executionId}' @@ -351,7 +351,7 @@ def get_execution(self, function_id, execution_id): }, api_params) def list_variables(self, function_id): - """List Variables""" + """List variables""" api_path = '/functions/{functionId}/variables' @@ -367,7 +367,7 @@ def list_variables(self, function_id): }, api_params) def create_variable(self, function_id, key, value): - """Create Variable""" + """Create variable""" api_path = '/functions/{functionId}/variables' @@ -391,7 +391,7 @@ def create_variable(self, function_id, key, value): }, api_params) def get_variable(self, function_id, variable_id): - """Get Variable""" + """Get variable""" api_path = '/functions/{functionId}/variables/{variableId}' @@ -411,7 +411,7 @@ def get_variable(self, function_id, variable_id): }, api_params) def update_variable(self, function_id, variable_id, key, value = None): - """Update Variable""" + """Update variable""" api_path = '/functions/{functionId}/variables/{variableId}' @@ -436,7 +436,7 @@ def update_variable(self, function_id, variable_id, key, value = None): }, api_params) def delete_variable(self, function_id, variable_id): - """Delete Variable""" + """Delete variable""" api_path = '/functions/{functionId}/variables/{variableId}' diff --git a/appwrite/services/graphql.py b/appwrite/services/graphql.py index 7f9d87d..58a6e99 100644 --- a/appwrite/services/graphql.py +++ b/appwrite/services/graphql.py @@ -7,7 +7,7 @@ def __init__(self, client): super(Graphql, self).__init__(client) def query(self, query): - """GraphQL Endpoint""" + """GraphQL endpoint""" api_path = '/graphql' @@ -24,7 +24,7 @@ def query(self, query): }, api_params) def mutation(self, query): - """GraphQL Endpoint""" + """GraphQL endpoint""" api_path = '/graphql/mutation' diff --git a/appwrite/services/health.py b/appwrite/services/health.py index 15bd0db..b4f1bf1 100644 --- a/appwrite/services/health.py +++ b/appwrite/services/health.py @@ -18,7 +18,7 @@ def get(self): }, api_params) def get_antivirus(self): - """Get Antivirus""" + """Get antivirus""" api_path = '/health/anti-virus' @@ -29,7 +29,7 @@ def get_antivirus(self): }, api_params) def get_cache(self): - """Get Cache""" + """Get cache""" api_path = '/health/cache' @@ -51,7 +51,7 @@ def get_db(self): }, api_params) def get_pub_sub(self): - """Get PubSub""" + """Get pubsub""" api_path = '/health/pubsub' @@ -62,7 +62,7 @@ def get_pub_sub(self): }, api_params) def get_queue(self): - """Get Queue""" + """Get queue""" api_path = '/health/queue' @@ -72,52 +72,139 @@ def get_queue(self): 'content-type': 'application/json', }, api_params) - def get_queue_certificates(self): - """Get Certificates Queue""" + def get_queue_builds(self, threshold = None): + """Get builds queue""" + + + api_path = '/health/queue/builds' + api_params = {} + + api_params['threshold'] = threshold + + return self.client.call('get', api_path, { + 'content-type': 'application/json', + }, api_params) + + def get_queue_certificates(self, threshold = None): + """Get certificates queue""" api_path = '/health/queue/certificates' api_params = {} + api_params['threshold'] = threshold + return self.client.call('get', api_path, { 'content-type': 'application/json', }, api_params) - def get_queue_functions(self): - """Get Functions Queue""" + def get_queue_databases(self, name = None, threshold = None): + """Get databases queue""" + + + api_path = '/health/queue/databases' + api_params = {} + + api_params['name'] = name + api_params['threshold'] = threshold + + return self.client.call('get', api_path, { + 'content-type': 'application/json', + }, api_params) + + def get_queue_deletes(self, threshold = None): + """Get deletes queue""" + + + api_path = '/health/queue/deletes' + api_params = {} + + api_params['threshold'] = threshold + + return self.client.call('get', api_path, { + 'content-type': 'application/json', + }, api_params) + + def get_queue_functions(self, threshold = None): + """Get functions queue""" api_path = '/health/queue/functions' api_params = {} + api_params['threshold'] = threshold + return self.client.call('get', api_path, { 'content-type': 'application/json', }, api_params) - def get_queue_logs(self): - """Get Logs Queue""" + def get_queue_logs(self, threshold = None): + """Get logs queue""" api_path = '/health/queue/logs' api_params = {} + api_params['threshold'] = threshold + return self.client.call('get', api_path, { 'content-type': 'application/json', }, api_params) - def get_queue_webhooks(self): - """Get Webhooks Queue""" + def get_queue_mails(self, threshold = None): + """Get mails queue""" + + + api_path = '/health/queue/mails' + api_params = {} + + api_params['threshold'] = threshold + + return self.client.call('get', api_path, { + 'content-type': 'application/json', + }, api_params) + + def get_queue_messaging(self, threshold = None): + """Get messaging queue""" + + + api_path = '/health/queue/messaging' + api_params = {} + + api_params['threshold'] = threshold + + return self.client.call('get', api_path, { + 'content-type': 'application/json', + }, api_params) + + def get_queue_migrations(self, threshold = None): + """Get migrations queue""" + + + api_path = '/health/queue/migrations' + api_params = {} + + api_params['threshold'] = threshold + + return self.client.call('get', api_path, { + 'content-type': 'application/json', + }, api_params) + + def get_queue_webhooks(self, threshold = None): + """Get webhooks queue""" api_path = '/health/queue/webhooks' api_params = {} + api_params['threshold'] = threshold + return self.client.call('get', api_path, { 'content-type': 'application/json', }, api_params) def get_storage_local(self): - """Get Local Storage""" + """Get local storage""" api_path = '/health/storage/local' @@ -128,7 +215,7 @@ def get_storage_local(self): }, api_params) def get_time(self): - """Get Time""" + """Get time""" api_path = '/health/time' diff --git a/appwrite/services/locale.py b/appwrite/services/locale.py index 8216ac4..2ba17ac 100644 --- a/appwrite/services/locale.py +++ b/appwrite/services/locale.py @@ -7,7 +7,7 @@ def __init__(self, client): super(Locale, self).__init__(client) def get(self): - """Get User Locale""" + """Get user locale""" api_path = '/locale' @@ -29,7 +29,7 @@ def list_codes(self): }, api_params) def list_continents(self): - """List Continents""" + """List continents""" api_path = '/locale/continents' @@ -40,7 +40,7 @@ def list_continents(self): }, api_params) def list_countries(self): - """List Countries""" + """List countries""" api_path = '/locale/countries' @@ -51,7 +51,7 @@ def list_countries(self): }, api_params) def list_countries_eu(self): - """List EU Countries""" + """List EU countries""" api_path = '/locale/countries/eu' @@ -62,7 +62,7 @@ def list_countries_eu(self): }, api_params) def list_countries_phones(self): - """List Countries Phone Codes""" + """List countries phone codes""" api_path = '/locale/countries/phones' @@ -73,7 +73,7 @@ def list_countries_phones(self): }, api_params) def list_currencies(self): - """List Currencies""" + """List currencies""" api_path = '/locale/currencies' @@ -84,7 +84,7 @@ def list_currencies(self): }, api_params) def list_languages(self): - """List Languages""" + """List languages""" api_path = '/locale/languages' diff --git a/appwrite/services/storage.py b/appwrite/services/storage.py index 48f1220..d86e412 100644 --- a/appwrite/services/storage.py +++ b/appwrite/services/storage.py @@ -49,7 +49,7 @@ def create_bucket(self, bucket_id, name, permissions = None, file_security = Non }, api_params) def get_bucket(self, bucket_id): - """Get Bucket""" + """Get bucket""" api_path = '/storage/buckets/{bucketId}' @@ -65,7 +65,7 @@ def get_bucket(self, bucket_id): }, api_params) def update_bucket(self, bucket_id, name, permissions = None, file_security = None, enabled = None, maximum_file_size = None, allowed_file_extensions = None, compression = None, encryption = None, antivirus = None): - """Update Bucket""" + """Update bucket""" api_path = '/storage/buckets/{bucketId}' @@ -93,7 +93,7 @@ def update_bucket(self, bucket_id, name, permissions = None, file_security = Non }, api_params) def delete_bucket(self, bucket_id): - """Delete Bucket""" + """Delete bucket""" api_path = '/storage/buckets/{bucketId}' @@ -109,7 +109,7 @@ def delete_bucket(self, bucket_id): }, api_params) def list_files(self, bucket_id, queries = None, search = None): - """List Files""" + """List files""" api_path = '/storage/buckets/{bucketId}/files' @@ -127,7 +127,7 @@ def list_files(self, bucket_id, queries = None, search = None): }, api_params) def create_file(self, bucket_id, file_id, file, permissions = None, on_progress = None): - """Create File""" + """Create file""" api_path = '/storage/buckets/{bucketId}/files' @@ -158,7 +158,7 @@ def create_file(self, bucket_id, file_id, file, permissions = None, on_progress }, api_params, param_name, on_progress, upload_id) def get_file(self, bucket_id, file_id): - """Get File""" + """Get file""" api_path = '/storage/buckets/{bucketId}/files/{fileId}' @@ -178,7 +178,7 @@ def get_file(self, bucket_id, file_id): }, api_params) def update_file(self, bucket_id, file_id, name = None, permissions = None): - """Update File""" + """Update file""" api_path = '/storage/buckets/{bucketId}/files/{fileId}' @@ -220,7 +220,7 @@ def delete_file(self, bucket_id, file_id): }, api_params) def get_file_download(self, bucket_id, file_id): - """Get File for Download""" + """Get file for download""" api_path = '/storage/buckets/{bucketId}/files/{fileId}/download' @@ -240,7 +240,7 @@ def get_file_download(self, bucket_id, file_id): }, api_params) def get_file_preview(self, bucket_id, file_id, width = None, height = None, gravity = None, quality = None, border_width = None, border_color = None, border_radius = None, opacity = None, rotation = None, background = None, output = None): - """Get File Preview""" + """Get file preview""" api_path = '/storage/buckets/{bucketId}/files/{fileId}/preview' @@ -271,7 +271,7 @@ def get_file_preview(self, bucket_id, file_id, width = None, height = None, grav }, api_params) def get_file_view(self, bucket_id, file_id): - """Get File for View""" + """Get file for view""" api_path = '/storage/buckets/{bucketId}/files/{fileId}/view' diff --git a/appwrite/services/teams.py b/appwrite/services/teams.py index c7b4272..2c387ed 100644 --- a/appwrite/services/teams.py +++ b/appwrite/services/teams.py @@ -7,7 +7,7 @@ def __init__(self, client): super(Teams, self).__init__(client) def list(self, queries = None, search = None): - """List Teams""" + """List teams""" api_path = '/teams' @@ -21,7 +21,7 @@ def list(self, queries = None, search = None): }, api_params) def create(self, team_id, name, roles = None): - """Create Team""" + """Create team""" api_path = '/teams' @@ -42,7 +42,7 @@ def create(self, team_id, name, roles = None): }, api_params) def get(self, team_id): - """Get Team""" + """Get team""" api_path = '/teams/{teamId}' @@ -58,7 +58,7 @@ def get(self, team_id): }, api_params) def update_name(self, team_id, name): - """Update Name""" + """Update name""" api_path = '/teams/{teamId}' @@ -78,7 +78,7 @@ def update_name(self, team_id, name): }, api_params) def delete(self, team_id): - """Delete Team""" + """Delete team""" api_path = '/teams/{teamId}' @@ -94,7 +94,7 @@ def delete(self, team_id): }, api_params) def list_memberships(self, team_id, queries = None, search = None): - """List Team Memberships""" + """List team memberships""" api_path = '/teams/{teamId}/memberships' @@ -112,7 +112,7 @@ def list_memberships(self, team_id, queries = None, search = None): }, api_params) def create_membership(self, team_id, roles, email = None, user_id = None, phone = None, url = None, name = None): - """Create Team Membership""" + """Create team membership""" api_path = '/teams/{teamId}/memberships' @@ -137,7 +137,7 @@ def create_membership(self, team_id, roles, email = None, user_id = None, phone }, api_params) def get_membership(self, team_id, membership_id): - """Get Team Membership""" + """Get team membership""" api_path = '/teams/{teamId}/memberships/{membershipId}' @@ -157,7 +157,7 @@ def get_membership(self, team_id, membership_id): }, api_params) def update_membership(self, team_id, membership_id, roles): - """Update Membership""" + """Update membership""" api_path = '/teams/{teamId}/memberships/{membershipId}' @@ -181,7 +181,7 @@ def update_membership(self, team_id, membership_id, roles): }, api_params) def delete_membership(self, team_id, membership_id): - """Delete Team Membership""" + """Delete team membership""" api_path = '/teams/{teamId}/memberships/{membershipId}' @@ -201,7 +201,7 @@ def delete_membership(self, team_id, membership_id): }, api_params) def update_membership_status(self, team_id, membership_id, user_id, secret): - """Update Team Membership Status""" + """Update team membership status""" api_path = '/teams/{teamId}/memberships/{membershipId}/status' @@ -229,7 +229,7 @@ def update_membership_status(self, team_id, membership_id, user_id, secret): }, api_params) def get_prefs(self, team_id): - """Get Team Preferences""" + """Get team preferences""" api_path = '/teams/{teamId}/prefs' @@ -245,7 +245,7 @@ def get_prefs(self, team_id): }, api_params) def update_prefs(self, team_id, prefs): - """Update Preferences""" + """Update preferences""" api_path = '/teams/{teamId}/prefs' diff --git a/appwrite/services/users.py b/appwrite/services/users.py index 0962d7c..2bcec8d 100644 --- a/appwrite/services/users.py +++ b/appwrite/services/users.py @@ -7,7 +7,7 @@ def __init__(self, client): super(Users, self).__init__(client) def list(self, queries = None, search = None): - """List Users""" + """List users""" api_path = '/users' @@ -21,7 +21,7 @@ def list(self, queries = None, search = None): }, api_params) def create(self, user_id, email = None, phone = None, password = None, name = None): - """Create User""" + """Create user""" api_path = '/users' @@ -41,7 +41,7 @@ def create(self, user_id, email = None, phone = None, password = None, name = No }, api_params) def create_argon2_user(self, user_id, email, password, name = None): - """Create User with Argon2 Password""" + """Create user with Argon2 password""" api_path = '/users/argon2' @@ -66,7 +66,7 @@ def create_argon2_user(self, user_id, email, password, name = None): }, api_params) def create_bcrypt_user(self, user_id, email, password, name = None): - """Create User with Bcrypt Password""" + """Create user with bcrypt password""" api_path = '/users/bcrypt' @@ -121,7 +121,7 @@ def delete_identity(self, identity_id): }, api_params) def create_md5_user(self, user_id, email, password, name = None): - """Create User with MD5 Password""" + """Create user with MD5 password""" api_path = '/users/md5' @@ -146,7 +146,7 @@ def create_md5_user(self, user_id, email, password, name = None): }, api_params) def create_ph_pass_user(self, user_id, email, password, name = None): - """Create User with PHPass Password""" + """Create user with PHPass password""" api_path = '/users/phpass' @@ -171,7 +171,7 @@ def create_ph_pass_user(self, user_id, email, password, name = None): }, api_params) def create_scrypt_user(self, user_id, email, password, password_salt, password_cpu, password_memory, password_parallel, password_length, name = None): - """Create User with Scrypt Password""" + """Create user with Scrypt password""" api_path = '/users/scrypt' @@ -216,7 +216,7 @@ def create_scrypt_user(self, user_id, email, password, password_salt, password_c }, api_params) def create_scrypt_modified_user(self, user_id, email, password, password_salt, password_salt_separator, password_signer_key, name = None): - """Create User with Scrypt Modified Password""" + """Create user with Scrypt modified password""" api_path = '/users/scrypt-modified' @@ -253,7 +253,7 @@ def create_scrypt_modified_user(self, user_id, email, password, password_salt, p }, api_params) def create_sha_user(self, user_id, email, password, password_version = None, name = None): - """Create User with SHA Password""" + """Create user with SHA password""" api_path = '/users/sha' @@ -279,7 +279,7 @@ def create_sha_user(self, user_id, email, password, password_version = None, nam }, api_params) def get(self, user_id): - """Get User""" + """Get user""" api_path = '/users/{userId}' @@ -295,7 +295,7 @@ def get(self, user_id): }, api_params) def delete(self, user_id): - """Delete User""" + """Delete user""" api_path = '/users/{userId}' @@ -311,7 +311,7 @@ def delete(self, user_id): }, api_params) def update_email(self, user_id, email): - """Update Email""" + """Update email""" api_path = '/users/{userId}/email' @@ -331,7 +331,7 @@ def update_email(self, user_id, email): }, api_params) def update_labels(self, user_id, labels): - """Update User Labels""" + """Update user labels""" api_path = '/users/{userId}/labels' @@ -351,7 +351,7 @@ def update_labels(self, user_id, labels): }, api_params) def list_logs(self, user_id, queries = None): - """List User Logs""" + """List user logs""" api_path = '/users/{userId}/logs' @@ -368,7 +368,7 @@ def list_logs(self, user_id, queries = None): }, api_params) def list_memberships(self, user_id): - """List User Memberships""" + """List user memberships""" api_path = '/users/{userId}/memberships' @@ -384,7 +384,7 @@ def list_memberships(self, user_id): }, api_params) def update_name(self, user_id, name): - """Update Name""" + """Update name""" api_path = '/users/{userId}/name' @@ -404,7 +404,7 @@ def update_name(self, user_id, name): }, api_params) def update_password(self, user_id, password): - """Update Password""" + """Update password""" api_path = '/users/{userId}/password' @@ -424,7 +424,7 @@ def update_password(self, user_id, password): }, api_params) def update_phone(self, user_id, number): - """Update Phone""" + """Update phone""" api_path = '/users/{userId}/phone' @@ -444,7 +444,7 @@ def update_phone(self, user_id, number): }, api_params) def get_prefs(self, user_id): - """Get User Preferences""" + """Get user preferences""" api_path = '/users/{userId}/prefs' @@ -460,7 +460,7 @@ def get_prefs(self, user_id): }, api_params) def update_prefs(self, user_id, prefs): - """Update User Preferences""" + """Update user preferences""" api_path = '/users/{userId}/prefs' @@ -480,7 +480,7 @@ def update_prefs(self, user_id, prefs): }, api_params) def list_sessions(self, user_id): - """List User Sessions""" + """List user sessions""" api_path = '/users/{userId}/sessions' @@ -496,7 +496,7 @@ def list_sessions(self, user_id): }, api_params) def delete_sessions(self, user_id): - """Delete User Sessions""" + """Delete user sessions""" api_path = '/users/{userId}/sessions' @@ -512,7 +512,7 @@ def delete_sessions(self, user_id): }, api_params) def delete_session(self, user_id, session_id): - """Delete User Session""" + """Delete user session""" api_path = '/users/{userId}/sessions/{sessionId}' @@ -532,7 +532,7 @@ def delete_session(self, user_id, session_id): }, api_params) def update_status(self, user_id, status): - """Update User Status""" + """Update user status""" api_path = '/users/{userId}/status' @@ -552,7 +552,7 @@ def update_status(self, user_id, status): }, api_params) def update_email_verification(self, user_id, email_verification): - """Update Email Verification""" + """Update email verification""" api_path = '/users/{userId}/verification' @@ -572,7 +572,7 @@ def update_email_verification(self, user_id, email_verification): }, api_params) def update_phone_verification(self, user_id, phone_verification): - """Update Phone Verification""" + """Update phone verification""" api_path = '/users/{userId}/verification/phone' diff --git a/docs/examples/health/get-queue-builds.md b/docs/examples/health/get-queue-builds.md new file mode 100644 index 0000000..3170559 --- /dev/null +++ b/docs/examples/health/get-queue-builds.md @@ -0,0 +1,14 @@ +from appwrite.client import Client +from appwrite.services.health import Health + +client = Client() + +(client + .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint + .set_project('5df5acd0d48c2') # Your project ID + .set_key('919c2d18fb5d4...a2ae413da83346ad2') # Your secret API key +) + +health = Health(client) + +result = health.get_queue_builds() diff --git a/docs/examples/health/get-queue-databases.md b/docs/examples/health/get-queue-databases.md new file mode 100644 index 0000000..4faff96 --- /dev/null +++ b/docs/examples/health/get-queue-databases.md @@ -0,0 +1,14 @@ +from appwrite.client import Client +from appwrite.services.health import Health + +client = Client() + +(client + .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint + .set_project('5df5acd0d48c2') # Your project ID + .set_key('919c2d18fb5d4...a2ae413da83346ad2') # Your secret API key +) + +health = Health(client) + +result = health.get_queue_databases() diff --git a/docs/examples/health/get-queue-deletes.md b/docs/examples/health/get-queue-deletes.md new file mode 100644 index 0000000..c84b9be --- /dev/null +++ b/docs/examples/health/get-queue-deletes.md @@ -0,0 +1,14 @@ +from appwrite.client import Client +from appwrite.services.health import Health + +client = Client() + +(client + .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint + .set_project('5df5acd0d48c2') # Your project ID + .set_key('919c2d18fb5d4...a2ae413da83346ad2') # Your secret API key +) + +health = Health(client) + +result = health.get_queue_deletes() diff --git a/docs/examples/health/get-queue-mails.md b/docs/examples/health/get-queue-mails.md new file mode 100644 index 0000000..cc2c3bc --- /dev/null +++ b/docs/examples/health/get-queue-mails.md @@ -0,0 +1,14 @@ +from appwrite.client import Client +from appwrite.services.health import Health + +client = Client() + +(client + .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint + .set_project('5df5acd0d48c2') # Your project ID + .set_key('919c2d18fb5d4...a2ae413da83346ad2') # Your secret API key +) + +health = Health(client) + +result = health.get_queue_mails() diff --git a/docs/examples/health/get-queue-messaging.md b/docs/examples/health/get-queue-messaging.md new file mode 100644 index 0000000..95200f3 --- /dev/null +++ b/docs/examples/health/get-queue-messaging.md @@ -0,0 +1,14 @@ +from appwrite.client import Client +from appwrite.services.health import Health + +client = Client() + +(client + .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint + .set_project('5df5acd0d48c2') # Your project ID + .set_key('919c2d18fb5d4...a2ae413da83346ad2') # Your secret API key +) + +health = Health(client) + +result = health.get_queue_messaging() diff --git a/docs/examples/health/get-queue-migrations.md b/docs/examples/health/get-queue-migrations.md new file mode 100644 index 0000000..1c91663 --- /dev/null +++ b/docs/examples/health/get-queue-migrations.md @@ -0,0 +1,14 @@ +from appwrite.client import Client +from appwrite.services.health import Health + +client = Client() + +(client + .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint + .set_project('5df5acd0d48c2') # Your project ID + .set_key('919c2d18fb5d4...a2ae413da83346ad2') # Your secret API key +) + +health = Health(client) + +result = health.get_queue_migrations() diff --git a/setup.py b/setup.py index 851e7e4..49f3672 100644 --- a/setup.py +++ b/setup.py @@ -8,7 +8,7 @@ setuptools.setup( name = 'appwrite', packages = ['appwrite', 'appwrite/services'], - version = '4.0.0', + version = '4.1.0', license='BSD-3-Clause', description = 'Appwrite is an open-source self-hosted backend server that abstract and simplify complex and repetitive development tasks behind a very simple REST API', long_description = long_description, @@ -18,7 +18,7 @@ maintainer = 'Appwrite Team', maintainer_email = 'team@appwrite.io', url = 'https://appwrite.io/support', - download_url='https://github.com/appwrite/sdk-for-python/archive/4.0.0.tar.gz', + download_url='https://github.com/appwrite/sdk-for-python/archive/4.1.0.tar.gz', # keywords = ['SOME', 'MEANINGFULL', 'KEYWORDS'], install_requires=[ 'requests',