diff --git a/LICENSE b/LICENSE index 47cfdfb..5479bb8 100644 --- a/LICENSE +++ b/LICENSE @@ -1,4 +1,4 @@ -Copyright (c) 2023 Appwrite (https://appwrite.io) and individual contributors. +Copyright (c) 2024 Appwrite (https://appwrite.io) and individual contributors. All rights reserved. Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: diff --git a/README.md b/README.md index 9dd9d0c..27b8662 100644 --- a/README.md +++ b/README.md @@ -1,16 +1,16 @@ # 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.12-blue.svg?style=flat-square) +![Version](https://img.shields.io/badge/api%20version-1.5.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.4.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.5.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 abstract and simplify 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](https://appwrite.io/images/github.png) +![Appwrite](https://github.com/appwrite/appwrite/raw/main/public/images/github.png) ## Installation @@ -46,7 +46,7 @@ Once your SDK object is set, create any of the Appwrite service objects and choo ```python users = Users(client) -result = users.create('[USER_ID]', 'email@example.com', 'password') +result = users.create(ID.unique(), email = "email@example.com", phone = "+123456789", password = "password", name = "Walter O'Brien") ``` ### Full Example @@ -66,7 +66,7 @@ client = Client() users = Users(client) -result = users.create(ID.unique(), 'email@example.com', 'password') +result = users.create(ID.unique(), email = "email@example.com", phone = "+123456789", password = "password", name = "Walter O'Brien") ``` ### Error Handling @@ -75,7 +75,7 @@ The Appwrite Python SDK raises `AppwriteException` object with `message`, `code` ```python users = Users(client) try: - result = users.create(ID.unique(), 'email@example.com', 'password') + result = users.create(ID.unique(), email = "email@example.com", phone = "+123456789", password = "password", name = "Walter O'Brien") except AppwriteException as e: print(e.message) ``` diff --git a/appwrite/client.py b/appwrite/client.py index d5dd8c7..68e6c7b 100644 --- a/appwrite/client.py +++ b/appwrite/client.py @@ -1,22 +1,24 @@ import io -import requests +import json import os +import requests from .input_file import InputFile from .exception import AppwriteException +from .encoders.value_class_encoder import ValueClassEncoder class Client: def __init__(self): self._chunk_size = 5*1024*1024 self._self_signed = False - self._endpoint = 'https://HOSTNAME/v1' + self._endpoint = 'https://cloud.appwrite.io/v1' self._global_headers = { 'content-type': '', - 'user-agent' : 'AppwritePythonSDK/4.1.0 (${os.uname().sysname}; ${os.uname().version}; ${os.uname().machine})', + 'user-agent' : 'AppwritePythonSDK/5.0.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.1.0', - 'X-Appwrite-Response-Format' : '1.4.0', + 'x-sdk-version': '5.0.0', + 'X-Appwrite-Response-Format' : '1.5.0', } def set_self_signed(self, status=True): @@ -53,7 +55,19 @@ def set_locale(self, value): self._global_headers['x-appwrite-locale'] = value return self - def call(self, method, path='', headers=None, params=None): + def set_session(self, value): + """The user session to authenticate with""" + + self._global_headers['x-appwrite-session'] = value + return self + + def set_forwarded_user_agent(self, value): + """The user agent string of the client that made the request""" + + self._global_headers['x-forwarded-user-agent'] = value + return self + + def call(self, method, path='', headers=None, params=None, response_type='json'): if headers is None: headers = {} @@ -63,7 +77,6 @@ def call(self, method, path='', headers=None, params=None): params = {k: v for k, v in params.items() if v is not None} # Remove None values from params dictionary data = {} - json = {} files = {} stringify = False @@ -74,8 +87,7 @@ def call(self, method, path='', headers=None, params=None): params = {} if headers['content-type'].startswith('application/json'): - json = data - data = {} + data = json.dumps(data, cls=ValueClassEncoder) if headers['content-type'].startswith('multipart/form-data'): del headers['content-type'] @@ -84,23 +96,28 @@ def call(self, method, path='', headers=None, params=None): if isinstance(data[key], InputFile): files[key] = (data[key].filename, data[key].data) del data[key] + data = self.flatten(data, stringify=stringify) + response = None try: response = requests.request( # call method dynamically https://stackoverflow.com/a/4246075/2299554 method=method, url=self._endpoint + path, params=self.flatten(params, stringify=stringify), - data=self.flatten(data), - json=json, + data=data, files=files, headers=headers, verify=(not self._self_signed), + allow_redirects=False if response_type == 'location' else True ) response.raise_for_status() content_type = response.headers['Content-Type'] + if response_type == 'location': + return response.headers.get('Location') + if content_type.startswith('application/json'): return response.json() diff --git a/appwrite/encoders/__init__.py b/appwrite/encoders/__init__.py new file mode 100644 index 0000000..0519ecb --- /dev/null +++ b/appwrite/encoders/__init__.py @@ -0,0 +1 @@ + \ No newline at end of file diff --git a/appwrite/encoders/value_class_encoder.py b/appwrite/encoders/value_class_encoder.py new file mode 100644 index 0000000..f343add --- /dev/null +++ b/appwrite/encoders/value_class_encoder.py @@ -0,0 +1,77 @@ +import json +from ..enums.authenticator_type import AuthenticatorType +from ..enums.authentication_factor import AuthenticationFactor +from ..enums.o_auth_provider import OAuthProvider +from ..enums.browser import Browser +from ..enums.credit_card import CreditCard +from ..enums.flag import Flag +from ..enums.relationship_type import RelationshipType +from ..enums.relation_mutate import RelationMutate +from ..enums.index_type import IndexType +from ..enums.runtime import Runtime +from ..enums.execution_method import ExecutionMethod +from ..enums.name import Name +from ..enums.smtp_encryption import SmtpEncryption +from ..enums.compression import Compression +from ..enums.image_gravity import ImageGravity +from ..enums.image_format import ImageFormat +from ..enums.password_hash import PasswordHash +from ..enums.messaging_provider_type import MessagingProviderType + +class ValueClassEncoder(json.JSONEncoder): + def default(self, o): + if isinstance(o, AuthenticatorType): + return o.value + + if isinstance(o, AuthenticationFactor): + return o.value + + if isinstance(o, OAuthProvider): + return o.value + + if isinstance(o, Browser): + return o.value + + if isinstance(o, CreditCard): + return o.value + + if isinstance(o, Flag): + return o.value + + if isinstance(o, RelationshipType): + return o.value + + if isinstance(o, RelationMutate): + return o.value + + if isinstance(o, IndexType): + return o.value + + if isinstance(o, Runtime): + return o.value + + if isinstance(o, ExecutionMethod): + return o.value + + if isinstance(o, Name): + return o.value + + if isinstance(o, SmtpEncryption): + return o.value + + if isinstance(o, Compression): + return o.value + + if isinstance(o, ImageGravity): + return o.value + + if isinstance(o, ImageFormat): + return o.value + + if isinstance(o, PasswordHash): + return o.value + + if isinstance(o, MessagingProviderType): + return o.value + + return super().default(o) \ No newline at end of file diff --git a/appwrite/enums/__init__.py b/appwrite/enums/__init__.py new file mode 100644 index 0000000..0519ecb --- /dev/null +++ b/appwrite/enums/__init__.py @@ -0,0 +1 @@ + \ No newline at end of file diff --git a/appwrite/enums/authentication_factor.py b/appwrite/enums/authentication_factor.py new file mode 100644 index 0000000..a5b8cf2 --- /dev/null +++ b/appwrite/enums/authentication_factor.py @@ -0,0 +1,7 @@ +from enum import Enum + +class AuthenticationFactor(Enum): + EMAIL = "email" + PHONE = "phone" + TOTP = "totp" + RECOVERYCODE = "recoverycode" diff --git a/appwrite/enums/authenticator_type.py b/appwrite/enums/authenticator_type.py new file mode 100644 index 0000000..ee9f94a --- /dev/null +++ b/appwrite/enums/authenticator_type.py @@ -0,0 +1,4 @@ +from enum import Enum + +class AuthenticatorType(Enum): + TOTP = "totp" diff --git a/appwrite/enums/browser.py b/appwrite/enums/browser.py new file mode 100644 index 0000000..02974ec --- /dev/null +++ b/appwrite/enums/browser.py @@ -0,0 +1,17 @@ +from enum import Enum + +class Browser(Enum): + AVANT_BROWSER = "aa" + ANDROID_WEBVIEW_BETA = "an" + GOOGLE_CHROME = "ch" + GOOGLE_CHROME_IOS = "ci" + GOOGLE_CHROME_MOBILE = "cm" + CHROMIUM = "cr" + MOZILLA_FIREFOX = "ff" + SAFARI = "sf" + MOBILE_SAFARI = "mf" + MICROSOFT_EDGE = "ps" + MICROSOFT_EDGE_IOS = "oi" + OPERA_MINI = "om" + OPERA = "op" + OPERA_NEXT = "on" diff --git a/appwrite/enums/compression.py b/appwrite/enums/compression.py new file mode 100644 index 0000000..6d2d21a --- /dev/null +++ b/appwrite/enums/compression.py @@ -0,0 +1,6 @@ +from enum import Enum + +class Compression(Enum): + NONE = "none" + GZIP = "gzip" + ZSTD = "zstd" diff --git a/appwrite/enums/credit_card.py b/appwrite/enums/credit_card.py new file mode 100644 index 0000000..127e077 --- /dev/null +++ b/appwrite/enums/credit_card.py @@ -0,0 +1,19 @@ +from enum import Enum + +class CreditCard(Enum): + AMERICAN_EXPRESS = "amex" + ARGENCARD = "argencard" + CABAL = "cabal" + CONSOSUD = "censosud" + DINERS_CLUB = "diners" + DISCOVER = "discover" + ELO = "elo" + HIPERCARD = "hipercard" + JCB = "jcb" + MASTERCARD = "mastercard" + NARANJA = "naranja" + TARJETA_SHOPPING = "targeta-shopping" + UNION_CHINA_PAY = "union-china-pay" + VISA = "visa" + MIR = "mir" + MAESTRO = "maestro" diff --git a/appwrite/enums/execution_method.py b/appwrite/enums/execution_method.py new file mode 100644 index 0000000..23df3b9 --- /dev/null +++ b/appwrite/enums/execution_method.py @@ -0,0 +1,9 @@ +from enum import Enum + +class ExecutionMethod(Enum): + GET = "GET" + POST = "POST" + PUT = "PUT" + PATCH = "PATCH" + DELETE = "DELETE" + OPTIONS = "OPTIONS" diff --git a/appwrite/enums/flag.py b/appwrite/enums/flag.py new file mode 100644 index 0000000..6b550d7 --- /dev/null +++ b/appwrite/enums/flag.py @@ -0,0 +1,197 @@ +from enum import Enum + +class Flag(Enum): + AFGHANISTAN = "af" + ANGOLA = "ao" + ALBANIA = "al" + ANDORRA = "ad" + UNITED_ARAB_EMIRATES = "ae" + ARGENTINA = "ar" + ARMENIA = "am" + ANTIGUA_AND_BARBUDA = "ag" + AUSTRALIA = "au" + AUSTRIA = "at" + AZERBAIJAN = "az" + BURUNDI = "bi" + BELGIUM = "be" + BENIN = "bj" + BURKINA_FASO = "bf" + BANGLADESH = "bd" + BULGARIA = "bg" + BAHRAIN = "bh" + BAHAMAS = "bs" + BOSNIA_AND_HERZEGOVINA = "ba" + BELARUS = "by" + BELIZE = "bz" + BOLIVIA = "bo" + BRAZIL = "br" + BARBADOS = "bb" + BRUNEI_DARUSSALAM = "bn" + BHUTAN = "bt" + BOTSWANA = "bw" + CENTRAL_AFRICAN_REPUBLIC = "cf" + CANADA = "ca" + SWITZERLAND = "ch" + CHILE = "cl" + CHINA = "cn" + COTE_DIVOIRE = "ci" + CAMEROON = "cm" + DEMOCRATIC_REPUBLIC_OF_THE_CONGO = "cd" + REPUBLIC_OF_THE_CONGO = "cg" + COLOMBIA = "co" + COMOROS = "km" + CAPE_VERDE = "cv" + COSTA_RICA = "cr" + CUBA = "cu" + CYPRUS = "cy" + CZECH_REPUBLIC = "cz" + GERMANY = "de" + DJIBOUTI = "dj" + DOMINICA = "dm" + DENMARK = "dk" + DOMINICAN_REPUBLIC = "do" + ALGERIA = "dz" + ECUADOR = "ec" + EGYPT = "eg" + ERITREA = "er" + SPAIN = "es" + ESTONIA = "ee" + ETHIOPIA = "et" + FINLAND = "fi" + FIJI = "fj" + FRANCE = "fr" + MICRONESIA_FEDERATED_STATES_OF = "fm" + GABON = "ga" + UNITED_KINGDOM = "gb" + GEORGIA = "ge" + GHANA = "gh" + GUINEA = "gn" + GAMBIA = "gm" + GUINEA_BISSAU = "gw" + EQUATORIAL_GUINEA = "gq" + GREECE = "gr" + GRENADA = "gd" + GUATEMALA = "gt" + GUYANA = "gy" + HONDURAS = "hn" + CROATIA = "hr" + HAITI = "ht" + HUNGARY = "hu" + INDONESIA = "id" + INDIA = "in" + IRELAND = "ie" + IRAN_ISLAMIC_REPUBLIC_OF = "ir" + IRAQ = "iq" + ICELAND = "is" + ISRAEL = "il" + ITALY = "it" + JAMAICA = "jm" + JORDAN = "jo" + JAPAN = "jp" + KAZAKHSTAN = "kz" + KENYA = "ke" + KYRGYZSTAN = "kg" + CAMBODIA = "kh" + KIRIBATI = "ki" + SAINT_KITTS_AND_NEVIS = "kn" + SOUTH_KOREA = "kr" + KUWAIT = "kw" + LAO_PEOPLES_DEMOCRATIC_REPUBLIC = "la" + LEBANON = "lb" + LIBERIA = "lr" + LIBYA = "ly" + SAINT_LUCIA = "lc" + LIECHTENSTEIN = "li" + SRI_LANKA = "lk" + LESOTHO = "ls" + LITHUANIA = "lt" + LUXEMBOURG = "lu" + LATVIA = "lv" + MOROCCO = "ma" + MONACO = "mc" + MOLDOVA = "md" + MADAGASCAR = "mg" + MALDIVES = "mv" + MEXICO = "mx" + MARSHALL_ISLANDS = "mh" + NORTH_MACEDONIA = "mk" + MALI = "ml" + MALTA = "mt" + MYANMAR = "mm" + MONTENEGRO = "me" + MONGOLIA = "mn" + MOZAMBIQUE = "mz" + MAURITANIA = "mr" + MAURITIUS = "mu" + MALAWI = "mw" + MALAYSIA = "my" + NAMIBIA = "na" + NIGER = "ne" + NIGERIA = "ng" + NICARAGUA = "ni" + NETHERLANDS = "nl" + NORWAY = "no" + NEPAL = "np" + NAURU = "nr" + NEW_ZEALAND = "nz" + OMAN = "om" + PAKISTAN = "pk" + PANAMA = "pa" + PERU = "pe" + PHILIPPINES = "ph" + PALAU = "pw" + PAPUA_NEW_GUINEA = "pg" + POLAND = "pl" + NORTH_KOREA = "kp" + PORTUGAL = "pt" + PARAGUAY = "py" + QATAR = "qa" + ROMANIA = "ro" + RUSSIA = "ru" + RWANDA = "rw" + SAUDI_ARABIA = "sa" + SUDAN = "sd" + SENEGAL = "sn" + SINGAPORE = "sg" + SOLOMON_ISLANDS = "sb" + SIERRA_LEONE = "sl" + EL_SALVADOR = "sv" + SAN_MARINO = "sm" + SOMALIA = "so" + SERBIA = "rs" + SOUTH_SUDAN = "ss" + SAO_TOME_AND_PRINCIPE = "st" + SURINAME = "sr" + SLOVAKIA = "sk" + SLOVENIA = "si" + SWEDEN = "se" + ESWATINI = "sz" + SEYCHELLES = "sc" + SYRIA = "sy" + CHAD = "td" + TOGO = "tg" + THAILAND = "th" + TAJIKISTAN = "tj" + TURKMENISTAN = "tm" + TIMOR_LESTE = "tl" + TONGA = "to" + TRINIDAD_AND_TOBAGO = "tt" + TUNISIA = "tn" + TURKEY = "tr" + TUVALU = "tv" + TANZANIA = "tz" + UGANDA = "ug" + UKRAINE = "ua" + URUGUAY = "uy" + UNITED_STATES = "us" + UZBEKISTAN = "uz" + VATICAN_CITY = "va" + SAINT_VINCENT_AND_THE_GRENADINES = "vc" + VENEZUELA = "ve" + VIETNAM = "vn" + VANUATU = "vu" + SAMOA = "ws" + YEMEN = "ye" + SOUTH_AFRICA = "za" + ZAMBIA = "zm" + ZIMBABWE = "zw" diff --git a/appwrite/enums/image_format.py b/appwrite/enums/image_format.py new file mode 100644 index 0000000..7cdd8f3 --- /dev/null +++ b/appwrite/enums/image_format.py @@ -0,0 +1,8 @@ +from enum import Enum + +class ImageFormat(Enum): + JPG = "jpg" + JPEG = "jpeg" + GIF = "gif" + PNG = "png" + WEBP = "webp" diff --git a/appwrite/enums/image_gravity.py b/appwrite/enums/image_gravity.py new file mode 100644 index 0000000..c73678d --- /dev/null +++ b/appwrite/enums/image_gravity.py @@ -0,0 +1,12 @@ +from enum import Enum + +class ImageGravity(Enum): + CENTER = "center" + TOP_LEFT = "top-left" + TOP = "top" + TOP_RIGHT = "top-right" + LEFT = "left" + RIGHT = "right" + BOTTOM_LEFT = "bottom-left" + BOTTOM = "bottom" + BOTTOM_RIGHT = "bottom-right" diff --git a/appwrite/enums/index_type.py b/appwrite/enums/index_type.py new file mode 100644 index 0000000..f4c9e4c --- /dev/null +++ b/appwrite/enums/index_type.py @@ -0,0 +1,6 @@ +from enum import Enum + +class IndexType(Enum): + KEY = "key" + FULLTEXT = "fulltext" + UNIQUE = "unique" diff --git a/appwrite/enums/messaging_provider_type.py b/appwrite/enums/messaging_provider_type.py new file mode 100644 index 0000000..e6e7c07 --- /dev/null +++ b/appwrite/enums/messaging_provider_type.py @@ -0,0 +1,6 @@ +from enum import Enum + +class MessagingProviderType(Enum): + EMAIL = "email" + SMS = "sms" + PUSH = "push" diff --git a/appwrite/enums/name.py b/appwrite/enums/name.py new file mode 100644 index 0000000..1e8bdb5 --- /dev/null +++ b/appwrite/enums/name.py @@ -0,0 +1,16 @@ +from enum import Enum + +class Name(Enum): + V1_DATABASE = "v1-database" + V1_DELETES = "v1-deletes" + V1_AUDITS = "v1-audits" + V1_MAILS = "v1-mails" + V1_FUNCTIONS = "v1-functions" + V1_USAGE = "v1-usage" + V1_USAGE_DUMP = "v1-usage-dump" + WEBHOOKSV1 = "webhooksv1" + V1_CERTIFICATES = "v1-certificates" + V1_BUILDS = "v1-builds" + V1_MESSAGING = "v1-messaging" + V1_MIGRATIONS = "v1-migrations" + HAMSTERV1 = "hamsterv1" diff --git a/appwrite/enums/o_auth_provider.py b/appwrite/enums/o_auth_provider.py new file mode 100644 index 0000000..3d46c8e --- /dev/null +++ b/appwrite/enums/o_auth_provider.py @@ -0,0 +1,42 @@ +from enum import Enum + +class OAuthProvider(Enum): + AMAZON = "amazon" + APPLE = "apple" + AUTH0 = "auth0" + AUTHENTIK = "authentik" + AUTODESK = "autodesk" + BITBUCKET = "bitbucket" + BITLY = "bitly" + BOX = "box" + DAILYMOTION = "dailymotion" + DISCORD = "discord" + DISQUS = "disqus" + DROPBOX = "dropbox" + ETSY = "etsy" + FACEBOOK = "facebook" + GITHUB = "github" + GITLAB = "gitlab" + GOOGLE = "google" + LINKEDIN = "linkedin" + MICROSOFT = "microsoft" + NOTION = "notion" + OIDC = "oidc" + OKTA = "okta" + PAYPAL = "paypal" + PAYPALSANDBOX = "paypalSandbox" + PODIO = "podio" + SALESFORCE = "salesforce" + SLACK = "slack" + SPOTIFY = "spotify" + STRIPE = "stripe" + TRADESHIFT = "tradeshift" + TRADESHIFTBOX = "tradeshiftBox" + TWITCH = "twitch" + WORDPRESS = "wordpress" + YAHOO = "yahoo" + YAMMER = "yammer" + YANDEX = "yandex" + ZOHO = "zoho" + ZOOM = "zoom" + MOCK = "mock" diff --git a/appwrite/enums/password_hash.py b/appwrite/enums/password_hash.py new file mode 100644 index 0000000..8dcf212 --- /dev/null +++ b/appwrite/enums/password_hash.py @@ -0,0 +1,14 @@ +from enum import Enum + +class PasswordHash(Enum): + SHA1 = "sha1" + SHA224 = "sha224" + SHA256 = "sha256" + SHA384 = "sha384" + SHA512_224 = "sha512/224" + SHA512_256 = "sha512/256" + SHA512 = "sha512" + SHA3_224 = "sha3-224" + SHA3_256 = "sha3-256" + SHA3_384 = "sha3-384" + SHA3_512 = "sha3-512" diff --git a/appwrite/enums/relation_mutate.py b/appwrite/enums/relation_mutate.py new file mode 100644 index 0000000..ae52aa7 --- /dev/null +++ b/appwrite/enums/relation_mutate.py @@ -0,0 +1,6 @@ +from enum import Enum + +class RelationMutate(Enum): + CASCADE = "cascade" + RESTRICT = "restrict" + SETNULL = "setNull" diff --git a/appwrite/enums/relationship_type.py b/appwrite/enums/relationship_type.py new file mode 100644 index 0000000..7866ca6 --- /dev/null +++ b/appwrite/enums/relationship_type.py @@ -0,0 +1,7 @@ +from enum import Enum + +class RelationshipType(Enum): + ONETOONE = "oneToOne" + MANYTOONE = "manyToOne" + MANYTOMANY = "manyToMany" + ONETOMANY = "oneToMany" diff --git a/appwrite/enums/runtime.py b/appwrite/enums/runtime.py new file mode 100644 index 0000000..fb83e93 --- /dev/null +++ b/appwrite/enums/runtime.py @@ -0,0 +1,47 @@ +from enum import Enum + +class Runtime(Enum): + NODE_14_5 = "node-14.5" + NODE_16_0 = "node-16.0" + NODE_18_0 = "node-18.0" + NODE_19_0 = "node-19.0" + NODE_20_0 = "node-20.0" + NODE_21_0 = "node-21.0" + PHP_8_0 = "php-8.0" + PHP_8_1 = "php-8.1" + PHP_8_2 = "php-8.2" + PHP_8_3 = "php-8.3" + RUBY_3_0 = "ruby-3.0" + RUBY_3_1 = "ruby-3.1" + RUBY_3_2 = "ruby-3.2" + RUBY_3_3 = "ruby-3.3" + PYTHON_3_8 = "python-3.8" + PYTHON_3_9 = "python-3.9" + PYTHON_3_10 = "python-3.10" + PYTHON_3_11 = "python-3.11" + PYTHON_3_12 = "python-3.12" + DENO_1_40 = "deno-1.40" + DART_2_15 = "dart-2.15" + DART_2_16 = "dart-2.16" + DART_2_17 = "dart-2.17" + DART_2_18 = "dart-2.18" + DART_3_0 = "dart-3.0" + DART_3_1 = "dart-3.1" + DART_3_3 = "dart-3.3" + DOTNET_3_1 = "dotnet-3.1" + DOTNET_6_0 = "dotnet-6.0" + DOTNET_7_0 = "dotnet-7.0" + JAVA_8_0 = "java-8.0" + JAVA_11_0 = "java-11.0" + JAVA_17_0 = "java-17.0" + JAVA_18_0 = "java-18.0" + JAVA_21_0 = "java-21.0" + SWIFT_5_5 = "swift-5.5" + SWIFT_5_8 = "swift-5.8" + SWIFT_5_9 = "swift-5.9" + KOTLIN_1_6 = "kotlin-1.6" + KOTLIN_1_8 = "kotlin-1.8" + KOTLIN_1_9 = "kotlin-1.9" + CPP_17 = "cpp-17" + CPP_20 = "cpp-20" + BUN_1_0 = "bun-1.0" diff --git a/appwrite/enums/smtp_encryption.py b/appwrite/enums/smtp_encryption.py new file mode 100644 index 0000000..213330e --- /dev/null +++ b/appwrite/enums/smtp_encryption.py @@ -0,0 +1,6 @@ +from enum import Enum + +class SmtpEncryption(Enum): + NONE = "none" + SSL = "ssl" + TLS = "tls" diff --git a/appwrite/input_file.py b/appwrite/input_file.py index 9f11b0c..33d5a77 100644 --- a/appwrite/input_file.py +++ b/appwrite/input_file.py @@ -12,7 +12,7 @@ def from_path(cls, path): return instance @classmethod - def from_bytes(cls, bytes, filename = None, mime_type = None): + def from_bytes(cls, bytes, filename, mime_type = None): instance = cls() instance.data = bytes instance.filename = filename diff --git a/appwrite/query.py b/appwrite/query.py index d970bd8..f25e33d 100644 --- a/appwrite/query.py +++ b/appwrite/query.py @@ -1,92 +1,108 @@ -class Query: +import json + + +# Inherit from dict to allow for easy serialization +class Query(): + def __init__(self, method, attribute=None, values=None): + self.method = method + + if attribute is not None: + self.attribute = attribute + + if values is not None: + self.values = values if isinstance(values, list) else [values] + + def __str__(self): + return json.dumps( + self.__dict__, + separators=(",", ":"), + default=lambda obj: obj.__dict__ + ) + @staticmethod def equal(attribute, value): - return Query.add_query(attribute, "equal", value) + return str(Query("equal", attribute, value)) @staticmethod def not_equal(attribute, value): - return Query.add_query(attribute, "notEqual", value) - + return str(Query("notEqual", attribute, value)) + @staticmethod def less_than(attribute, value): - return Query.add_query(attribute, "lessThan", value) - + return str(Query("lessThan", attribute, value)) + @staticmethod def less_than_equal(attribute, value): - return Query.add_query(attribute, "lessThanEqual", value) - + return str(Query("lessThanEqual", attribute, value)) + @staticmethod def greater_than(attribute, value): - return Query.add_query(attribute, "greaterThan", value) - + return str(Query("greaterThan", attribute, value)) + @staticmethod def greater_than_equal(attribute, value): - return Query.add_query(attribute, "greaterThanEqual", value) + return str(Query("greaterThanEqual", attribute, value)) @staticmethod def is_null(attribute): - return f'isNull("{attribute}")' + return str(Query("isNull", attribute, None)) @staticmethod def is_not_null(attribute): - return f'isNotNull("{attribute}")' + return str(Query("isNotNull", attribute, None)) @staticmethod def between(attribute, start, end): - return f'between("{attribute}", {Query.parseValues(start)}, {Query.parseValues(end)})' + return str(Query("between", attribute, [start, end])) @staticmethod def starts_with(attribute, value): - return Query.add_query(attribute, "startsWith", value) + return str(Query("startsWith", attribute, value)) @staticmethod def ends_with(attribute, value): - return Query.add_query(attribute, "endsWith", value) + return str(Query("endsWith", attribute, value)) @staticmethod def select(attributes): - return f'select([{",".join(map(Query.parseValues, attributes))}])' + return str(Query("select", None, attributes)) @staticmethod def search(attribute, value): - return Query.add_query(attribute, "search", value) + return str(Query("search", attribute, value)) @staticmethod def order_asc(attribute): - return f'orderAsc("{attribute}")' + return str(Query("orderAsc", attribute, None)) @staticmethod def order_desc(attribute): - return f'orderDesc("{attribute}")' + return str(Query("orderDesc", attribute, None)) @staticmethod def cursor_before(id): - return f'cursorBefore("{id}")' + return str(Query("cursorBefore", None, id)) @staticmethod def cursor_after(id): - return f'cursorAfter("{id}")' + return str(Query("cursorAfter", None, id)) @staticmethod def limit(limit): - return f'limit({limit})' + return str(Query("limit", None, limit)) @staticmethod def offset(offset): - return f'offset({offset})' + return str(Query("offset", None, offset)) + + @staticmethod + def contains(attribute, value): + return str(Query("contains", attribute, value)) @staticmethod - def add_query(attribute, method, value): - if type(value) == list: - return f'{method}("{attribute}", [{",".join(map(Query.parseValues, value))}])' - else: - return f'{method}("{attribute}", [{Query.parseValues(value)}])' + def or_queries(queries): + return str(Query("or", None, [json.loads(query) for query in queries])) @staticmethod - def parseValues(value): - if type(value) == str: - return f'"{value}"' - elif type(value) == bool: - return str(value).lower() - else: - return str(value) \ No newline at end of file + def and_queries(queries): + return str(Query("and", None, [json.loads(query) for query in queries])) diff --git a/appwrite/services/account.py b/appwrite/services/account.py index 278d890..5f30898 100644 --- a/appwrite/services/account.py +++ b/appwrite/services/account.py @@ -17,6 +17,31 @@ def get(self): 'content-type': 'application/json', }, api_params) + def create(self, user_id, email, password, name = None): + """Create account""" + + + api_path = '/account' + api_params = {} + if user_id is None: + raise AppwriteException('Missing required parameter: "user_id"') + + if email is None: + raise AppwriteException('Missing required parameter: "email"') + + if password is None: + raise AppwriteException('Missing required parameter: "password"') + + + api_params['userId'] = user_id + api_params['email'] = email + api_params['password'] = password + api_params['name'] = name + + return self.client.call('post', api_path, { + 'content-type': 'application/json', + }, api_params) + def update_email(self, email, password): """Update email""" @@ -51,7 +76,7 @@ def list_identities(self, queries = None): }, api_params) def delete_identity(self, identity_id): - """Delete Identity""" + """Delete identity""" api_path = '/account/identities/{identityId}' @@ -66,6 +91,17 @@ def delete_identity(self, identity_id): 'content-type': 'application/json', }, api_params) + def create_jwt(self): + """Create JWT""" + + + api_path = '/account/jwt' + api_params = {} + + return self.client.call('post', api_path, { + 'content-type': 'application/json', + }, api_params) + def list_logs(self, queries = None): """List logs""" @@ -79,6 +115,158 @@ def list_logs(self, queries = None): 'content-type': 'application/json', }, api_params) + def update_mfa(self, mfa): + """Update MFA""" + + + api_path = '/account/mfa' + api_params = {} + if mfa is None: + raise AppwriteException('Missing required parameter: "mfa"') + + + api_params['mfa'] = mfa + + return self.client.call('patch', api_path, { + 'content-type': 'application/json', + }, api_params) + + def create_mfa_authenticator(self, type): + """Add Authenticator""" + + + api_path = '/account/mfa/authenticators/{type}' + api_params = {} + if type is None: + raise AppwriteException('Missing required parameter: "type"') + + api_path = api_path.replace('{type}', type) + + + return self.client.call('post', api_path, { + 'content-type': 'application/json', + }, api_params) + + def update_mfa_authenticator(self, type, otp): + """Verify Authenticator""" + + + api_path = '/account/mfa/authenticators/{type}' + api_params = {} + if type is None: + raise AppwriteException('Missing required parameter: "type"') + + if otp is None: + raise AppwriteException('Missing required parameter: "otp"') + + api_path = api_path.replace('{type}', type) + + api_params['otp'] = otp + + return self.client.call('put', api_path, { + 'content-type': 'application/json', + }, api_params) + + def delete_mfa_authenticator(self, type, otp): + """Delete Authenticator""" + + + api_path = '/account/mfa/authenticators/{type}' + api_params = {} + if type is None: + raise AppwriteException('Missing required parameter: "type"') + + if otp is None: + raise AppwriteException('Missing required parameter: "otp"') + + api_path = api_path.replace('{type}', type) + + api_params['otp'] = otp + + return self.client.call('delete', api_path, { + 'content-type': 'application/json', + }, api_params) + + def create_mfa_challenge(self, factor): + """Create 2FA Challenge""" + + + api_path = '/account/mfa/challenge' + api_params = {} + if factor is None: + raise AppwriteException('Missing required parameter: "factor"') + + + api_params['factor'] = factor + + return self.client.call('post', api_path, { + 'content-type': 'application/json', + }, api_params) + + def update_mfa_challenge(self, challenge_id, otp): + """Create MFA Challenge (confirmation)""" + + + api_path = '/account/mfa/challenge' + api_params = {} + if challenge_id is None: + raise AppwriteException('Missing required parameter: "challenge_id"') + + if otp is None: + raise AppwriteException('Missing required parameter: "otp"') + + + api_params['challengeId'] = challenge_id + api_params['otp'] = otp + + return self.client.call('put', api_path, { + 'content-type': 'application/json', + }, api_params) + + def list_mfa_factors(self): + """List Factors""" + + + api_path = '/account/mfa/factors' + api_params = {} + + return self.client.call('get', api_path, { + 'content-type': 'application/json', + }, api_params) + + def get_mfa_recovery_codes(self): + """Get MFA Recovery Codes""" + + + api_path = '/account/mfa/recovery-codes' + api_params = {} + + return self.client.call('get', api_path, { + 'content-type': 'application/json', + }, api_params) + + def create_mfa_recovery_codes(self): + """Create MFA Recovery Codes""" + + + api_path = '/account/mfa/recovery-codes' + api_params = {} + + return self.client.call('post', api_path, { + 'content-type': 'application/json', + }, api_params) + + def update_mfa_recovery_codes(self): + """Regenerate MFA Recovery Codes""" + + + api_path = '/account/mfa/recovery-codes' + api_params = {} + + return self.client.call('patch', api_path, { + 'content-type': 'application/json', + }, api_params) + def update_name(self, name): """Update name""" @@ -179,7 +367,7 @@ def create_recovery(self, email, url): 'content-type': 'application/json', }, api_params) - def update_recovery(self, user_id, secret, password, password_again): + def update_recovery(self, user_id, secret, password): """Create password recovery (confirmation)""" @@ -194,14 +382,10 @@ def update_recovery(self, user_id, secret, password, password_again): if password is None: raise AppwriteException('Missing required parameter: "password"') - if password_again is None: - raise AppwriteException('Missing required parameter: "password_again"') - api_params['userId'] = user_id api_params['secret'] = secret api_params['password'] = password - api_params['passwordAgain'] = password_again return self.client.call('put', api_path, { 'content-type': 'application/json', @@ -229,6 +413,97 @@ def delete_sessions(self): 'content-type': 'application/json', }, api_params) + def create_anonymous_session(self): + """Create anonymous session""" + + + api_path = '/account/sessions/anonymous' + api_params = {} + + return self.client.call('post', api_path, { + 'content-type': 'application/json', + }, api_params) + + def create_email_password_session(self, email, password): + """Create email password session""" + + + api_path = '/account/sessions/email' + api_params = {} + if email is None: + raise AppwriteException('Missing required parameter: "email"') + + if password is None: + raise AppwriteException('Missing required parameter: "password"') + + + api_params['email'] = email + api_params['password'] = password + + return self.client.call('post', api_path, { + 'content-type': 'application/json', + }, api_params) + + def update_magic_url_session(self, user_id, secret): + """Update magic URL session""" + + + api_path = '/account/sessions/magic-url' + api_params = {} + if user_id is None: + raise AppwriteException('Missing required parameter: "user_id"') + + if secret is None: + raise AppwriteException('Missing required parameter: "secret"') + + + api_params['userId'] = user_id + api_params['secret'] = secret + + return self.client.call('put', api_path, { + 'content-type': 'application/json', + }, api_params) + + def update_phone_session(self, user_id, secret): + """Update phone session""" + + + api_path = '/account/sessions/phone' + api_params = {} + if user_id is None: + raise AppwriteException('Missing required parameter: "user_id"') + + if secret is None: + raise AppwriteException('Missing required parameter: "secret"') + + + api_params['userId'] = user_id + api_params['secret'] = secret + + return self.client.call('put', api_path, { + 'content-type': 'application/json', + }, api_params) + + def create_session(self, user_id, secret): + """Create session""" + + + api_path = '/account/sessions/token' + api_params = {} + if user_id is None: + raise AppwriteException('Missing required parameter: "user_id"') + + if secret is None: + raise AppwriteException('Missing required parameter: "secret"') + + + api_params['userId'] = user_id + api_params['secret'] = secret + + return self.client.call('post', api_path, { + 'content-type': 'application/json', + }, api_params) + def get_session(self, session_id): """Get session""" @@ -246,7 +521,7 @@ def get_session(self, session_id): }, api_params) def update_session(self, session_id): - """Update OAuth session (refresh tokens)""" + """Update session""" api_path = '/account/sessions/{sessionId}' @@ -288,6 +563,88 @@ def update_status(self): 'content-type': 'application/json', }, api_params) + def create_email_token(self, user_id, email, phrase = None): + """Create email token (OTP)""" + + + api_path = '/account/tokens/email' + api_params = {} + if user_id is None: + raise AppwriteException('Missing required parameter: "user_id"') + + if email is None: + raise AppwriteException('Missing required parameter: "email"') + + + api_params['userId'] = user_id + api_params['email'] = email + api_params['phrase'] = phrase + + return self.client.call('post', api_path, { + 'content-type': 'application/json', + }, api_params) + + def create_magic_url_token(self, user_id, email, url = None, phrase = None): + """Create magic URL token""" + + + api_path = '/account/tokens/magic-url' + api_params = {} + if user_id is None: + raise AppwriteException('Missing required parameter: "user_id"') + + if email is None: + raise AppwriteException('Missing required parameter: "email"') + + + api_params['userId'] = user_id + api_params['email'] = email + api_params['url'] = url + api_params['phrase'] = phrase + + return self.client.call('post', api_path, { + 'content-type': 'application/json', + }, api_params) + + def create_o_auth2_token(self, provider, success = None, failure = None, scopes = None): + """Create OAuth2 token""" + + + api_path = '/account/tokens/oauth2/{provider}' + api_params = {} + if provider is None: + raise AppwriteException('Missing required parameter: "provider"') + + api_path = api_path.replace('{provider}', provider) + + api_params['success'] = success + api_params['failure'] = failure + api_params['scopes'] = scopes + + return self.client.call('get', api_path, { + 'content-type': 'application/json', + }, api_params, response_type='location') + + def create_phone_token(self, user_id, phone): + """Create phone token""" + + + api_path = '/account/tokens/phone' + api_params = {} + if user_id is None: + raise AppwriteException('Missing required parameter: "user_id"') + + if phone is None: + raise AppwriteException('Missing required parameter: "phone"') + + + api_params['userId'] = user_id + api_params['phone'] = phone + + return self.client.call('post', api_path, { + 'content-type': 'application/json', + }, api_params) + def create_verification(self, url): """Create email verification""" diff --git a/appwrite/services/health.py b/appwrite/services/health.py index b4f1bf1..ef4b3cd 100644 --- a/appwrite/services/health.py +++ b/appwrite/services/health.py @@ -39,6 +39,19 @@ def get_cache(self): 'content-type': 'application/json', }, api_params) + def get_certificate(self, domain = None): + """Get the SSL certificate for a domain""" + + + api_path = '/health/certificate' + api_params = {} + + api_params['domain'] = domain + + return self.client.call('get', api_path, { + 'content-type': 'application/json', + }, api_params) + def get_db(self): """Get DB""" @@ -125,6 +138,23 @@ def get_queue_deletes(self, threshold = None): 'content-type': 'application/json', }, api_params) + def get_failed_jobs(self, name, threshold = None): + """Get number of failed queue jobs""" + + + api_path = '/health/queue/failed/{name}' + api_params = {} + if name is None: + raise AppwriteException('Missing required parameter: "name"') + + api_path = api_path.replace('{name}', name) + + 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""" @@ -190,6 +220,32 @@ def get_queue_migrations(self, threshold = None): 'content-type': 'application/json', }, api_params) + def get_queue_usage(self, threshold = None): + """Get usage queue""" + + + api_path = '/health/queue/usage' + api_params = {} + + api_params['threshold'] = threshold + + return self.client.call('get', api_path, { + 'content-type': 'application/json', + }, api_params) + + def get_queue_usage_dump(self, threshold = None): + """Get usage dump queue""" + + + api_path = '/health/queue/usage-dump' + 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""" @@ -203,6 +259,17 @@ def get_queue_webhooks(self, threshold = None): 'content-type': 'application/json', }, api_params) + def get_storage(self): + """Get storage""" + + + api_path = '/health/storage' + api_params = {} + + return self.client.call('get', api_path, { + 'content-type': 'application/json', + }, api_params) + def get_storage_local(self): """Get local storage""" diff --git a/appwrite/services/messaging.py b/appwrite/services/messaging.py new file mode 100644 index 0000000..e284a5c --- /dev/null +++ b/appwrite/services/messaging.py @@ -0,0 +1,1006 @@ +from ..service import Service +from ..exception import AppwriteException + +class Messaging(Service): + + def __init__(self, client): + super(Messaging, self).__init__(client) + + def list_messages(self, queries = None, search = None): + """List messages""" + + + api_path = '/messaging/messages' + api_params = {} + + api_params['queries'] = queries + api_params['search'] = search + + return self.client.call('get', api_path, { + 'content-type': 'application/json', + }, api_params) + + def create_email(self, message_id, subject, content, topics = None, users = None, targets = None, cc = None, bcc = None, attachments = None, draft = None, html = None, scheduled_at = None): + """Create email""" + + + api_path = '/messaging/messages/email' + api_params = {} + if message_id is None: + raise AppwriteException('Missing required parameter: "message_id"') + + if subject is None: + raise AppwriteException('Missing required parameter: "subject"') + + if content is None: + raise AppwriteException('Missing required parameter: "content"') + + + api_params['messageId'] = message_id + api_params['subject'] = subject + api_params['content'] = content + api_params['topics'] = topics + api_params['users'] = users + api_params['targets'] = targets + api_params['cc'] = cc + api_params['bcc'] = bcc + api_params['attachments'] = attachments + api_params['draft'] = draft + api_params['html'] = html + api_params['scheduledAt'] = scheduled_at + + return self.client.call('post', api_path, { + 'content-type': 'application/json', + }, api_params) + + def update_email(self, message_id, topics = None, users = None, targets = None, subject = None, content = None, draft = None, html = None, cc = None, bcc = None, scheduled_at = None): + """Update email""" + + + api_path = '/messaging/messages/email/{messageId}' + api_params = {} + if message_id is None: + raise AppwriteException('Missing required parameter: "message_id"') + + api_path = api_path.replace('{messageId}', message_id) + + api_params['topics'] = topics + api_params['users'] = users + api_params['targets'] = targets + api_params['subject'] = subject + api_params['content'] = content + api_params['draft'] = draft + api_params['html'] = html + api_params['cc'] = cc + api_params['bcc'] = bcc + api_params['scheduledAt'] = scheduled_at + + return self.client.call('patch', api_path, { + 'content-type': 'application/json', + }, api_params) + + def create_push(self, message_id, title, body, topics = None, users = None, targets = None, data = None, action = None, image = None, icon = None, sound = None, color = None, tag = None, badge = None, draft = None, scheduled_at = None): + """Create push notification""" + + + api_path = '/messaging/messages/push' + api_params = {} + if message_id is None: + raise AppwriteException('Missing required parameter: "message_id"') + + if title is None: + raise AppwriteException('Missing required parameter: "title"') + + if body is None: + raise AppwriteException('Missing required parameter: "body"') + + + api_params['messageId'] = message_id + api_params['title'] = title + api_params['body'] = body + api_params['topics'] = topics + api_params['users'] = users + api_params['targets'] = targets + api_params['data'] = data + api_params['action'] = action + api_params['image'] = image + api_params['icon'] = icon + api_params['sound'] = sound + api_params['color'] = color + api_params['tag'] = tag + api_params['badge'] = badge + api_params['draft'] = draft + api_params['scheduledAt'] = scheduled_at + + return self.client.call('post', api_path, { + 'content-type': 'application/json', + }, api_params) + + def update_push(self, message_id, topics = None, users = None, targets = None, title = None, body = None, data = None, action = None, image = None, icon = None, sound = None, color = None, tag = None, badge = None, draft = None, scheduled_at = None): + """Update push notification""" + + + api_path = '/messaging/messages/push/{messageId}' + api_params = {} + if message_id is None: + raise AppwriteException('Missing required parameter: "message_id"') + + api_path = api_path.replace('{messageId}', message_id) + + api_params['topics'] = topics + api_params['users'] = users + api_params['targets'] = targets + api_params['title'] = title + api_params['body'] = body + api_params['data'] = data + api_params['action'] = action + api_params['image'] = image + api_params['icon'] = icon + api_params['sound'] = sound + api_params['color'] = color + api_params['tag'] = tag + api_params['badge'] = badge + api_params['draft'] = draft + api_params['scheduledAt'] = scheduled_at + + return self.client.call('patch', api_path, { + 'content-type': 'application/json', + }, api_params) + + def create_sms(self, message_id, content, topics = None, users = None, targets = None, draft = None, scheduled_at = None): + """Create SMS""" + + + api_path = '/messaging/messages/sms' + api_params = {} + if message_id is None: + raise AppwriteException('Missing required parameter: "message_id"') + + if content is None: + raise AppwriteException('Missing required parameter: "content"') + + + api_params['messageId'] = message_id + api_params['content'] = content + api_params['topics'] = topics + api_params['users'] = users + api_params['targets'] = targets + api_params['draft'] = draft + api_params['scheduledAt'] = scheduled_at + + return self.client.call('post', api_path, { + 'content-type': 'application/json', + }, api_params) + + def update_sms(self, message_id, topics = None, users = None, targets = None, content = None, draft = None, scheduled_at = None): + """Update SMS""" + + + api_path = '/messaging/messages/sms/{messageId}' + api_params = {} + if message_id is None: + raise AppwriteException('Missing required parameter: "message_id"') + + api_path = api_path.replace('{messageId}', message_id) + + api_params['topics'] = topics + api_params['users'] = users + api_params['targets'] = targets + api_params['content'] = content + api_params['draft'] = draft + api_params['scheduledAt'] = scheduled_at + + return self.client.call('patch', api_path, { + 'content-type': 'application/json', + }, api_params) + + def get_message(self, message_id): + """Get message""" + + + api_path = '/messaging/messages/{messageId}' + api_params = {} + if message_id is None: + raise AppwriteException('Missing required parameter: "message_id"') + + api_path = api_path.replace('{messageId}', message_id) + + + return self.client.call('get', api_path, { + 'content-type': 'application/json', + }, api_params) + + def delete(self, message_id): + """Delete message""" + + + api_path = '/messaging/messages/{messageId}' + api_params = {} + if message_id is None: + raise AppwriteException('Missing required parameter: "message_id"') + + api_path = api_path.replace('{messageId}', message_id) + + + return self.client.call('delete', api_path, { + 'content-type': 'application/json', + }, api_params) + + def list_message_logs(self, message_id, queries = None): + """List message logs""" + + + api_path = '/messaging/messages/{messageId}/logs' + api_params = {} + if message_id is None: + raise AppwriteException('Missing required parameter: "message_id"') + + api_path = api_path.replace('{messageId}', message_id) + + api_params['queries'] = queries + + return self.client.call('get', api_path, { + 'content-type': 'application/json', + }, api_params) + + def list_targets(self, message_id, queries = None): + """List message targets""" + + + api_path = '/messaging/messages/{messageId}/targets' + api_params = {} + if message_id is None: + raise AppwriteException('Missing required parameter: "message_id"') + + api_path = api_path.replace('{messageId}', message_id) + + api_params['queries'] = queries + + return self.client.call('get', api_path, { + 'content-type': 'application/json', + }, api_params) + + def list_providers(self, queries = None, search = None): + """List providers""" + + + api_path = '/messaging/providers' + api_params = {} + + api_params['queries'] = queries + api_params['search'] = search + + return self.client.call('get', api_path, { + 'content-type': 'application/json', + }, api_params) + + def create_apns_provider(self, provider_id, name, auth_key = None, auth_key_id = None, team_id = None, bundle_id = None, sandbox = None, enabled = None): + """Create APNS provider""" + + + api_path = '/messaging/providers/apns' + api_params = {} + if provider_id is None: + raise AppwriteException('Missing required parameter: "provider_id"') + + if name is None: + raise AppwriteException('Missing required parameter: "name"') + + + api_params['providerId'] = provider_id + api_params['name'] = name + api_params['authKey'] = auth_key + api_params['authKeyId'] = auth_key_id + api_params['teamId'] = team_id + api_params['bundleId'] = bundle_id + api_params['sandbox'] = sandbox + api_params['enabled'] = enabled + + return self.client.call('post', api_path, { + 'content-type': 'application/json', + }, api_params) + + def update_apns_provider(self, provider_id, name = None, enabled = None, auth_key = None, auth_key_id = None, team_id = None, bundle_id = None, sandbox = None): + """Update APNS provider""" + + + api_path = '/messaging/providers/apns/{providerId}' + api_params = {} + if provider_id is None: + raise AppwriteException('Missing required parameter: "provider_id"') + + api_path = api_path.replace('{providerId}', provider_id) + + api_params['name'] = name + api_params['enabled'] = enabled + api_params['authKey'] = auth_key + api_params['authKeyId'] = auth_key_id + api_params['teamId'] = team_id + api_params['bundleId'] = bundle_id + api_params['sandbox'] = sandbox + + return self.client.call('patch', api_path, { + 'content-type': 'application/json', + }, api_params) + + def create_fcm_provider(self, provider_id, name, service_account_json = None, enabled = None): + """Create FCM provider""" + + + api_path = '/messaging/providers/fcm' + api_params = {} + if provider_id is None: + raise AppwriteException('Missing required parameter: "provider_id"') + + if name is None: + raise AppwriteException('Missing required parameter: "name"') + + + api_params['providerId'] = provider_id + api_params['name'] = name + api_params['serviceAccountJSON'] = service_account_json + api_params['enabled'] = enabled + + return self.client.call('post', api_path, { + 'content-type': 'application/json', + }, api_params) + + def update_fcm_provider(self, provider_id, name = None, enabled = None, service_account_json = None): + """Update FCM provider""" + + + api_path = '/messaging/providers/fcm/{providerId}' + api_params = {} + if provider_id is None: + raise AppwriteException('Missing required parameter: "provider_id"') + + api_path = api_path.replace('{providerId}', provider_id) + + api_params['name'] = name + api_params['enabled'] = enabled + api_params['serviceAccountJSON'] = service_account_json + + return self.client.call('patch', api_path, { + 'content-type': 'application/json', + }, api_params) + + def create_mailgun_provider(self, provider_id, name, api_key = None, domain = None, is_eu_region = None, from_name = None, from_email = None, reply_to_name = None, reply_to_email = None, enabled = None): + """Create Mailgun provider""" + + + api_path = '/messaging/providers/mailgun' + api_params = {} + if provider_id is None: + raise AppwriteException('Missing required parameter: "provider_id"') + + if name is None: + raise AppwriteException('Missing required parameter: "name"') + + + api_params['providerId'] = provider_id + api_params['name'] = name + api_params['apiKey'] = api_key + api_params['domain'] = domain + api_params['isEuRegion'] = is_eu_region + api_params['fromName'] = from_name + api_params['fromEmail'] = from_email + api_params['replyToName'] = reply_to_name + api_params['replyToEmail'] = reply_to_email + api_params['enabled'] = enabled + + return self.client.call('post', api_path, { + 'content-type': 'application/json', + }, api_params) + + def update_mailgun_provider(self, provider_id, name = None, api_key = None, domain = None, is_eu_region = None, enabled = None, from_name = None, from_email = None, reply_to_name = None, reply_to_email = None): + """Update Mailgun provider""" + + + api_path = '/messaging/providers/mailgun/{providerId}' + api_params = {} + if provider_id is None: + raise AppwriteException('Missing required parameter: "provider_id"') + + api_path = api_path.replace('{providerId}', provider_id) + + api_params['name'] = name + api_params['apiKey'] = api_key + api_params['domain'] = domain + api_params['isEuRegion'] = is_eu_region + api_params['enabled'] = enabled + api_params['fromName'] = from_name + api_params['fromEmail'] = from_email + api_params['replyToName'] = reply_to_name + api_params['replyToEmail'] = reply_to_email + + return self.client.call('patch', api_path, { + 'content-type': 'application/json', + }, api_params) + + def create_msg91_provider(self, provider_id, name, xfrom = None, sender_id = None, auth_key = None, enabled = None): + """Create Msg91 provider""" + + + api_path = '/messaging/providers/msg91' + api_params = {} + if provider_id is None: + raise AppwriteException('Missing required parameter: "provider_id"') + + if name is None: + raise AppwriteException('Missing required parameter: "name"') + + + api_params['providerId'] = provider_id + api_params['name'] = name + api_params['from'] = xfrom + api_params['senderId'] = sender_id + api_params['authKey'] = auth_key + api_params['enabled'] = enabled + + return self.client.call('post', api_path, { + 'content-type': 'application/json', + }, api_params) + + def update_msg91_provider(self, provider_id, name = None, enabled = None, sender_id = None, auth_key = None, xfrom = None): + """Update Msg91 provider""" + + + api_path = '/messaging/providers/msg91/{providerId}' + api_params = {} + if provider_id is None: + raise AppwriteException('Missing required parameter: "provider_id"') + + api_path = api_path.replace('{providerId}', provider_id) + + api_params['name'] = name + api_params['enabled'] = enabled + api_params['senderId'] = sender_id + api_params['authKey'] = auth_key + api_params['from'] = xfrom + + return self.client.call('patch', api_path, { + 'content-type': 'application/json', + }, api_params) + + def create_sendgrid_provider(self, provider_id, name, api_key = None, from_name = None, from_email = None, reply_to_name = None, reply_to_email = None, enabled = None): + """Create Sendgrid provider""" + + + api_path = '/messaging/providers/sendgrid' + api_params = {} + if provider_id is None: + raise AppwriteException('Missing required parameter: "provider_id"') + + if name is None: + raise AppwriteException('Missing required parameter: "name"') + + + api_params['providerId'] = provider_id + api_params['name'] = name + api_params['apiKey'] = api_key + api_params['fromName'] = from_name + api_params['fromEmail'] = from_email + api_params['replyToName'] = reply_to_name + api_params['replyToEmail'] = reply_to_email + api_params['enabled'] = enabled + + return self.client.call('post', api_path, { + 'content-type': 'application/json', + }, api_params) + + def update_sendgrid_provider(self, provider_id, name = None, enabled = None, api_key = None, from_name = None, from_email = None, reply_to_name = None, reply_to_email = None): + """Update Sendgrid provider""" + + + api_path = '/messaging/providers/sendgrid/{providerId}' + api_params = {} + if provider_id is None: + raise AppwriteException('Missing required parameter: "provider_id"') + + api_path = api_path.replace('{providerId}', provider_id) + + api_params['name'] = name + api_params['enabled'] = enabled + api_params['apiKey'] = api_key + api_params['fromName'] = from_name + api_params['fromEmail'] = from_email + api_params['replyToName'] = reply_to_name + api_params['replyToEmail'] = reply_to_email + + return self.client.call('patch', api_path, { + 'content-type': 'application/json', + }, api_params) + + def create_smtp_provider(self, provider_id, name, host, port = None, username = None, password = None, encryption = None, auto_tls = None, mailer = None, from_name = None, from_email = None, reply_to_name = None, reply_to_email = None, enabled = None): + """Create SMTP provider""" + + + api_path = '/messaging/providers/smtp' + api_params = {} + if provider_id is None: + raise AppwriteException('Missing required parameter: "provider_id"') + + if name is None: + raise AppwriteException('Missing required parameter: "name"') + + if host is None: + raise AppwriteException('Missing required parameter: "host"') + + + api_params['providerId'] = provider_id + api_params['name'] = name + api_params['host'] = host + api_params['port'] = port + api_params['username'] = username + api_params['password'] = password + api_params['encryption'] = encryption + api_params['autoTLS'] = auto_tls + api_params['mailer'] = mailer + api_params['fromName'] = from_name + api_params['fromEmail'] = from_email + api_params['replyToName'] = reply_to_name + api_params['replyToEmail'] = reply_to_email + api_params['enabled'] = enabled + + return self.client.call('post', api_path, { + 'content-type': 'application/json', + }, api_params) + + def update_smtp_provider(self, provider_id, name = None, host = None, port = None, username = None, password = None, encryption = None, auto_tls = None, mailer = None, from_name = None, from_email = None, reply_to_name = None, reply_to_email = None, enabled = None): + """Update SMTP provider""" + + + api_path = '/messaging/providers/smtp/{providerId}' + api_params = {} + if provider_id is None: + raise AppwriteException('Missing required parameter: "provider_id"') + + api_path = api_path.replace('{providerId}', provider_id) + + api_params['name'] = name + api_params['host'] = host + api_params['port'] = port + api_params['username'] = username + api_params['password'] = password + api_params['encryption'] = encryption + api_params['autoTLS'] = auto_tls + api_params['mailer'] = mailer + api_params['fromName'] = from_name + api_params['fromEmail'] = from_email + api_params['replyToName'] = reply_to_name + api_params['replyToEmail'] = reply_to_email + api_params['enabled'] = enabled + + return self.client.call('patch', api_path, { + 'content-type': 'application/json', + }, api_params) + + def create_telesign_provider(self, provider_id, name, xfrom = None, customer_id = None, api_key = None, enabled = None): + """Create Telesign provider""" + + + api_path = '/messaging/providers/telesign' + api_params = {} + if provider_id is None: + raise AppwriteException('Missing required parameter: "provider_id"') + + if name is None: + raise AppwriteException('Missing required parameter: "name"') + + + api_params['providerId'] = provider_id + api_params['name'] = name + api_params['from'] = xfrom + api_params['customerId'] = customer_id + api_params['apiKey'] = api_key + api_params['enabled'] = enabled + + return self.client.call('post', api_path, { + 'content-type': 'application/json', + }, api_params) + + def update_telesign_provider(self, provider_id, name = None, enabled = None, customer_id = None, api_key = None, xfrom = None): + """Update Telesign provider""" + + + api_path = '/messaging/providers/telesign/{providerId}' + api_params = {} + if provider_id is None: + raise AppwriteException('Missing required parameter: "provider_id"') + + api_path = api_path.replace('{providerId}', provider_id) + + api_params['name'] = name + api_params['enabled'] = enabled + api_params['customerId'] = customer_id + api_params['apiKey'] = api_key + api_params['from'] = xfrom + + return self.client.call('patch', api_path, { + 'content-type': 'application/json', + }, api_params) + + def create_textmagic_provider(self, provider_id, name, xfrom = None, username = None, api_key = None, enabled = None): + """Create Textmagic provider""" + + + api_path = '/messaging/providers/textmagic' + api_params = {} + if provider_id is None: + raise AppwriteException('Missing required parameter: "provider_id"') + + if name is None: + raise AppwriteException('Missing required parameter: "name"') + + + api_params['providerId'] = provider_id + api_params['name'] = name + api_params['from'] = xfrom + api_params['username'] = username + api_params['apiKey'] = api_key + api_params['enabled'] = enabled + + return self.client.call('post', api_path, { + 'content-type': 'application/json', + }, api_params) + + def update_textmagic_provider(self, provider_id, name = None, enabled = None, username = None, api_key = None, xfrom = None): + """Update Textmagic provider""" + + + api_path = '/messaging/providers/textmagic/{providerId}' + api_params = {} + if provider_id is None: + raise AppwriteException('Missing required parameter: "provider_id"') + + api_path = api_path.replace('{providerId}', provider_id) + + api_params['name'] = name + api_params['enabled'] = enabled + api_params['username'] = username + api_params['apiKey'] = api_key + api_params['from'] = xfrom + + return self.client.call('patch', api_path, { + 'content-type': 'application/json', + }, api_params) + + def create_twilio_provider(self, provider_id, name, xfrom = None, account_sid = None, auth_token = None, enabled = None): + """Create Twilio provider""" + + + api_path = '/messaging/providers/twilio' + api_params = {} + if provider_id is None: + raise AppwriteException('Missing required parameter: "provider_id"') + + if name is None: + raise AppwriteException('Missing required parameter: "name"') + + + api_params['providerId'] = provider_id + api_params['name'] = name + api_params['from'] = xfrom + api_params['accountSid'] = account_sid + api_params['authToken'] = auth_token + api_params['enabled'] = enabled + + return self.client.call('post', api_path, { + 'content-type': 'application/json', + }, api_params) + + def update_twilio_provider(self, provider_id, name = None, enabled = None, account_sid = None, auth_token = None, xfrom = None): + """Update Twilio provider""" + + + api_path = '/messaging/providers/twilio/{providerId}' + api_params = {} + if provider_id is None: + raise AppwriteException('Missing required parameter: "provider_id"') + + api_path = api_path.replace('{providerId}', provider_id) + + api_params['name'] = name + api_params['enabled'] = enabled + api_params['accountSid'] = account_sid + api_params['authToken'] = auth_token + api_params['from'] = xfrom + + return self.client.call('patch', api_path, { + 'content-type': 'application/json', + }, api_params) + + def create_vonage_provider(self, provider_id, name, xfrom = None, api_key = None, api_secret = None, enabled = None): + """Create Vonage provider""" + + + api_path = '/messaging/providers/vonage' + api_params = {} + if provider_id is None: + raise AppwriteException('Missing required parameter: "provider_id"') + + if name is None: + raise AppwriteException('Missing required parameter: "name"') + + + api_params['providerId'] = provider_id + api_params['name'] = name + api_params['from'] = xfrom + api_params['apiKey'] = api_key + api_params['apiSecret'] = api_secret + api_params['enabled'] = enabled + + return self.client.call('post', api_path, { + 'content-type': 'application/json', + }, api_params) + + def update_vonage_provider(self, provider_id, name = None, enabled = None, api_key = None, api_secret = None, xfrom = None): + """Update Vonage provider""" + + + api_path = '/messaging/providers/vonage/{providerId}' + api_params = {} + if provider_id is None: + raise AppwriteException('Missing required parameter: "provider_id"') + + api_path = api_path.replace('{providerId}', provider_id) + + api_params['name'] = name + api_params['enabled'] = enabled + api_params['apiKey'] = api_key + api_params['apiSecret'] = api_secret + api_params['from'] = xfrom + + return self.client.call('patch', api_path, { + 'content-type': 'application/json', + }, api_params) + + def get_provider(self, provider_id): + """Get provider""" + + + api_path = '/messaging/providers/{providerId}' + api_params = {} + if provider_id is None: + raise AppwriteException('Missing required parameter: "provider_id"') + + api_path = api_path.replace('{providerId}', provider_id) + + + return self.client.call('get', api_path, { + 'content-type': 'application/json', + }, api_params) + + def delete_provider(self, provider_id): + """Delete provider""" + + + api_path = '/messaging/providers/{providerId}' + api_params = {} + if provider_id is None: + raise AppwriteException('Missing required parameter: "provider_id"') + + api_path = api_path.replace('{providerId}', provider_id) + + + return self.client.call('delete', api_path, { + 'content-type': 'application/json', + }, api_params) + + def list_provider_logs(self, provider_id, queries = None): + """List provider logs""" + + + api_path = '/messaging/providers/{providerId}/logs' + api_params = {} + if provider_id is None: + raise AppwriteException('Missing required parameter: "provider_id"') + + api_path = api_path.replace('{providerId}', provider_id) + + api_params['queries'] = queries + + return self.client.call('get', api_path, { + 'content-type': 'application/json', + }, api_params) + + def list_subscriber_logs(self, subscriber_id, queries = None): + """List subscriber logs""" + + + api_path = '/messaging/subscribers/{subscriberId}/logs' + api_params = {} + if subscriber_id is None: + raise AppwriteException('Missing required parameter: "subscriber_id"') + + api_path = api_path.replace('{subscriberId}', subscriber_id) + + api_params['queries'] = queries + + return self.client.call('get', api_path, { + 'content-type': 'application/json', + }, api_params) + + def list_topics(self, queries = None, search = None): + """List topics""" + + + api_path = '/messaging/topics' + api_params = {} + + api_params['queries'] = queries + api_params['search'] = search + + return self.client.call('get', api_path, { + 'content-type': 'application/json', + }, api_params) + + def create_topic(self, topic_id, name, subscribe = None): + """Create topic""" + + + api_path = '/messaging/topics' + api_params = {} + if topic_id is None: + raise AppwriteException('Missing required parameter: "topic_id"') + + if name is None: + raise AppwriteException('Missing required parameter: "name"') + + + api_params['topicId'] = topic_id + api_params['name'] = name + api_params['subscribe'] = subscribe + + return self.client.call('post', api_path, { + 'content-type': 'application/json', + }, api_params) + + def get_topic(self, topic_id): + """Get topic""" + + + api_path = '/messaging/topics/{topicId}' + api_params = {} + if topic_id is None: + raise AppwriteException('Missing required parameter: "topic_id"') + + api_path = api_path.replace('{topicId}', topic_id) + + + return self.client.call('get', api_path, { + 'content-type': 'application/json', + }, api_params) + + def update_topic(self, topic_id, name = None, subscribe = None): + """Update topic""" + + + api_path = '/messaging/topics/{topicId}' + api_params = {} + if topic_id is None: + raise AppwriteException('Missing required parameter: "topic_id"') + + api_path = api_path.replace('{topicId}', topic_id) + + api_params['name'] = name + api_params['subscribe'] = subscribe + + return self.client.call('patch', api_path, { + 'content-type': 'application/json', + }, api_params) + + def delete_topic(self, topic_id): + """Delete topic""" + + + api_path = '/messaging/topics/{topicId}' + api_params = {} + if topic_id is None: + raise AppwriteException('Missing required parameter: "topic_id"') + + api_path = api_path.replace('{topicId}', topic_id) + + + return self.client.call('delete', api_path, { + 'content-type': 'application/json', + }, api_params) + + def list_topic_logs(self, topic_id, queries = None): + """List topic logs""" + + + api_path = '/messaging/topics/{topicId}/logs' + api_params = {} + if topic_id is None: + raise AppwriteException('Missing required parameter: "topic_id"') + + api_path = api_path.replace('{topicId}', topic_id) + + api_params['queries'] = queries + + return self.client.call('get', api_path, { + 'content-type': 'application/json', + }, api_params) + + def list_subscribers(self, topic_id, queries = None, search = None): + """List subscribers""" + + + api_path = '/messaging/topics/{topicId}/subscribers' + api_params = {} + if topic_id is None: + raise AppwriteException('Missing required parameter: "topic_id"') + + api_path = api_path.replace('{topicId}', topic_id) + + api_params['queries'] = queries + api_params['search'] = search + + return self.client.call('get', api_path, { + 'content-type': 'application/json', + }, api_params) + + def create_subscriber(self, topic_id, subscriber_id, target_id): + """Create subscriber""" + + + api_path = '/messaging/topics/{topicId}/subscribers' + api_params = {} + if topic_id is None: + raise AppwriteException('Missing required parameter: "topic_id"') + + if subscriber_id is None: + raise AppwriteException('Missing required parameter: "subscriber_id"') + + if target_id is None: + raise AppwriteException('Missing required parameter: "target_id"') + + api_path = api_path.replace('{topicId}', topic_id) + + api_params['subscriberId'] = subscriber_id + api_params['targetId'] = target_id + + return self.client.call('post', api_path, { + 'content-type': 'application/json', + }, api_params) + + def get_subscriber(self, topic_id, subscriber_id): + """Get subscriber""" + + + api_path = '/messaging/topics/{topicId}/subscribers/{subscriberId}' + api_params = {} + if topic_id is None: + raise AppwriteException('Missing required parameter: "topic_id"') + + if subscriber_id is None: + raise AppwriteException('Missing required parameter: "subscriber_id"') + + api_path = api_path.replace('{topicId}', topic_id) + api_path = api_path.replace('{subscriberId}', subscriber_id) + + + return self.client.call('get', api_path, { + 'content-type': 'application/json', + }, api_params) + + def delete_subscriber(self, topic_id, subscriber_id): + """Delete subscriber""" + + + api_path = '/messaging/topics/{topicId}/subscribers/{subscriberId}' + api_params = {} + if topic_id is None: + raise AppwriteException('Missing required parameter: "topic_id"') + + if subscriber_id is None: + raise AppwriteException('Missing required parameter: "subscriber_id"') + + api_path = api_path.replace('{topicId}', topic_id) + api_path = api_path.replace('{subscriberId}', subscriber_id) + + + return self.client.call('delete', api_path, { + 'content-type': 'application/json', + }, api_params) diff --git a/appwrite/services/users.py b/appwrite/services/users.py index 2bcec8d..137d2ba 100644 --- a/appwrite/services/users.py +++ b/appwrite/services/users.py @@ -105,7 +105,7 @@ def list_identities(self, queries = None, search = None): }, api_params) def delete_identity(self, identity_id): - """Delete Identity""" + """Delete identity""" api_path = '/users/identities/{identityId}' @@ -383,6 +383,110 @@ def list_memberships(self, user_id): 'content-type': 'application/json', }, api_params) + def update_mfa(self, user_id, mfa): + """Update MFA""" + + + api_path = '/users/{userId}/mfa' + api_params = {} + if user_id is None: + raise AppwriteException('Missing required parameter: "user_id"') + + if mfa is None: + raise AppwriteException('Missing required parameter: "mfa"') + + api_path = api_path.replace('{userId}', user_id) + + api_params['mfa'] = mfa + + return self.client.call('patch', api_path, { + 'content-type': 'application/json', + }, api_params) + + def delete_mfa_authenticator(self, user_id, type): + """Delete Authenticator""" + + + api_path = '/users/{userId}/mfa/authenticators/{type}' + api_params = {} + if user_id is None: + raise AppwriteException('Missing required parameter: "user_id"') + + if type is None: + raise AppwriteException('Missing required parameter: "type"') + + api_path = api_path.replace('{userId}', user_id) + api_path = api_path.replace('{type}', type) + + + return self.client.call('delete', api_path, { + 'content-type': 'application/json', + }, api_params) + + def list_mfa_factors(self, user_id): + """List Factors""" + + + api_path = '/users/{userId}/mfa/factors' + api_params = {} + if user_id is None: + raise AppwriteException('Missing required parameter: "user_id"') + + api_path = api_path.replace('{userId}', user_id) + + + return self.client.call('get', api_path, { + 'content-type': 'application/json', + }, api_params) + + def get_mfa_recovery_codes(self, user_id): + """Get MFA Recovery Codes""" + + + api_path = '/users/{userId}/mfa/recovery-codes' + api_params = {} + if user_id is None: + raise AppwriteException('Missing required parameter: "user_id"') + + api_path = api_path.replace('{userId}', user_id) + + + return self.client.call('get', api_path, { + 'content-type': 'application/json', + }, api_params) + + def update_mfa_recovery_codes(self, user_id): + """Regenerate MFA Recovery Codes""" + + + api_path = '/users/{userId}/mfa/recovery-codes' + api_params = {} + if user_id is None: + raise AppwriteException('Missing required parameter: "user_id"') + + api_path = api_path.replace('{userId}', user_id) + + + return self.client.call('put', api_path, { + 'content-type': 'application/json', + }, api_params) + + def create_mfa_recovery_codes(self, user_id): + """Create MFA Recovery Codes""" + + + api_path = '/users/{userId}/mfa/recovery-codes' + api_params = {} + if user_id is None: + raise AppwriteException('Missing required parameter: "user_id"') + + api_path = api_path.replace('{userId}', user_id) + + + return self.client.call('patch', api_path, { + 'content-type': 'application/json', + }, api_params) + def update_name(self, user_id, name): """Update name""" @@ -495,6 +599,22 @@ def list_sessions(self, user_id): 'content-type': 'application/json', }, api_params) + def create_session(self, user_id): + """Create session""" + + + api_path = '/users/{userId}/sessions' + api_params = {} + if user_id is None: + raise AppwriteException('Missing required parameter: "user_id"') + + api_path = api_path.replace('{userId}', user_id) + + + return self.client.call('post', api_path, { + 'content-type': 'application/json', + }, api_params) + def delete_sessions(self, user_id): """Delete user sessions""" @@ -551,6 +671,134 @@ def update_status(self, user_id, status): 'content-type': 'application/json', }, api_params) + def list_targets(self, user_id, queries = None): + """List User Targets""" + + + api_path = '/users/{userId}/targets' + api_params = {} + if user_id is None: + raise AppwriteException('Missing required parameter: "user_id"') + + api_path = api_path.replace('{userId}', user_id) + + api_params['queries'] = queries + + return self.client.call('get', api_path, { + 'content-type': 'application/json', + }, api_params) + + def create_target(self, user_id, target_id, provider_type, identifier, provider_id = None, name = None): + """Create User Target""" + + + api_path = '/users/{userId}/targets' + api_params = {} + if user_id is None: + raise AppwriteException('Missing required parameter: "user_id"') + + if target_id is None: + raise AppwriteException('Missing required parameter: "target_id"') + + if provider_type is None: + raise AppwriteException('Missing required parameter: "provider_type"') + + if identifier is None: + raise AppwriteException('Missing required parameter: "identifier"') + + api_path = api_path.replace('{userId}', user_id) + + api_params['targetId'] = target_id + api_params['providerType'] = provider_type + api_params['identifier'] = identifier + api_params['providerId'] = provider_id + api_params['name'] = name + + return self.client.call('post', api_path, { + 'content-type': 'application/json', + }, api_params) + + def get_target(self, user_id, target_id): + """Get User Target""" + + + api_path = '/users/{userId}/targets/{targetId}' + api_params = {} + if user_id is None: + raise AppwriteException('Missing required parameter: "user_id"') + + if target_id is None: + raise AppwriteException('Missing required parameter: "target_id"') + + api_path = api_path.replace('{userId}', user_id) + api_path = api_path.replace('{targetId}', target_id) + + + return self.client.call('get', api_path, { + 'content-type': 'application/json', + }, api_params) + + def update_target(self, user_id, target_id, identifier = None, provider_id = None, name = None): + """Update User target""" + + + api_path = '/users/{userId}/targets/{targetId}' + api_params = {} + if user_id is None: + raise AppwriteException('Missing required parameter: "user_id"') + + if target_id is None: + raise AppwriteException('Missing required parameter: "target_id"') + + api_path = api_path.replace('{userId}', user_id) + api_path = api_path.replace('{targetId}', target_id) + + api_params['identifier'] = identifier + api_params['providerId'] = provider_id + api_params['name'] = name + + return self.client.call('patch', api_path, { + 'content-type': 'application/json', + }, api_params) + + def delete_target(self, user_id, target_id): + """Delete user target""" + + + api_path = '/users/{userId}/targets/{targetId}' + api_params = {} + if user_id is None: + raise AppwriteException('Missing required parameter: "user_id"') + + if target_id is None: + raise AppwriteException('Missing required parameter: "target_id"') + + api_path = api_path.replace('{userId}', user_id) + api_path = api_path.replace('{targetId}', target_id) + + + return self.client.call('delete', api_path, { + 'content-type': 'application/json', + }, api_params) + + def create_token(self, user_id, length = None, expire = None): + """Create token""" + + + api_path = '/users/{userId}/tokens' + api_params = {} + if user_id is None: + raise AppwriteException('Missing required parameter: "user_id"') + + api_path = api_path.replace('{userId}', user_id) + + api_params['length'] = length + api_params['expire'] = expire + + return self.client.call('post', api_path, { + 'content-type': 'application/json', + }, api_params) + def update_email_verification(self, user_id, email_verification): """Update email verification""" diff --git a/docs/examples/account/create-anonymous-session.md b/docs/examples/account/create-anonymous-session.md new file mode 100644 index 0000000..afaa76b --- /dev/null +++ b/docs/examples/account/create-anonymous-session.md @@ -0,0 +1,9 @@ +from appwrite.client import Client + +client = Client() +client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint +client.set_project('5df5acd0d48c2') # Your project ID + +account = Account(client) + +result = account.create_anonymous_session() diff --git a/docs/examples/account/create-email-password-session.md b/docs/examples/account/create-email-password-session.md new file mode 100644 index 0000000..667d85a --- /dev/null +++ b/docs/examples/account/create-email-password-session.md @@ -0,0 +1,12 @@ +from appwrite.client import Client + +client = Client() +client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint +client.set_project('5df5acd0d48c2') # Your project ID + +account = Account(client) + +result = account.create_email_password_session( + email = 'email@example.com', + password = 'password' +) diff --git a/docs/examples/account/create-email-token.md b/docs/examples/account/create-email-token.md new file mode 100644 index 0000000..a283f42 --- /dev/null +++ b/docs/examples/account/create-email-token.md @@ -0,0 +1,13 @@ +from appwrite.client import Client + +client = Client() +client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint +client.set_project('5df5acd0d48c2') # Your project ID + +account = Account(client) + +result = account.create_email_token( + user_id = '', + email = 'email@example.com', + phrase = False # optional +) diff --git a/docs/examples/account/create-j-w-t.md b/docs/examples/account/create-j-w-t.md new file mode 100644 index 0000000..bc9b684 --- /dev/null +++ b/docs/examples/account/create-j-w-t.md @@ -0,0 +1,9 @@ +from appwrite.client import Client + +client = Client() +client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint +client.set_project('5df5acd0d48c2') # Your project ID + +account = Account(client) + +result = account.create_jwt() diff --git a/docs/examples/account/create-magic-u-r-l-token.md b/docs/examples/account/create-magic-u-r-l-token.md new file mode 100644 index 0000000..1f6593b --- /dev/null +++ b/docs/examples/account/create-magic-u-r-l-token.md @@ -0,0 +1,14 @@ +from appwrite.client import Client + +client = Client() +client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint +client.set_project('5df5acd0d48c2') # Your project ID + +account = Account(client) + +result = account.create_magic_url_token( + user_id = '', + email = 'email@example.com', + url = 'https://example.com', # optional + phrase = False # optional +) diff --git a/docs/examples/account/create-mfa-authenticator.md b/docs/examples/account/create-mfa-authenticator.md new file mode 100644 index 0000000..1c59624 --- /dev/null +++ b/docs/examples/account/create-mfa-authenticator.md @@ -0,0 +1,13 @@ +from appwrite.client import Client +from appwrite.enums import AuthenticatorType + +client = Client() +client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint +client.set_project('5df5acd0d48c2') # Your project ID +client.set_session('') # The user session to authenticate with + +account = Account(client) + +result = account.create_mfa_authenticator( + type = AuthenticatorType.TOTP +) diff --git a/docs/examples/account/create-mfa-challenge.md b/docs/examples/account/create-mfa-challenge.md new file mode 100644 index 0000000..5448d96 --- /dev/null +++ b/docs/examples/account/create-mfa-challenge.md @@ -0,0 +1,12 @@ +from appwrite.client import Client +from appwrite.enums import AuthenticationFactor + +client = Client() +client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint +client.set_project('5df5acd0d48c2') # Your project ID + +account = Account(client) + +result = account.create_mfa_challenge( + factor = AuthenticationFactor.EMAIL +) diff --git a/docs/examples/account/create-mfa-recovery-codes.md b/docs/examples/account/create-mfa-recovery-codes.md new file mode 100644 index 0000000..c675936 --- /dev/null +++ b/docs/examples/account/create-mfa-recovery-codes.md @@ -0,0 +1,10 @@ +from appwrite.client import Client + +client = Client() +client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint +client.set_project('5df5acd0d48c2') # Your project ID +client.set_session('') # The user session to authenticate with + +account = Account(client) + +result = account.create_mfa_recovery_codes() diff --git a/docs/examples/account/create-o-auth2token.md b/docs/examples/account/create-o-auth2token.md new file mode 100644 index 0000000..96c0f88 --- /dev/null +++ b/docs/examples/account/create-o-auth2token.md @@ -0,0 +1,15 @@ +from appwrite.client import Client +from appwrite.enums import OAuthProvider + +client = Client() +client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint +client.set_project('5df5acd0d48c2') # Your project ID + +account = Account(client) + +result = account.create_o_auth2_token( + provider = OAuthProvider.AMAZON, + success = 'https://example.com', # optional + failure = 'https://example.com', # optional + scopes = [] # optional +) diff --git a/docs/examples/account/create-phone-token.md b/docs/examples/account/create-phone-token.md new file mode 100644 index 0000000..b7597df --- /dev/null +++ b/docs/examples/account/create-phone-token.md @@ -0,0 +1,12 @@ +from appwrite.client import Client + +client = Client() +client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint +client.set_project('5df5acd0d48c2') # Your project ID + +account = Account(client) + +result = account.create_phone_token( + user_id = '', + phone = '+12065550100' +) diff --git a/docs/examples/account/create-phone-verification.md b/docs/examples/account/create-phone-verification.md index 2203cdb..ca46b01 100644 --- a/docs/examples/account/create-phone-verification.md +++ b/docs/examples/account/create-phone-verification.md @@ -1,13 +1,9 @@ from appwrite.client import Client -from appwrite.services.account import Account client = Client() - -(client - .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint - .set_project('5df5acd0d48c2') # Your project ID - .set_jwt('eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ...') # Your secret JSON Web Token -) +client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint +client.set_project('5df5acd0d48c2') # Your project ID +client.set_session('') # The user session to authenticate with account = Account(client) diff --git a/docs/examples/account/create-recovery.md b/docs/examples/account/create-recovery.md index 21130fe..c16be97 100644 --- a/docs/examples/account/create-recovery.md +++ b/docs/examples/account/create-recovery.md @@ -1,14 +1,13 @@ from appwrite.client import Client -from appwrite.services.account import Account client = Client() - -(client - .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint - .set_project('5df5acd0d48c2') # Your project ID - .set_jwt('eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ...') # Your secret JSON Web Token -) +client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint +client.set_project('5df5acd0d48c2') # Your project ID +client.set_session('') # The user session to authenticate with account = Account(client) -result = account.create_recovery('email@example.com', 'https://example.com') +result = account.create_recovery( + email = 'email@example.com', + url = 'https://example.com' +) diff --git a/docs/examples/account/create-session.md b/docs/examples/account/create-session.md new file mode 100644 index 0000000..118a1ab --- /dev/null +++ b/docs/examples/account/create-session.md @@ -0,0 +1,12 @@ +from appwrite.client import Client + +client = Client() +client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint +client.set_project('5df5acd0d48c2') # Your project ID + +account = Account(client) + +result = account.create_session( + user_id = '', + secret = '' +) diff --git a/docs/examples/account/create-verification.md b/docs/examples/account/create-verification.md index c45d0d4..6138686 100644 --- a/docs/examples/account/create-verification.md +++ b/docs/examples/account/create-verification.md @@ -1,14 +1,12 @@ from appwrite.client import Client -from appwrite.services.account import Account client = Client() - -(client - .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint - .set_project('5df5acd0d48c2') # Your project ID - .set_jwt('eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ...') # Your secret JSON Web Token -) +client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint +client.set_project('5df5acd0d48c2') # Your project ID +client.set_session('') # The user session to authenticate with account = Account(client) -result = account.create_verification('https://example.com') +result = account.create_verification( + url = 'https://example.com' +) diff --git a/docs/examples/account/create.md b/docs/examples/account/create.md new file mode 100644 index 0000000..d165697 --- /dev/null +++ b/docs/examples/account/create.md @@ -0,0 +1,14 @@ +from appwrite.client import Client + +client = Client() +client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint +client.set_project('5df5acd0d48c2') # Your project ID + +account = Account(client) + +result = account.create( + user_id = '', + email = 'email@example.com', + password = '', + name = '' # optional +) diff --git a/docs/examples/account/delete-identity.md b/docs/examples/account/delete-identity.md index bac4334..1462fbc 100644 --- a/docs/examples/account/delete-identity.md +++ b/docs/examples/account/delete-identity.md @@ -1,14 +1,12 @@ from appwrite.client import Client -from appwrite.services.account import Account client = Client() - -(client - .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint - .set_project('5df5acd0d48c2') # Your project ID - .set_jwt('eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ...') # Your secret JSON Web Token -) +client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint +client.set_project('5df5acd0d48c2') # Your project ID +client.set_session('') # The user session to authenticate with account = Account(client) -result = account.delete_identity('[IDENTITY_ID]') +result = account.delete_identity( + identity_id = '' +) diff --git a/docs/examples/account/delete-mfa-authenticator.md b/docs/examples/account/delete-mfa-authenticator.md new file mode 100644 index 0000000..5deb210 --- /dev/null +++ b/docs/examples/account/delete-mfa-authenticator.md @@ -0,0 +1,14 @@ +from appwrite.client import Client +from appwrite.enums import AuthenticatorType + +client = Client() +client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint +client.set_project('5df5acd0d48c2') # Your project ID +client.set_session('') # The user session to authenticate with + +account = Account(client) + +result = account.delete_mfa_authenticator( + type = AuthenticatorType.TOTP, + otp = '' +) diff --git a/docs/examples/account/delete-session.md b/docs/examples/account/delete-session.md index 8095cdc..030d698 100644 --- a/docs/examples/account/delete-session.md +++ b/docs/examples/account/delete-session.md @@ -1,14 +1,12 @@ from appwrite.client import Client -from appwrite.services.account import Account client = Client() - -(client - .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint - .set_project('5df5acd0d48c2') # Your project ID - .set_jwt('eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ...') # Your secret JSON Web Token -) +client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint +client.set_project('5df5acd0d48c2') # Your project ID +client.set_session('') # The user session to authenticate with account = Account(client) -result = account.delete_session('[SESSION_ID]') +result = account.delete_session( + session_id = '' +) diff --git a/docs/examples/account/delete-sessions.md b/docs/examples/account/delete-sessions.md index 1728d61..182c375 100644 --- a/docs/examples/account/delete-sessions.md +++ b/docs/examples/account/delete-sessions.md @@ -1,13 +1,9 @@ from appwrite.client import Client -from appwrite.services.account import Account client = Client() - -(client - .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint - .set_project('5df5acd0d48c2') # Your project ID - .set_jwt('eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ...') # Your secret JSON Web Token -) +client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint +client.set_project('5df5acd0d48c2') # Your project ID +client.set_session('') # The user session to authenticate with account = Account(client) diff --git a/docs/examples/account/get-mfa-recovery-codes.md b/docs/examples/account/get-mfa-recovery-codes.md new file mode 100644 index 0000000..123fe4b --- /dev/null +++ b/docs/examples/account/get-mfa-recovery-codes.md @@ -0,0 +1,10 @@ +from appwrite.client import Client + +client = Client() +client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint +client.set_project('5df5acd0d48c2') # Your project ID +client.set_session('') # The user session to authenticate with + +account = Account(client) + +result = account.get_mfa_recovery_codes() diff --git a/docs/examples/account/get-prefs.md b/docs/examples/account/get-prefs.md index da2fd76..102f4dc 100644 --- a/docs/examples/account/get-prefs.md +++ b/docs/examples/account/get-prefs.md @@ -1,13 +1,9 @@ from appwrite.client import Client -from appwrite.services.account import Account client = Client() - -(client - .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint - .set_project('5df5acd0d48c2') # Your project ID - .set_jwt('eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ...') # Your secret JSON Web Token -) +client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint +client.set_project('5df5acd0d48c2') # Your project ID +client.set_session('') # The user session to authenticate with account = Account(client) diff --git a/docs/examples/account/get-session.md b/docs/examples/account/get-session.md index 25b8f03..b9483ac 100644 --- a/docs/examples/account/get-session.md +++ b/docs/examples/account/get-session.md @@ -1,14 +1,12 @@ from appwrite.client import Client -from appwrite.services.account import Account client = Client() - -(client - .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint - .set_project('5df5acd0d48c2') # Your project ID - .set_jwt('eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ...') # Your secret JSON Web Token -) +client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint +client.set_project('5df5acd0d48c2') # Your project ID +client.set_session('') # The user session to authenticate with account = Account(client) -result = account.get_session('[SESSION_ID]') +result = account.get_session( + session_id = '' +) diff --git a/docs/examples/account/get.md b/docs/examples/account/get.md index f75bad7..cc66fe6 100644 --- a/docs/examples/account/get.md +++ b/docs/examples/account/get.md @@ -1,13 +1,9 @@ from appwrite.client import Client -from appwrite.services.account import Account client = Client() - -(client - .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint - .set_project('5df5acd0d48c2') # Your project ID - .set_jwt('eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ...') # Your secret JSON Web Token -) +client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint +client.set_project('5df5acd0d48c2') # Your project ID +client.set_session('') # The user session to authenticate with account = Account(client) diff --git a/docs/examples/account/list-identities.md b/docs/examples/account/list-identities.md index 3c166d1..3e0d4e0 100644 --- a/docs/examples/account/list-identities.md +++ b/docs/examples/account/list-identities.md @@ -1,14 +1,12 @@ from appwrite.client import Client -from appwrite.services.account import Account client = Client() - -(client - .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint - .set_project('5df5acd0d48c2') # Your project ID - .set_jwt('eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ...') # Your secret JSON Web Token -) +client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint +client.set_project('5df5acd0d48c2') # Your project ID +client.set_session('') # The user session to authenticate with account = Account(client) -result = account.list_identities() +result = account.list_identities( + queries = [] # optional +) diff --git a/docs/examples/account/list-logs.md b/docs/examples/account/list-logs.md index 65802d8..0c0b28a 100644 --- a/docs/examples/account/list-logs.md +++ b/docs/examples/account/list-logs.md @@ -1,14 +1,12 @@ from appwrite.client import Client -from appwrite.services.account import Account client = Client() - -(client - .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint - .set_project('5df5acd0d48c2') # Your project ID - .set_jwt('eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ...') # Your secret JSON Web Token -) +client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint +client.set_project('5df5acd0d48c2') # Your project ID +client.set_session('') # The user session to authenticate with account = Account(client) -result = account.list_logs() +result = account.list_logs( + queries = [] # optional +) diff --git a/docs/examples/account/list-mfa-factors.md b/docs/examples/account/list-mfa-factors.md new file mode 100644 index 0000000..007c237 --- /dev/null +++ b/docs/examples/account/list-mfa-factors.md @@ -0,0 +1,10 @@ +from appwrite.client import Client + +client = Client() +client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint +client.set_project('5df5acd0d48c2') # Your project ID +client.set_session('') # The user session to authenticate with + +account = Account(client) + +result = account.list_mfa_factors() diff --git a/docs/examples/account/list-sessions.md b/docs/examples/account/list-sessions.md index 12d5c81..23398dc 100644 --- a/docs/examples/account/list-sessions.md +++ b/docs/examples/account/list-sessions.md @@ -1,13 +1,9 @@ from appwrite.client import Client -from appwrite.services.account import Account client = Client() - -(client - .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint - .set_project('5df5acd0d48c2') # Your project ID - .set_jwt('eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ...') # Your secret JSON Web Token -) +client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint +client.set_project('5df5acd0d48c2') # Your project ID +client.set_session('') # The user session to authenticate with account = Account(client) diff --git a/docs/examples/account/update-email.md b/docs/examples/account/update-email.md index f4a6776..353edb0 100644 --- a/docs/examples/account/update-email.md +++ b/docs/examples/account/update-email.md @@ -1,14 +1,13 @@ from appwrite.client import Client -from appwrite.services.account import Account client = Client() - -(client - .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint - .set_project('5df5acd0d48c2') # Your project ID - .set_jwt('eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ...') # Your secret JSON Web Token -) +client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint +client.set_project('5df5acd0d48c2') # Your project ID +client.set_session('') # The user session to authenticate with account = Account(client) -result = account.update_email('email@example.com', 'password') +result = account.update_email( + email = 'email@example.com', + password = 'password' +) diff --git a/docs/examples/account/update-m-f-a.md b/docs/examples/account/update-m-f-a.md new file mode 100644 index 0000000..b59ede8 --- /dev/null +++ b/docs/examples/account/update-m-f-a.md @@ -0,0 +1,12 @@ +from appwrite.client import Client + +client = Client() +client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint +client.set_project('5df5acd0d48c2') # Your project ID +client.set_session('') # The user session to authenticate with + +account = Account(client) + +result = account.update_mfa( + mfa = False +) diff --git a/docs/examples/account/update-magic-u-r-l-session.md b/docs/examples/account/update-magic-u-r-l-session.md new file mode 100644 index 0000000..631fac0 --- /dev/null +++ b/docs/examples/account/update-magic-u-r-l-session.md @@ -0,0 +1,12 @@ +from appwrite.client import Client + +client = Client() +client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint +client.set_project('5df5acd0d48c2') # Your project ID + +account = Account(client) + +result = account.update_magic_url_session( + user_id = '', + secret = '' +) diff --git a/docs/examples/account/update-mfa-authenticator.md b/docs/examples/account/update-mfa-authenticator.md new file mode 100644 index 0000000..dc9a21f --- /dev/null +++ b/docs/examples/account/update-mfa-authenticator.md @@ -0,0 +1,14 @@ +from appwrite.client import Client +from appwrite.enums import AuthenticatorType + +client = Client() +client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint +client.set_project('5df5acd0d48c2') # Your project ID +client.set_session('') # The user session to authenticate with + +account = Account(client) + +result = account.update_mfa_authenticator( + type = AuthenticatorType.TOTP, + otp = '' +) diff --git a/docs/examples/account/update-mfa-challenge.md b/docs/examples/account/update-mfa-challenge.md new file mode 100644 index 0000000..7074e6d --- /dev/null +++ b/docs/examples/account/update-mfa-challenge.md @@ -0,0 +1,13 @@ +from appwrite.client import Client + +client = Client() +client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint +client.set_project('5df5acd0d48c2') # Your project ID +client.set_session('') # The user session to authenticate with + +account = Account(client) + +result = account.update_mfa_challenge( + challenge_id = '', + otp = '' +) diff --git a/docs/examples/account/update-mfa-recovery-codes.md b/docs/examples/account/update-mfa-recovery-codes.md new file mode 100644 index 0000000..281d892 --- /dev/null +++ b/docs/examples/account/update-mfa-recovery-codes.md @@ -0,0 +1,10 @@ +from appwrite.client import Client + +client = Client() +client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint +client.set_project('5df5acd0d48c2') # Your project ID +client.set_session('') # The user session to authenticate with + +account = Account(client) + +result = account.update_mfa_recovery_codes() diff --git a/docs/examples/account/update-name.md b/docs/examples/account/update-name.md index eb1eb62..8e16f49 100644 --- a/docs/examples/account/update-name.md +++ b/docs/examples/account/update-name.md @@ -1,14 +1,12 @@ from appwrite.client import Client -from appwrite.services.account import Account client = Client() - -(client - .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint - .set_project('5df5acd0d48c2') # Your project ID - .set_jwt('eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ...') # Your secret JSON Web Token -) +client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint +client.set_project('5df5acd0d48c2') # Your project ID +client.set_session('') # The user session to authenticate with account = Account(client) -result = account.update_name('[NAME]') +result = account.update_name( + name = '' +) diff --git a/docs/examples/account/update-password.md b/docs/examples/account/update-password.md index 955ada6..7d651c2 100644 --- a/docs/examples/account/update-password.md +++ b/docs/examples/account/update-password.md @@ -1,14 +1,13 @@ from appwrite.client import Client -from appwrite.services.account import Account client = Client() - -(client - .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint - .set_project('5df5acd0d48c2') # Your project ID - .set_jwt('eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ...') # Your secret JSON Web Token -) +client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint +client.set_project('5df5acd0d48c2') # Your project ID +client.set_session('') # The user session to authenticate with account = Account(client) -result = account.update_password('') +result = account.update_password( + password = '', + old_password = 'password' # optional +) diff --git a/docs/examples/account/update-phone-session.md b/docs/examples/account/update-phone-session.md new file mode 100644 index 0000000..ff0c10d --- /dev/null +++ b/docs/examples/account/update-phone-session.md @@ -0,0 +1,12 @@ +from appwrite.client import Client + +client = Client() +client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint +client.set_project('5df5acd0d48c2') # Your project ID + +account = Account(client) + +result = account.update_phone_session( + user_id = '', + secret = '' +) diff --git a/docs/examples/account/update-phone-verification.md b/docs/examples/account/update-phone-verification.md index f2a75b4..adb5b35 100644 --- a/docs/examples/account/update-phone-verification.md +++ b/docs/examples/account/update-phone-verification.md @@ -1,14 +1,13 @@ from appwrite.client import Client -from appwrite.services.account import Account client = Client() - -(client - .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint - .set_project('5df5acd0d48c2') # Your project ID - .set_jwt('eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ...') # Your secret JSON Web Token -) +client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint +client.set_project('5df5acd0d48c2') # Your project ID +client.set_session('') # The user session to authenticate with account = Account(client) -result = account.update_phone_verification('[USER_ID]', '[SECRET]') +result = account.update_phone_verification( + user_id = '', + secret = '' +) diff --git a/docs/examples/account/update-phone.md b/docs/examples/account/update-phone.md index aaee1f7..c05bb16 100644 --- a/docs/examples/account/update-phone.md +++ b/docs/examples/account/update-phone.md @@ -1,14 +1,13 @@ from appwrite.client import Client -from appwrite.services.account import Account client = Client() - -(client - .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint - .set_project('5df5acd0d48c2') # Your project ID - .set_jwt('eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ...') # Your secret JSON Web Token -) +client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint +client.set_project('5df5acd0d48c2') # Your project ID +client.set_session('') # The user session to authenticate with account = Account(client) -result = account.update_phone('+12065550100', 'password') +result = account.update_phone( + phone = '+12065550100', + password = 'password' +) diff --git a/docs/examples/account/update-prefs.md b/docs/examples/account/update-prefs.md index e96546b..2c58cca 100644 --- a/docs/examples/account/update-prefs.md +++ b/docs/examples/account/update-prefs.md @@ -1,14 +1,12 @@ from appwrite.client import Client -from appwrite.services.account import Account client = Client() - -(client - .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint - .set_project('5df5acd0d48c2') # Your project ID - .set_jwt('eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ...') # Your secret JSON Web Token -) +client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint +client.set_project('5df5acd0d48c2') # Your project ID +client.set_session('') # The user session to authenticate with account = Account(client) -result = account.update_prefs({}) +result = account.update_prefs( + prefs = {} +) diff --git a/docs/examples/account/update-recovery.md b/docs/examples/account/update-recovery.md index b4ea8aa..4dca711 100644 --- a/docs/examples/account/update-recovery.md +++ b/docs/examples/account/update-recovery.md @@ -1,14 +1,14 @@ from appwrite.client import Client -from appwrite.services.account import Account client = Client() - -(client - .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint - .set_project('5df5acd0d48c2') # Your project ID - .set_jwt('eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ...') # Your secret JSON Web Token -) +client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint +client.set_project('5df5acd0d48c2') # Your project ID +client.set_session('') # The user session to authenticate with account = Account(client) -result = account.update_recovery('[USER_ID]', '[SECRET]', 'password', 'password') +result = account.update_recovery( + user_id = '', + secret = '', + password = '' +) diff --git a/docs/examples/account/update-session.md b/docs/examples/account/update-session.md index e7234f7..006c508 100644 --- a/docs/examples/account/update-session.md +++ b/docs/examples/account/update-session.md @@ -1,14 +1,12 @@ from appwrite.client import Client -from appwrite.services.account import Account client = Client() - -(client - .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint - .set_project('5df5acd0d48c2') # Your project ID - .set_jwt('eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ...') # Your secret JSON Web Token -) +client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint +client.set_project('5df5acd0d48c2') # Your project ID +client.set_session('') # The user session to authenticate with account = Account(client) -result = account.update_session('[SESSION_ID]') +result = account.update_session( + session_id = '' +) diff --git a/docs/examples/account/update-status.md b/docs/examples/account/update-status.md index 5924d4d..5c17fa1 100644 --- a/docs/examples/account/update-status.md +++ b/docs/examples/account/update-status.md @@ -1,13 +1,9 @@ from appwrite.client import Client -from appwrite.services.account import Account client = Client() - -(client - .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint - .set_project('5df5acd0d48c2') # Your project ID - .set_jwt('eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ...') # Your secret JSON Web Token -) +client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint +client.set_project('5df5acd0d48c2') # Your project ID +client.set_session('') # The user session to authenticate with account = Account(client) diff --git a/docs/examples/account/update-verification.md b/docs/examples/account/update-verification.md index 9a410a5..84c8c4b 100644 --- a/docs/examples/account/update-verification.md +++ b/docs/examples/account/update-verification.md @@ -1,14 +1,13 @@ from appwrite.client import Client -from appwrite.services.account import Account client = Client() - -(client - .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint - .set_project('5df5acd0d48c2') # Your project ID - .set_jwt('eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ...') # Your secret JSON Web Token -) +client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint +client.set_project('5df5acd0d48c2') # Your project ID +client.set_session('') # The user session to authenticate with account = Account(client) -result = account.update_verification('[USER_ID]', '[SECRET]') +result = account.update_verification( + user_id = '', + secret = '' +) diff --git a/docs/examples/avatars/get-browser.md b/docs/examples/avatars/get-browser.md index 9ed56d1..1de5eab 100644 --- a/docs/examples/avatars/get-browser.md +++ b/docs/examples/avatars/get-browser.md @@ -1,14 +1,16 @@ from appwrite.client import Client -from appwrite.services.avatars import Avatars +from appwrite.enums import Browser 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 -) +client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint +client.set_project('5df5acd0d48c2') # Your project ID +client.set_session('') # The user session to authenticate with avatars = Avatars(client) -result = avatars.get_browser('aa') +result = avatars.get_browser( + code = Browser.AVANT_BROWSER, + width = 0, # optional + height = 0, # optional + quality = 0 # optional +) diff --git a/docs/examples/avatars/get-credit-card.md b/docs/examples/avatars/get-credit-card.md index 9fa6b0f..9437ff8 100644 --- a/docs/examples/avatars/get-credit-card.md +++ b/docs/examples/avatars/get-credit-card.md @@ -1,14 +1,16 @@ from appwrite.client import Client -from appwrite.services.avatars import Avatars +from appwrite.enums import CreditCard 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 -) +client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint +client.set_project('5df5acd0d48c2') # Your project ID +client.set_session('') # The user session to authenticate with avatars = Avatars(client) -result = avatars.get_credit_card('amex') +result = avatars.get_credit_card( + code = CreditCard.AMERICAN_EXPRESS, + width = 0, # optional + height = 0, # optional + quality = 0 # optional +) diff --git a/docs/examples/avatars/get-favicon.md b/docs/examples/avatars/get-favicon.md index 75b0315..2867696 100644 --- a/docs/examples/avatars/get-favicon.md +++ b/docs/examples/avatars/get-favicon.md @@ -1,14 +1,12 @@ from appwrite.client import Client -from appwrite.services.avatars import Avatars 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 -) +client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint +client.set_project('5df5acd0d48c2') # Your project ID +client.set_session('') # The user session to authenticate with avatars = Avatars(client) -result = avatars.get_favicon('https://example.com') +result = avatars.get_favicon( + url = 'https://example.com' +) diff --git a/docs/examples/avatars/get-flag.md b/docs/examples/avatars/get-flag.md index 70d2e5f..37ac482 100644 --- a/docs/examples/avatars/get-flag.md +++ b/docs/examples/avatars/get-flag.md @@ -1,14 +1,16 @@ from appwrite.client import Client -from appwrite.services.avatars import Avatars +from appwrite.enums import Flag 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 -) +client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint +client.set_project('5df5acd0d48c2') # Your project ID +client.set_session('') # The user session to authenticate with avatars = Avatars(client) -result = avatars.get_flag('af') +result = avatars.get_flag( + code = Flag.AFGHANISTAN, + width = 0, # optional + height = 0, # optional + quality = 0 # optional +) diff --git a/docs/examples/avatars/get-image.md b/docs/examples/avatars/get-image.md index 35015d9..00afe0c 100644 --- a/docs/examples/avatars/get-image.md +++ b/docs/examples/avatars/get-image.md @@ -1,14 +1,14 @@ from appwrite.client import Client -from appwrite.services.avatars import Avatars 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 -) +client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint +client.set_project('5df5acd0d48c2') # Your project ID +client.set_session('') # The user session to authenticate with avatars = Avatars(client) -result = avatars.get_image('https://example.com') +result = avatars.get_image( + url = 'https://example.com', + width = 0, # optional + height = 0 # optional +) diff --git a/docs/examples/avatars/get-initials.md b/docs/examples/avatars/get-initials.md index 639fa03..0a20c14 100644 --- a/docs/examples/avatars/get-initials.md +++ b/docs/examples/avatars/get-initials.md @@ -1,14 +1,15 @@ from appwrite.client import Client -from appwrite.services.avatars import Avatars 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 -) +client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint +client.set_project('5df5acd0d48c2') # Your project ID +client.set_session('') # The user session to authenticate with avatars = Avatars(client) -result = avatars.get_initials() +result = avatars.get_initials( + name = '', # optional + width = 0, # optional + height = 0, # optional + background = '' # optional +) diff --git a/docs/examples/avatars/get-q-r.md b/docs/examples/avatars/get-q-r.md index 27fc8e2..bee29f7 100644 --- a/docs/examples/avatars/get-q-r.md +++ b/docs/examples/avatars/get-q-r.md @@ -1,14 +1,15 @@ from appwrite.client import Client -from appwrite.services.avatars import Avatars 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 -) +client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint +client.set_project('5df5acd0d48c2') # Your project ID +client.set_session('') # The user session to authenticate with avatars = Avatars(client) -result = avatars.get_qr('[TEXT]') +result = avatars.get_qr( + text = '', + size = 1, # optional + margin = 0, # optional + download = False # optional +) diff --git a/docs/examples/databases/create-boolean-attribute.md b/docs/examples/databases/create-boolean-attribute.md index f073d3d..bf09562 100644 --- a/docs/examples/databases/create-boolean-attribute.md +++ b/docs/examples/databases/create-boolean-attribute.md @@ -1,14 +1,17 @@ from appwrite.client import Client -from appwrite.services.databases import Databases 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 -) +client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint +client.set_project('5df5acd0d48c2') # Your project ID +client.set_key('919c2d18fb5d4...a2ae413da83346ad2') # Your secret API key databases = Databases(client) -result = databases.create_boolean_attribute('[DATABASE_ID]', '[COLLECTION_ID]', '', False) +result = databases.create_boolean_attribute( + database_id = '', + collection_id = '', + key = '', + required = False, + default = False, # optional + array = False # optional +) diff --git a/docs/examples/databases/create-collection.md b/docs/examples/databases/create-collection.md index 183c55c..dfe3611 100644 --- a/docs/examples/databases/create-collection.md +++ b/docs/examples/databases/create-collection.md @@ -1,14 +1,17 @@ from appwrite.client import Client -from appwrite.services.databases import Databases 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 -) +client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint +client.set_project('5df5acd0d48c2') # Your project ID +client.set_key('919c2d18fb5d4...a2ae413da83346ad2') # Your secret API key databases = Databases(client) -result = databases.create_collection('[DATABASE_ID]', '[COLLECTION_ID]', '[NAME]') +result = databases.create_collection( + database_id = '', + collection_id = '', + name = '', + permissions = ["read("any")"], # optional + document_security = False, # optional + enabled = False # optional +) diff --git a/docs/examples/databases/create-datetime-attribute.md b/docs/examples/databases/create-datetime-attribute.md index 5c77689..0b8a555 100644 --- a/docs/examples/databases/create-datetime-attribute.md +++ b/docs/examples/databases/create-datetime-attribute.md @@ -1,14 +1,17 @@ from appwrite.client import Client -from appwrite.services.databases import Databases 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 -) +client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint +client.set_project('5df5acd0d48c2') # Your project ID +client.set_key('919c2d18fb5d4...a2ae413da83346ad2') # Your secret API key databases = Databases(client) -result = databases.create_datetime_attribute('[DATABASE_ID]', '[COLLECTION_ID]', '', False) +result = databases.create_datetime_attribute( + database_id = '', + collection_id = '', + key = '', + required = False, + default = '', # optional + array = False # optional +) diff --git a/docs/examples/databases/create-document.md b/docs/examples/databases/create-document.md index aa95de9..a457811 100644 --- a/docs/examples/databases/create-document.md +++ b/docs/examples/databases/create-document.md @@ -1,14 +1,16 @@ from appwrite.client import Client -from appwrite.services.databases import Databases 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 -) +client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint +client.set_project('5df5acd0d48c2') # Your project ID +client.set_session('') # The user session to authenticate with databases = Databases(client) -result = databases.create_document('[DATABASE_ID]', '[COLLECTION_ID]', '[DOCUMENT_ID]', {}) +result = databases.create_document( + database_id = '', + collection_id = '', + document_id = '', + data = {}, + permissions = ["read("any")"] # optional +) diff --git a/docs/examples/databases/create-email-attribute.md b/docs/examples/databases/create-email-attribute.md index 92cdcb2..840e6b5 100644 --- a/docs/examples/databases/create-email-attribute.md +++ b/docs/examples/databases/create-email-attribute.md @@ -1,14 +1,17 @@ from appwrite.client import Client -from appwrite.services.databases import Databases 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 -) +client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint +client.set_project('5df5acd0d48c2') # Your project ID +client.set_key('919c2d18fb5d4...a2ae413da83346ad2') # Your secret API key databases = Databases(client) -result = databases.create_email_attribute('[DATABASE_ID]', '[COLLECTION_ID]', '', False) +result = databases.create_email_attribute( + database_id = '', + collection_id = '', + key = '', + required = False, + default = 'email@example.com', # optional + array = False # optional +) diff --git a/docs/examples/databases/create-enum-attribute.md b/docs/examples/databases/create-enum-attribute.md index df66f12..0e891d5 100644 --- a/docs/examples/databases/create-enum-attribute.md +++ b/docs/examples/databases/create-enum-attribute.md @@ -1,14 +1,18 @@ from appwrite.client import Client -from appwrite.services.databases import Databases 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 -) +client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint +client.set_project('5df5acd0d48c2') # Your project ID +client.set_key('919c2d18fb5d4...a2ae413da83346ad2') # Your secret API key databases = Databases(client) -result = databases.create_enum_attribute('[DATABASE_ID]', '[COLLECTION_ID]', '', [], False) +result = databases.create_enum_attribute( + database_id = '', + collection_id = '', + key = '', + elements = [], + required = False, + default = '', # optional + array = False # optional +) diff --git a/docs/examples/databases/create-float-attribute.md b/docs/examples/databases/create-float-attribute.md index 0bfe424..34fda4f 100644 --- a/docs/examples/databases/create-float-attribute.md +++ b/docs/examples/databases/create-float-attribute.md @@ -1,14 +1,19 @@ from appwrite.client import Client -from appwrite.services.databases import Databases 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 -) +client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint +client.set_project('5df5acd0d48c2') # Your project ID +client.set_key('919c2d18fb5d4...a2ae413da83346ad2') # Your secret API key databases = Databases(client) -result = databases.create_float_attribute('[DATABASE_ID]', '[COLLECTION_ID]', '', False) +result = databases.create_float_attribute( + database_id = '', + collection_id = '', + key = '', + required = False, + min = None, # optional + max = None, # optional + default = None, # optional + array = False # optional +) diff --git a/docs/examples/databases/create-index.md b/docs/examples/databases/create-index.md index 78a7d33..72fe622 100644 --- a/docs/examples/databases/create-index.md +++ b/docs/examples/databases/create-index.md @@ -1,14 +1,18 @@ from appwrite.client import Client -from appwrite.services.databases import Databases +from appwrite.enums import IndexType 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 -) +client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint +client.set_project('5df5acd0d48c2') # Your project ID +client.set_key('919c2d18fb5d4...a2ae413da83346ad2') # Your secret API key databases = Databases(client) -result = databases.create_index('[DATABASE_ID]', '[COLLECTION_ID]', '', 'key', []) +result = databases.create_index( + database_id = '', + collection_id = '', + key = '', + type = IndexType.KEY, + attributes = [], + orders = [] # optional +) diff --git a/docs/examples/databases/create-integer-attribute.md b/docs/examples/databases/create-integer-attribute.md index b3cce2b..057cfb7 100644 --- a/docs/examples/databases/create-integer-attribute.md +++ b/docs/examples/databases/create-integer-attribute.md @@ -1,14 +1,19 @@ from appwrite.client import Client -from appwrite.services.databases import Databases 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 -) +client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint +client.set_project('5df5acd0d48c2') # Your project ID +client.set_key('919c2d18fb5d4...a2ae413da83346ad2') # Your secret API key databases = Databases(client) -result = databases.create_integer_attribute('[DATABASE_ID]', '[COLLECTION_ID]', '', False) +result = databases.create_integer_attribute( + database_id = '', + collection_id = '', + key = '', + required = False, + min = None, # optional + max = None, # optional + default = None, # optional + array = False # optional +) diff --git a/docs/examples/databases/create-ip-attribute.md b/docs/examples/databases/create-ip-attribute.md index 967d284..54e887c 100644 --- a/docs/examples/databases/create-ip-attribute.md +++ b/docs/examples/databases/create-ip-attribute.md @@ -1,14 +1,17 @@ from appwrite.client import Client -from appwrite.services.databases import Databases 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 -) +client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint +client.set_project('5df5acd0d48c2') # Your project ID +client.set_key('919c2d18fb5d4...a2ae413da83346ad2') # Your secret API key databases = Databases(client) -result = databases.create_ip_attribute('[DATABASE_ID]', '[COLLECTION_ID]', '', False) +result = databases.create_ip_attribute( + database_id = '', + collection_id = '', + key = '', + required = False, + default = '', # optional + array = False # optional +) diff --git a/docs/examples/databases/create-relationship-attribute.md b/docs/examples/databases/create-relationship-attribute.md index 4f69eca..0d1dbe0 100644 --- a/docs/examples/databases/create-relationship-attribute.md +++ b/docs/examples/databases/create-relationship-attribute.md @@ -1,14 +1,20 @@ from appwrite.client import Client -from appwrite.services.databases import Databases +from appwrite.enums import RelationshipType 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 -) +client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint +client.set_project('5df5acd0d48c2') # Your project ID +client.set_key('919c2d18fb5d4...a2ae413da83346ad2') # Your secret API key databases = Databases(client) -result = databases.create_relationship_attribute('[DATABASE_ID]', '[COLLECTION_ID]', '[RELATED_COLLECTION_ID]', 'oneToOne') +result = databases.create_relationship_attribute( + database_id = '', + collection_id = '', + related_collection_id = '', + type = RelationshipType.ONETOONE, + two_way = False, # optional + key = '', # optional + two_way_key = '', # optional + on_delete = RelationMutate.CASCADE # optional +) diff --git a/docs/examples/databases/create-string-attribute.md b/docs/examples/databases/create-string-attribute.md index 00bbbe9..c15512a 100644 --- a/docs/examples/databases/create-string-attribute.md +++ b/docs/examples/databases/create-string-attribute.md @@ -1,14 +1,19 @@ from appwrite.client import Client -from appwrite.services.databases import Databases 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 -) +client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint +client.set_project('5df5acd0d48c2') # Your project ID +client.set_key('919c2d18fb5d4...a2ae413da83346ad2') # Your secret API key databases = Databases(client) -result = databases.create_string_attribute('[DATABASE_ID]', '[COLLECTION_ID]', '', 1, False) +result = databases.create_string_attribute( + database_id = '', + collection_id = '', + key = '', + size = 1, + required = False, + default = '', # optional + array = False, # optional + encrypt = False # optional +) diff --git a/docs/examples/databases/create-url-attribute.md b/docs/examples/databases/create-url-attribute.md index fd5b7f4..f77a630 100644 --- a/docs/examples/databases/create-url-attribute.md +++ b/docs/examples/databases/create-url-attribute.md @@ -1,14 +1,17 @@ from appwrite.client import Client -from appwrite.services.databases import Databases 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 -) +client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint +client.set_project('5df5acd0d48c2') # Your project ID +client.set_key('919c2d18fb5d4...a2ae413da83346ad2') # Your secret API key databases = Databases(client) -result = databases.create_url_attribute('[DATABASE_ID]', '[COLLECTION_ID]', '', False) +result = databases.create_url_attribute( + database_id = '', + collection_id = '', + key = '', + required = False, + default = 'https://example.com', # optional + array = False # optional +) diff --git a/docs/examples/databases/create.md b/docs/examples/databases/create.md index e4a8320..329e653 100644 --- a/docs/examples/databases/create.md +++ b/docs/examples/databases/create.md @@ -1,14 +1,14 @@ from appwrite.client import Client -from appwrite.services.databases import Databases 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 -) +client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint +client.set_project('5df5acd0d48c2') # Your project ID +client.set_key('919c2d18fb5d4...a2ae413da83346ad2') # Your secret API key databases = Databases(client) -result = databases.create('[DATABASE_ID]', '[NAME]') +result = databases.create( + database_id = '', + name = '', + enabled = False # optional +) diff --git a/docs/examples/databases/delete-attribute.md b/docs/examples/databases/delete-attribute.md index 41871b2..87fcf57 100644 --- a/docs/examples/databases/delete-attribute.md +++ b/docs/examples/databases/delete-attribute.md @@ -1,14 +1,14 @@ from appwrite.client import Client -from appwrite.services.databases import Databases 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 -) +client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint +client.set_project('5df5acd0d48c2') # Your project ID +client.set_key('919c2d18fb5d4...a2ae413da83346ad2') # Your secret API key databases = Databases(client) -result = databases.delete_attribute('[DATABASE_ID]', '[COLLECTION_ID]', '') +result = databases.delete_attribute( + database_id = '', + collection_id = '', + key = '' +) diff --git a/docs/examples/databases/delete-collection.md b/docs/examples/databases/delete-collection.md index 998bb61..296c69d 100644 --- a/docs/examples/databases/delete-collection.md +++ b/docs/examples/databases/delete-collection.md @@ -1,14 +1,13 @@ from appwrite.client import Client -from appwrite.services.databases import Databases 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 -) +client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint +client.set_project('5df5acd0d48c2') # Your project ID +client.set_key('919c2d18fb5d4...a2ae413da83346ad2') # Your secret API key databases = Databases(client) -result = databases.delete_collection('[DATABASE_ID]', '[COLLECTION_ID]') +result = databases.delete_collection( + database_id = '', + collection_id = '' +) diff --git a/docs/examples/databases/delete-document.md b/docs/examples/databases/delete-document.md index 605b087..3191f10 100644 --- a/docs/examples/databases/delete-document.md +++ b/docs/examples/databases/delete-document.md @@ -1,14 +1,14 @@ from appwrite.client import Client -from appwrite.services.databases import Databases 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 -) +client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint +client.set_project('5df5acd0d48c2') # Your project ID +client.set_session('') # The user session to authenticate with databases = Databases(client) -result = databases.delete_document('[DATABASE_ID]', '[COLLECTION_ID]', '[DOCUMENT_ID]') +result = databases.delete_document( + database_id = '', + collection_id = '', + document_id = '' +) diff --git a/docs/examples/databases/delete-index.md b/docs/examples/databases/delete-index.md index a53e06c..bd4fcf5 100644 --- a/docs/examples/databases/delete-index.md +++ b/docs/examples/databases/delete-index.md @@ -1,14 +1,14 @@ from appwrite.client import Client -from appwrite.services.databases import Databases 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 -) +client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint +client.set_project('5df5acd0d48c2') # Your project ID +client.set_key('919c2d18fb5d4...a2ae413da83346ad2') # Your secret API key databases = Databases(client) -result = databases.delete_index('[DATABASE_ID]', '[COLLECTION_ID]', '') +result = databases.delete_index( + database_id = '', + collection_id = '', + key = '' +) diff --git a/docs/examples/databases/delete.md b/docs/examples/databases/delete.md index 780e145..302a652 100644 --- a/docs/examples/databases/delete.md +++ b/docs/examples/databases/delete.md @@ -1,14 +1,12 @@ from appwrite.client import Client -from appwrite.services.databases import Databases 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 -) +client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint +client.set_project('5df5acd0d48c2') # Your project ID +client.set_key('919c2d18fb5d4...a2ae413da83346ad2') # Your secret API key databases = Databases(client) -result = databases.delete('[DATABASE_ID]') +result = databases.delete( + database_id = '' +) diff --git a/docs/examples/databases/get-attribute.md b/docs/examples/databases/get-attribute.md index 0a61052..8316fe7 100644 --- a/docs/examples/databases/get-attribute.md +++ b/docs/examples/databases/get-attribute.md @@ -1,14 +1,14 @@ from appwrite.client import Client -from appwrite.services.databases import Databases 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 -) +client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint +client.set_project('5df5acd0d48c2') # Your project ID +client.set_key('919c2d18fb5d4...a2ae413da83346ad2') # Your secret API key databases = Databases(client) -result = databases.get_attribute('[DATABASE_ID]', '[COLLECTION_ID]', '') +result = databases.get_attribute( + database_id = '', + collection_id = '', + key = '' +) diff --git a/docs/examples/databases/get-collection.md b/docs/examples/databases/get-collection.md index 90f57a3..7b0c7e4 100644 --- a/docs/examples/databases/get-collection.md +++ b/docs/examples/databases/get-collection.md @@ -1,14 +1,13 @@ from appwrite.client import Client -from appwrite.services.databases import Databases 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 -) +client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint +client.set_project('5df5acd0d48c2') # Your project ID +client.set_key('919c2d18fb5d4...a2ae413da83346ad2') # Your secret API key databases = Databases(client) -result = databases.get_collection('[DATABASE_ID]', '[COLLECTION_ID]') +result = databases.get_collection( + database_id = '', + collection_id = '' +) diff --git a/docs/examples/databases/get-document.md b/docs/examples/databases/get-document.md index 7085384..978c5a5 100644 --- a/docs/examples/databases/get-document.md +++ b/docs/examples/databases/get-document.md @@ -1,14 +1,15 @@ from appwrite.client import Client -from appwrite.services.databases import Databases 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 -) +client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint +client.set_project('5df5acd0d48c2') # Your project ID +client.set_session('') # The user session to authenticate with databases = Databases(client) -result = databases.get_document('[DATABASE_ID]', '[COLLECTION_ID]', '[DOCUMENT_ID]') +result = databases.get_document( + database_id = '', + collection_id = '', + document_id = '', + queries = [] # optional +) diff --git a/docs/examples/databases/get-index.md b/docs/examples/databases/get-index.md index 3213c66..e53878c 100644 --- a/docs/examples/databases/get-index.md +++ b/docs/examples/databases/get-index.md @@ -1,14 +1,14 @@ from appwrite.client import Client -from appwrite.services.databases import Databases 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 -) +client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint +client.set_project('5df5acd0d48c2') # Your project ID +client.set_key('919c2d18fb5d4...a2ae413da83346ad2') # Your secret API key databases = Databases(client) -result = databases.get_index('[DATABASE_ID]', '[COLLECTION_ID]', '') +result = databases.get_index( + database_id = '', + collection_id = '', + key = '' +) diff --git a/docs/examples/databases/get.md b/docs/examples/databases/get.md index 93a46b3..b12f7d8 100644 --- a/docs/examples/databases/get.md +++ b/docs/examples/databases/get.md @@ -1,14 +1,12 @@ from appwrite.client import Client -from appwrite.services.databases import Databases 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 -) +client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint +client.set_project('5df5acd0d48c2') # Your project ID +client.set_key('919c2d18fb5d4...a2ae413da83346ad2') # Your secret API key databases = Databases(client) -result = databases.get('[DATABASE_ID]') +result = databases.get( + database_id = '' +) diff --git a/docs/examples/databases/list-attributes.md b/docs/examples/databases/list-attributes.md index 632202c..4628394 100644 --- a/docs/examples/databases/list-attributes.md +++ b/docs/examples/databases/list-attributes.md @@ -1,14 +1,14 @@ from appwrite.client import Client -from appwrite.services.databases import Databases 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 -) +client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint +client.set_project('5df5acd0d48c2') # Your project ID +client.set_key('919c2d18fb5d4...a2ae413da83346ad2') # Your secret API key databases = Databases(client) -result = databases.list_attributes('[DATABASE_ID]', '[COLLECTION_ID]') +result = databases.list_attributes( + database_id = '', + collection_id = '', + queries = [] # optional +) diff --git a/docs/examples/databases/list-collections.md b/docs/examples/databases/list-collections.md index d0c98da..0ceed95 100644 --- a/docs/examples/databases/list-collections.md +++ b/docs/examples/databases/list-collections.md @@ -1,14 +1,14 @@ from appwrite.client import Client -from appwrite.services.databases import Databases 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 -) +client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint +client.set_project('5df5acd0d48c2') # Your project ID +client.set_key('919c2d18fb5d4...a2ae413da83346ad2') # Your secret API key databases = Databases(client) -result = databases.list_collections('[DATABASE_ID]') +result = databases.list_collections( + database_id = '', + queries = [], # optional + search = '' # optional +) diff --git a/docs/examples/databases/list-documents.md b/docs/examples/databases/list-documents.md index 5eb03b2..08f3c89 100644 --- a/docs/examples/databases/list-documents.md +++ b/docs/examples/databases/list-documents.md @@ -1,14 +1,14 @@ from appwrite.client import Client -from appwrite.services.databases import Databases 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 -) +client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint +client.set_project('5df5acd0d48c2') # Your project ID +client.set_session('') # The user session to authenticate with databases = Databases(client) -result = databases.list_documents('[DATABASE_ID]', '[COLLECTION_ID]') +result = databases.list_documents( + database_id = '', + collection_id = '', + queries = [] # optional +) diff --git a/docs/examples/databases/list-indexes.md b/docs/examples/databases/list-indexes.md index b4224be..05a9e15 100644 --- a/docs/examples/databases/list-indexes.md +++ b/docs/examples/databases/list-indexes.md @@ -1,14 +1,14 @@ from appwrite.client import Client -from appwrite.services.databases import Databases 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 -) +client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint +client.set_project('5df5acd0d48c2') # Your project ID +client.set_key('919c2d18fb5d4...a2ae413da83346ad2') # Your secret API key databases = Databases(client) -result = databases.list_indexes('[DATABASE_ID]', '[COLLECTION_ID]') +result = databases.list_indexes( + database_id = '', + collection_id = '', + queries = [] # optional +) diff --git a/docs/examples/databases/list.md b/docs/examples/databases/list.md index 3aa6839..8ba8b28 100644 --- a/docs/examples/databases/list.md +++ b/docs/examples/databases/list.md @@ -1,14 +1,13 @@ from appwrite.client import Client -from appwrite.services.databases import Databases 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 -) +client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint +client.set_project('5df5acd0d48c2') # Your project ID +client.set_key('919c2d18fb5d4...a2ae413da83346ad2') # Your secret API key databases = Databases(client) -result = databases.list() +result = databases.list( + queries = [], # optional + search = '' # optional +) diff --git a/docs/examples/databases/update-boolean-attribute.md b/docs/examples/databases/update-boolean-attribute.md index e6a7d55..8cf9bc8 100644 --- a/docs/examples/databases/update-boolean-attribute.md +++ b/docs/examples/databases/update-boolean-attribute.md @@ -1,14 +1,16 @@ from appwrite.client import Client -from appwrite.services.databases import Databases 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 -) +client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint +client.set_project('5df5acd0d48c2') # Your project ID +client.set_key('919c2d18fb5d4...a2ae413da83346ad2') # Your secret API key databases = Databases(client) -result = databases.update_boolean_attribute('[DATABASE_ID]', '[COLLECTION_ID]', '', False, False) +result = databases.update_boolean_attribute( + database_id = '', + collection_id = '', + key = '', + required = False, + default = False +) diff --git a/docs/examples/databases/update-collection.md b/docs/examples/databases/update-collection.md index 4a38aab..9f0615f 100644 --- a/docs/examples/databases/update-collection.md +++ b/docs/examples/databases/update-collection.md @@ -1,14 +1,17 @@ from appwrite.client import Client -from appwrite.services.databases import Databases 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 -) +client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint +client.set_project('5df5acd0d48c2') # Your project ID +client.set_key('919c2d18fb5d4...a2ae413da83346ad2') # Your secret API key databases = Databases(client) -result = databases.update_collection('[DATABASE_ID]', '[COLLECTION_ID]', '[NAME]') +result = databases.update_collection( + database_id = '', + collection_id = '', + name = '', + permissions = ["read("any")"], # optional + document_security = False, # optional + enabled = False # optional +) diff --git a/docs/examples/databases/update-datetime-attribute.md b/docs/examples/databases/update-datetime-attribute.md index 5c79257..5541dd4 100644 --- a/docs/examples/databases/update-datetime-attribute.md +++ b/docs/examples/databases/update-datetime-attribute.md @@ -1,14 +1,16 @@ from appwrite.client import Client -from appwrite.services.databases import Databases 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 -) +client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint +client.set_project('5df5acd0d48c2') # Your project ID +client.set_key('919c2d18fb5d4...a2ae413da83346ad2') # Your secret API key databases = Databases(client) -result = databases.update_datetime_attribute('[DATABASE_ID]', '[COLLECTION_ID]', '', False, '') +result = databases.update_datetime_attribute( + database_id = '', + collection_id = '', + key = '', + required = False, + default = '' +) diff --git a/docs/examples/databases/update-document.md b/docs/examples/databases/update-document.md index c768c54..37c1b43 100644 --- a/docs/examples/databases/update-document.md +++ b/docs/examples/databases/update-document.md @@ -1,14 +1,16 @@ from appwrite.client import Client -from appwrite.services.databases import Databases 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 -) +client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint +client.set_project('5df5acd0d48c2') # Your project ID +client.set_session('') # The user session to authenticate with databases = Databases(client) -result = databases.update_document('[DATABASE_ID]', '[COLLECTION_ID]', '[DOCUMENT_ID]') +result = databases.update_document( + database_id = '', + collection_id = '', + document_id = '', + data = {}, # optional + permissions = ["read("any")"] # optional +) diff --git a/docs/examples/databases/update-email-attribute.md b/docs/examples/databases/update-email-attribute.md index 8148b01..cedde9d 100644 --- a/docs/examples/databases/update-email-attribute.md +++ b/docs/examples/databases/update-email-attribute.md @@ -1,14 +1,16 @@ from appwrite.client import Client -from appwrite.services.databases import Databases 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 -) +client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint +client.set_project('5df5acd0d48c2') # Your project ID +client.set_key('919c2d18fb5d4...a2ae413da83346ad2') # Your secret API key databases = Databases(client) -result = databases.update_email_attribute('[DATABASE_ID]', '[COLLECTION_ID]', '', False, 'email@example.com') +result = databases.update_email_attribute( + database_id = '', + collection_id = '', + key = '', + required = False, + default = 'email@example.com' +) diff --git a/docs/examples/databases/update-enum-attribute.md b/docs/examples/databases/update-enum-attribute.md index 65ef26f..76ede75 100644 --- a/docs/examples/databases/update-enum-attribute.md +++ b/docs/examples/databases/update-enum-attribute.md @@ -1,14 +1,17 @@ from appwrite.client import Client -from appwrite.services.databases import Databases 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 -) +client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint +client.set_project('5df5acd0d48c2') # Your project ID +client.set_key('919c2d18fb5d4...a2ae413da83346ad2') # Your secret API key databases = Databases(client) -result = databases.update_enum_attribute('[DATABASE_ID]', '[COLLECTION_ID]', '', [], False, '[DEFAULT]') +result = databases.update_enum_attribute( + database_id = '', + collection_id = '', + key = '', + elements = [], + required = False, + default = '' +) diff --git a/docs/examples/databases/update-float-attribute.md b/docs/examples/databases/update-float-attribute.md index efbf1ad..1556e03 100644 --- a/docs/examples/databases/update-float-attribute.md +++ b/docs/examples/databases/update-float-attribute.md @@ -1,14 +1,18 @@ from appwrite.client import Client -from appwrite.services.databases import Databases 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 -) +client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint +client.set_project('5df5acd0d48c2') # Your project ID +client.set_key('919c2d18fb5d4...a2ae413da83346ad2') # Your secret API key databases = Databases(client) -result = databases.update_float_attribute('[DATABASE_ID]', '[COLLECTION_ID]', '', False, None, None, None) +result = databases.update_float_attribute( + database_id = '', + collection_id = '', + key = '', + required = False, + min = None, + max = None, + default = None +) diff --git a/docs/examples/databases/update-integer-attribute.md b/docs/examples/databases/update-integer-attribute.md index 61c74b8..37a87ed 100644 --- a/docs/examples/databases/update-integer-attribute.md +++ b/docs/examples/databases/update-integer-attribute.md @@ -1,14 +1,18 @@ from appwrite.client import Client -from appwrite.services.databases import Databases 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 -) +client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint +client.set_project('5df5acd0d48c2') # Your project ID +client.set_key('919c2d18fb5d4...a2ae413da83346ad2') # Your secret API key databases = Databases(client) -result = databases.update_integer_attribute('[DATABASE_ID]', '[COLLECTION_ID]', '', False, None, None, None) +result = databases.update_integer_attribute( + database_id = '', + collection_id = '', + key = '', + required = False, + min = None, + max = None, + default = None +) diff --git a/docs/examples/databases/update-ip-attribute.md b/docs/examples/databases/update-ip-attribute.md index 7d5a35d..d6df600 100644 --- a/docs/examples/databases/update-ip-attribute.md +++ b/docs/examples/databases/update-ip-attribute.md @@ -1,14 +1,16 @@ from appwrite.client import Client -from appwrite.services.databases import Databases 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 -) +client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint +client.set_project('5df5acd0d48c2') # Your project ID +client.set_key('919c2d18fb5d4...a2ae413da83346ad2') # Your secret API key databases = Databases(client) -result = databases.update_ip_attribute('[DATABASE_ID]', '[COLLECTION_ID]', '', False, '') +result = databases.update_ip_attribute( + database_id = '', + collection_id = '', + key = '', + required = False, + default = '' +) diff --git a/docs/examples/databases/update-relationship-attribute.md b/docs/examples/databases/update-relationship-attribute.md index 7c426a6..8c9fb45 100644 --- a/docs/examples/databases/update-relationship-attribute.md +++ b/docs/examples/databases/update-relationship-attribute.md @@ -1,14 +1,15 @@ from appwrite.client import Client -from appwrite.services.databases import Databases 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 -) +client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint +client.set_project('5df5acd0d48c2') # Your project ID +client.set_key('919c2d18fb5d4...a2ae413da83346ad2') # Your secret API key databases = Databases(client) -result = databases.update_relationship_attribute('[DATABASE_ID]', '[COLLECTION_ID]', '') +result = databases.update_relationship_attribute( + database_id = '', + collection_id = '', + key = '', + on_delete = RelationMutate.CASCADE # optional +) diff --git a/docs/examples/databases/update-string-attribute.md b/docs/examples/databases/update-string-attribute.md index 2ee236e..d765acf 100644 --- a/docs/examples/databases/update-string-attribute.md +++ b/docs/examples/databases/update-string-attribute.md @@ -1,14 +1,16 @@ from appwrite.client import Client -from appwrite.services.databases import Databases 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 -) +client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint +client.set_project('5df5acd0d48c2') # Your project ID +client.set_key('919c2d18fb5d4...a2ae413da83346ad2') # Your secret API key databases = Databases(client) -result = databases.update_string_attribute('[DATABASE_ID]', '[COLLECTION_ID]', '', False, '[DEFAULT]') +result = databases.update_string_attribute( + database_id = '', + collection_id = '', + key = '', + required = False, + default = '' +) diff --git a/docs/examples/databases/update-url-attribute.md b/docs/examples/databases/update-url-attribute.md index 119c787..3a6347c 100644 --- a/docs/examples/databases/update-url-attribute.md +++ b/docs/examples/databases/update-url-attribute.md @@ -1,14 +1,16 @@ from appwrite.client import Client -from appwrite.services.databases import Databases 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 -) +client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint +client.set_project('5df5acd0d48c2') # Your project ID +client.set_key('919c2d18fb5d4...a2ae413da83346ad2') # Your secret API key databases = Databases(client) -result = databases.update_url_attribute('[DATABASE_ID]', '[COLLECTION_ID]', '', False, 'https://example.com') +result = databases.update_url_attribute( + database_id = '', + collection_id = '', + key = '', + required = False, + default = 'https://example.com' +) diff --git a/docs/examples/databases/update.md b/docs/examples/databases/update.md index d46692e..ab6227f 100644 --- a/docs/examples/databases/update.md +++ b/docs/examples/databases/update.md @@ -1,14 +1,14 @@ from appwrite.client import Client -from appwrite.services.databases import Databases 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 -) +client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint +client.set_project('5df5acd0d48c2') # Your project ID +client.set_key('919c2d18fb5d4...a2ae413da83346ad2') # Your secret API key databases = Databases(client) -result = databases.update('[DATABASE_ID]', '[NAME]') +result = databases.update( + database_id = '', + name = '', + enabled = False # optional +) diff --git a/docs/examples/functions/create-build.md b/docs/examples/functions/create-build.md index 76888f8..f3422f3 100644 --- a/docs/examples/functions/create-build.md +++ b/docs/examples/functions/create-build.md @@ -1,14 +1,14 @@ from appwrite.client import Client -from appwrite.services.functions import Functions 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 -) +client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint +client.set_project('5df5acd0d48c2') # Your project ID +client.set_key('919c2d18fb5d4...a2ae413da83346ad2') # Your secret API key functions = Functions(client) -result = functions.create_build('[FUNCTION_ID]', '[DEPLOYMENT_ID]', '[BUILD_ID]') +result = functions.create_build( + function_id = '', + deployment_id = '', + build_id = '' +) diff --git a/docs/examples/functions/create-deployment.md b/docs/examples/functions/create-deployment.md index 1ee1be0..68ae7a9 100644 --- a/docs/examples/functions/create-deployment.md +++ b/docs/examples/functions/create-deployment.md @@ -1,15 +1,17 @@ from appwrite.client import Client from appwrite.input_file import InputFile -from appwrite.services.functions import Functions 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 -) +client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint +client.set_project('5df5acd0d48c2') # Your project ID +client.set_key('919c2d18fb5d4...a2ae413da83346ad2') # Your secret API key functions = Functions(client) -result = functions.create_deployment('[FUNCTION_ID]', InputFile.from_path('file.png'), False) +result = functions.create_deployment( + function_id = '', + code = InputFile.from_path('file.png'), + activate = False, + entrypoint = '', # optional + commands = '' # optional +) diff --git a/docs/examples/functions/create-execution.md b/docs/examples/functions/create-execution.md index 7c04522..46c64b2 100644 --- a/docs/examples/functions/create-execution.md +++ b/docs/examples/functions/create-execution.md @@ -1,14 +1,17 @@ from appwrite.client import Client -from appwrite.services.functions import Functions 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 -) +client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint +client.set_project('5df5acd0d48c2') # Your project ID +client.set_session('') # The user session to authenticate with functions = Functions(client) -result = functions.create_execution('[FUNCTION_ID]') +result = functions.create_execution( + function_id = '', + body = '', # optional + async = False, # optional + path = '', # optional + method = ExecutionMethod.GET, # optional + headers = {} # optional +) diff --git a/docs/examples/functions/create-variable.md b/docs/examples/functions/create-variable.md index f33ed08..6b4e955 100644 --- a/docs/examples/functions/create-variable.md +++ b/docs/examples/functions/create-variable.md @@ -1,14 +1,14 @@ from appwrite.client import Client -from appwrite.services.functions import Functions 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 -) +client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint +client.set_project('5df5acd0d48c2') # Your project ID +client.set_key('919c2d18fb5d4...a2ae413da83346ad2') # Your secret API key functions = Functions(client) -result = functions.create_variable('[FUNCTION_ID]', '[KEY]', '[VALUE]') +result = functions.create_variable( + function_id = '', + key = '', + value = '' +) diff --git a/docs/examples/functions/create.md b/docs/examples/functions/create.md index bf66396..76320c2 100644 --- a/docs/examples/functions/create.md +++ b/docs/examples/functions/create.md @@ -1,14 +1,32 @@ from appwrite.client import Client -from appwrite.services.functions import Functions +from appwrite.enums import 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 -) +client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint +client.set_project('5df5acd0d48c2') # Your project ID +client.set_key('919c2d18fb5d4...a2ae413da83346ad2') # Your secret API key functions = Functions(client) -result = functions.create('[FUNCTION_ID]', '[NAME]', 'node-18.0') +result = functions.create( + function_id = '', + name = '', + runtime = .NODE_14_5, + execute = ["any"], # optional + events = [], # optional + schedule = '', # optional + timeout = 1, # optional + enabled = False, # optional + logging = False, # optional + entrypoint = '', # optional + commands = '', # optional + installation_id = '', # optional + provider_repository_id = '', # optional + provider_branch = '', # optional + provider_silent_mode = False, # optional + provider_root_directory = '', # optional + template_repository = '', # optional + template_owner = '', # optional + template_root_directory = '', # optional + template_branch = '' # optional +) diff --git a/docs/examples/functions/delete-deployment.md b/docs/examples/functions/delete-deployment.md index 42d526e..def007b 100644 --- a/docs/examples/functions/delete-deployment.md +++ b/docs/examples/functions/delete-deployment.md @@ -1,14 +1,13 @@ from appwrite.client import Client -from appwrite.services.functions import Functions 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 -) +client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint +client.set_project('5df5acd0d48c2') # Your project ID +client.set_key('919c2d18fb5d4...a2ae413da83346ad2') # Your secret API key functions = Functions(client) -result = functions.delete_deployment('[FUNCTION_ID]', '[DEPLOYMENT_ID]') +result = functions.delete_deployment( + function_id = '', + deployment_id = '' +) diff --git a/docs/examples/functions/delete-variable.md b/docs/examples/functions/delete-variable.md index cae0f2d..96f1304 100644 --- a/docs/examples/functions/delete-variable.md +++ b/docs/examples/functions/delete-variable.md @@ -1,14 +1,13 @@ from appwrite.client import Client -from appwrite.services.functions import Functions 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 -) +client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint +client.set_project('5df5acd0d48c2') # Your project ID +client.set_key('919c2d18fb5d4...a2ae413da83346ad2') # Your secret API key functions = Functions(client) -result = functions.delete_variable('[FUNCTION_ID]', '[VARIABLE_ID]') +result = functions.delete_variable( + function_id = '', + variable_id = '' +) diff --git a/docs/examples/functions/delete.md b/docs/examples/functions/delete.md index e89213e..7e20857 100644 --- a/docs/examples/functions/delete.md +++ b/docs/examples/functions/delete.md @@ -1,14 +1,12 @@ from appwrite.client import Client -from appwrite.services.functions import Functions 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 -) +client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint +client.set_project('5df5acd0d48c2') # Your project ID +client.set_key('919c2d18fb5d4...a2ae413da83346ad2') # Your secret API key functions = Functions(client) -result = functions.delete('[FUNCTION_ID]') +result = functions.delete( + function_id = '' +) diff --git a/docs/examples/functions/download-deployment.md b/docs/examples/functions/download-deployment.md index ee51f67..91c1fac 100644 --- a/docs/examples/functions/download-deployment.md +++ b/docs/examples/functions/download-deployment.md @@ -1,14 +1,13 @@ from appwrite.client import Client -from appwrite.services.functions import Functions 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 -) +client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint +client.set_project('5df5acd0d48c2') # Your project ID +client.set_key('919c2d18fb5d4...a2ae413da83346ad2') # Your secret API key functions = Functions(client) -result = functions.download_deployment('[FUNCTION_ID]', '[DEPLOYMENT_ID]') +result = functions.download_deployment( + function_id = '', + deployment_id = '' +) diff --git a/docs/examples/functions/get-deployment.md b/docs/examples/functions/get-deployment.md index 6257b59..e2b8e3f 100644 --- a/docs/examples/functions/get-deployment.md +++ b/docs/examples/functions/get-deployment.md @@ -1,14 +1,13 @@ from appwrite.client import Client -from appwrite.services.functions import Functions 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 -) +client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint +client.set_project('5df5acd0d48c2') # Your project ID +client.set_key('919c2d18fb5d4...a2ae413da83346ad2') # Your secret API key functions = Functions(client) -result = functions.get_deployment('[FUNCTION_ID]', '[DEPLOYMENT_ID]') +result = functions.get_deployment( + function_id = '', + deployment_id = '' +) diff --git a/docs/examples/functions/get-execution.md b/docs/examples/functions/get-execution.md index f0e4f0d..04be41b 100644 --- a/docs/examples/functions/get-execution.md +++ b/docs/examples/functions/get-execution.md @@ -1,14 +1,13 @@ from appwrite.client import Client -from appwrite.services.functions import Functions 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 -) +client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint +client.set_project('5df5acd0d48c2') # Your project ID +client.set_session('') # The user session to authenticate with functions = Functions(client) -result = functions.get_execution('[FUNCTION_ID]', '[EXECUTION_ID]') +result = functions.get_execution( + function_id = '', + execution_id = '' +) diff --git a/docs/examples/functions/get-variable.md b/docs/examples/functions/get-variable.md index 4e71bff..2115700 100644 --- a/docs/examples/functions/get-variable.md +++ b/docs/examples/functions/get-variable.md @@ -1,14 +1,13 @@ from appwrite.client import Client -from appwrite.services.functions import Functions 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 -) +client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint +client.set_project('5df5acd0d48c2') # Your project ID +client.set_key('919c2d18fb5d4...a2ae413da83346ad2') # Your secret API key functions = Functions(client) -result = functions.get_variable('[FUNCTION_ID]', '[VARIABLE_ID]') +result = functions.get_variable( + function_id = '', + variable_id = '' +) diff --git a/docs/examples/functions/get.md b/docs/examples/functions/get.md index 30e1d59..f630486 100644 --- a/docs/examples/functions/get.md +++ b/docs/examples/functions/get.md @@ -1,14 +1,12 @@ from appwrite.client import Client -from appwrite.services.functions import Functions 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 -) +client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint +client.set_project('5df5acd0d48c2') # Your project ID +client.set_key('919c2d18fb5d4...a2ae413da83346ad2') # Your secret API key functions = Functions(client) -result = functions.get('[FUNCTION_ID]') +result = functions.get( + function_id = '' +) diff --git a/docs/examples/functions/list-deployments.md b/docs/examples/functions/list-deployments.md index d1797a1..c681463 100644 --- a/docs/examples/functions/list-deployments.md +++ b/docs/examples/functions/list-deployments.md @@ -1,14 +1,14 @@ from appwrite.client import Client -from appwrite.services.functions import Functions 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 -) +client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint +client.set_project('5df5acd0d48c2') # Your project ID +client.set_key('919c2d18fb5d4...a2ae413da83346ad2') # Your secret API key functions = Functions(client) -result = functions.list_deployments('[FUNCTION_ID]') +result = functions.list_deployments( + function_id = '', + queries = [], # optional + search = '' # optional +) diff --git a/docs/examples/functions/list-executions.md b/docs/examples/functions/list-executions.md index d70f004..50dc7cb 100644 --- a/docs/examples/functions/list-executions.md +++ b/docs/examples/functions/list-executions.md @@ -1,14 +1,14 @@ from appwrite.client import Client -from appwrite.services.functions import Functions 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 -) +client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint +client.set_project('5df5acd0d48c2') # Your project ID +client.set_session('') # The user session to authenticate with functions = Functions(client) -result = functions.list_executions('[FUNCTION_ID]') +result = functions.list_executions( + function_id = '', + queries = [], # optional + search = '' # optional +) diff --git a/docs/examples/functions/list-runtimes.md b/docs/examples/functions/list-runtimes.md index 19b85e2..ae64245 100644 --- a/docs/examples/functions/list-runtimes.md +++ b/docs/examples/functions/list-runtimes.md @@ -1,13 +1,9 @@ from appwrite.client import Client -from appwrite.services.functions import Functions 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 -) +client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint +client.set_project('5df5acd0d48c2') # Your project ID +client.set_key('919c2d18fb5d4...a2ae413da83346ad2') # Your secret API key functions = Functions(client) diff --git a/docs/examples/functions/list-variables.md b/docs/examples/functions/list-variables.md index 9a72bba..cfd0b64 100644 --- a/docs/examples/functions/list-variables.md +++ b/docs/examples/functions/list-variables.md @@ -1,14 +1,12 @@ from appwrite.client import Client -from appwrite.services.functions import Functions 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 -) +client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint +client.set_project('5df5acd0d48c2') # Your project ID +client.set_key('919c2d18fb5d4...a2ae413da83346ad2') # Your secret API key functions = Functions(client) -result = functions.list_variables('[FUNCTION_ID]') +result = functions.list_variables( + function_id = '' +) diff --git a/docs/examples/functions/list.md b/docs/examples/functions/list.md index b8442e5..bc4fc21 100644 --- a/docs/examples/functions/list.md +++ b/docs/examples/functions/list.md @@ -1,14 +1,13 @@ from appwrite.client import Client -from appwrite.services.functions import Functions 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 -) +client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint +client.set_project('5df5acd0d48c2') # Your project ID +client.set_key('919c2d18fb5d4...a2ae413da83346ad2') # Your secret API key functions = Functions(client) -result = functions.list() +result = functions.list( + queries = [], # optional + search = '' # optional +) diff --git a/docs/examples/functions/update-deployment.md b/docs/examples/functions/update-deployment.md index 87dd097..59e183e 100644 --- a/docs/examples/functions/update-deployment.md +++ b/docs/examples/functions/update-deployment.md @@ -1,14 +1,13 @@ from appwrite.client import Client -from appwrite.services.functions import Functions 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 -) +client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint +client.set_project('5df5acd0d48c2') # Your project ID +client.set_key('919c2d18fb5d4...a2ae413da83346ad2') # Your secret API key functions = Functions(client) -result = functions.update_deployment('[FUNCTION_ID]', '[DEPLOYMENT_ID]') +result = functions.update_deployment( + function_id = '', + deployment_id = '' +) diff --git a/docs/examples/functions/update-variable.md b/docs/examples/functions/update-variable.md index ab5b43a..3fb73e0 100644 --- a/docs/examples/functions/update-variable.md +++ b/docs/examples/functions/update-variable.md @@ -1,14 +1,15 @@ from appwrite.client import Client -from appwrite.services.functions import Functions 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 -) +client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint +client.set_project('5df5acd0d48c2') # Your project ID +client.set_key('919c2d18fb5d4...a2ae413da83346ad2') # Your secret API key functions = Functions(client) -result = functions.update_variable('[FUNCTION_ID]', '[VARIABLE_ID]', '[KEY]') +result = functions.update_variable( + function_id = '', + variable_id = '', + key = '', + value = '' # optional +) diff --git a/docs/examples/functions/update.md b/docs/examples/functions/update.md index 3960054..edc1b0c 100644 --- a/docs/examples/functions/update.md +++ b/docs/examples/functions/update.md @@ -1,14 +1,27 @@ from appwrite.client import Client -from appwrite.services.functions import Functions 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 -) +client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint +client.set_project('5df5acd0d48c2') # Your project ID +client.set_key('919c2d18fb5d4...a2ae413da83346ad2') # Your secret API key functions = Functions(client) -result = functions.update('[FUNCTION_ID]', '[NAME]') +result = functions.update( + function_id = '', + name = '', + runtime = .NODE_14_5, # optional + execute = ["any"], # optional + events = [], # optional + schedule = '', # optional + timeout = 1, # optional + enabled = False, # optional + logging = False, # optional + entrypoint = '', # optional + commands = '', # optional + installation_id = '', # optional + provider_repository_id = '', # optional + provider_branch = '', # optional + provider_silent_mode = False, # optional + provider_root_directory = '' # optional +) diff --git a/docs/examples/graphql/mutation.md b/docs/examples/graphql/mutation.md index 24226a5..3d9ad02 100644 --- a/docs/examples/graphql/mutation.md +++ b/docs/examples/graphql/mutation.md @@ -1,14 +1,12 @@ from appwrite.client import Client -from appwrite.services.graphql import Graphql 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 -) +client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint +client.set_project('5df5acd0d48c2') # Your project ID +client.set_key('919c2d18fb5d4...a2ae413da83346ad2') # Your secret API key graphql = Graphql(client) -result = graphql.mutation({}) +result = graphql.mutation( + query = {} +) diff --git a/docs/examples/graphql/query.md b/docs/examples/graphql/query.md index 8e1597c..deb07a8 100644 --- a/docs/examples/graphql/query.md +++ b/docs/examples/graphql/query.md @@ -1,14 +1,12 @@ from appwrite.client import Client -from appwrite.services.graphql import Graphql 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 -) +client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint +client.set_project('5df5acd0d48c2') # Your project ID +client.set_key('919c2d18fb5d4...a2ae413da83346ad2') # Your secret API key graphql = Graphql(client) -result = graphql.query({}) +result = graphql.query( + query = {} +) diff --git a/docs/examples/health/get-antivirus.md b/docs/examples/health/get-antivirus.md index fbfaf0e..5ba2199 100644 --- a/docs/examples/health/get-antivirus.md +++ b/docs/examples/health/get-antivirus.md @@ -1,13 +1,9 @@ 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 -) +client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint +client.set_project('5df5acd0d48c2') # Your project ID +client.set_key('919c2d18fb5d4...a2ae413da83346ad2') # Your secret API key health = Health(client) diff --git a/docs/examples/health/get-cache.md b/docs/examples/health/get-cache.md index 40bc010..02b85b3 100644 --- a/docs/examples/health/get-cache.md +++ b/docs/examples/health/get-cache.md @@ -1,13 +1,9 @@ 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 -) +client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint +client.set_project('5df5acd0d48c2') # Your project ID +client.set_key('919c2d18fb5d4...a2ae413da83346ad2') # Your secret API key health = Health(client) diff --git a/docs/examples/health/get-certificate.md b/docs/examples/health/get-certificate.md new file mode 100644 index 0000000..83018cf --- /dev/null +++ b/docs/examples/health/get-certificate.md @@ -0,0 +1,12 @@ +from appwrite.client import Client + +client = Client() +client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint +client.set_project('5df5acd0d48c2') # Your project ID +client.set_key('919c2d18fb5d4...a2ae413da83346ad2') # Your secret API key + +health = Health(client) + +result = health.get_certificate( + domain = '' # optional +) diff --git a/docs/examples/health/get-d-b.md b/docs/examples/health/get-d-b.md index 803dd73..5446df5 100644 --- a/docs/examples/health/get-d-b.md +++ b/docs/examples/health/get-d-b.md @@ -1,13 +1,9 @@ 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 -) +client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint +client.set_project('5df5acd0d48c2') # Your project ID +client.set_key('919c2d18fb5d4...a2ae413da83346ad2') # Your secret API key health = Health(client) diff --git a/docs/examples/health/get-failed-jobs.md b/docs/examples/health/get-failed-jobs.md new file mode 100644 index 0000000..ad9f88c --- /dev/null +++ b/docs/examples/health/get-failed-jobs.md @@ -0,0 +1,14 @@ +from appwrite.client import Client +from appwrite.enums import + +client = Client() +client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint +client.set_project('5df5acd0d48c2') # Your project ID +client.set_key('919c2d18fb5d4...a2ae413da83346ad2') # Your secret API key + +health = Health(client) + +result = health.get_failed_jobs( + name = .V1_DATABASE, + threshold = None # optional +) diff --git a/docs/examples/health/get-pub-sub.md b/docs/examples/health/get-pub-sub.md index 43ada69..84ffd97 100644 --- a/docs/examples/health/get-pub-sub.md +++ b/docs/examples/health/get-pub-sub.md @@ -1,13 +1,9 @@ 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 -) +client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint +client.set_project('5df5acd0d48c2') # Your project ID +client.set_key('919c2d18fb5d4...a2ae413da83346ad2') # Your secret API key health = Health(client) diff --git a/docs/examples/health/get-queue-builds.md b/docs/examples/health/get-queue-builds.md index 3170559..b513c2c 100644 --- a/docs/examples/health/get-queue-builds.md +++ b/docs/examples/health/get-queue-builds.md @@ -1,14 +1,12 @@ 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 -) +client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint +client.set_project('5df5acd0d48c2') # Your project ID +client.set_key('919c2d18fb5d4...a2ae413da83346ad2') # Your secret API key health = Health(client) -result = health.get_queue_builds() +result = health.get_queue_builds( + threshold = None # optional +) diff --git a/docs/examples/health/get-queue-certificates.md b/docs/examples/health/get-queue-certificates.md index 4fb0266..bbeece1 100644 --- a/docs/examples/health/get-queue-certificates.md +++ b/docs/examples/health/get-queue-certificates.md @@ -1,14 +1,12 @@ 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 -) +client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint +client.set_project('5df5acd0d48c2') # Your project ID +client.set_key('919c2d18fb5d4...a2ae413da83346ad2') # Your secret API key health = Health(client) -result = health.get_queue_certificates() +result = health.get_queue_certificates( + threshold = None # optional +) diff --git a/docs/examples/health/get-queue-databases.md b/docs/examples/health/get-queue-databases.md index 4faff96..936266c 100644 --- a/docs/examples/health/get-queue-databases.md +++ b/docs/examples/health/get-queue-databases.md @@ -1,14 +1,13 @@ 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 -) +client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint +client.set_project('5df5acd0d48c2') # Your project ID +client.set_key('919c2d18fb5d4...a2ae413da83346ad2') # Your secret API key health = Health(client) -result = health.get_queue_databases() +result = health.get_queue_databases( + name = '', # optional + threshold = None # optional +) diff --git a/docs/examples/health/get-queue-deletes.md b/docs/examples/health/get-queue-deletes.md index c84b9be..b39b445 100644 --- a/docs/examples/health/get-queue-deletes.md +++ b/docs/examples/health/get-queue-deletes.md @@ -1,14 +1,12 @@ 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 -) +client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint +client.set_project('5df5acd0d48c2') # Your project ID +client.set_key('919c2d18fb5d4...a2ae413da83346ad2') # Your secret API key health = Health(client) -result = health.get_queue_deletes() +result = health.get_queue_deletes( + threshold = None # optional +) diff --git a/docs/examples/health/get-queue-functions.md b/docs/examples/health/get-queue-functions.md index 92e4e20..a989a6a 100644 --- a/docs/examples/health/get-queue-functions.md +++ b/docs/examples/health/get-queue-functions.md @@ -1,14 +1,12 @@ 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 -) +client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint +client.set_project('5df5acd0d48c2') # Your project ID +client.set_key('919c2d18fb5d4...a2ae413da83346ad2') # Your secret API key health = Health(client) -result = health.get_queue_functions() +result = health.get_queue_functions( + threshold = None # optional +) diff --git a/docs/examples/health/get-queue-logs.md b/docs/examples/health/get-queue-logs.md index b798ad7..47a56f7 100644 --- a/docs/examples/health/get-queue-logs.md +++ b/docs/examples/health/get-queue-logs.md @@ -1,14 +1,12 @@ 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 -) +client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint +client.set_project('5df5acd0d48c2') # Your project ID +client.set_key('919c2d18fb5d4...a2ae413da83346ad2') # Your secret API key health = Health(client) -result = health.get_queue_logs() +result = health.get_queue_logs( + threshold = None # optional +) diff --git a/docs/examples/health/get-queue-mails.md b/docs/examples/health/get-queue-mails.md index cc2c3bc..39fc879 100644 --- a/docs/examples/health/get-queue-mails.md +++ b/docs/examples/health/get-queue-mails.md @@ -1,14 +1,12 @@ 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 -) +client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint +client.set_project('5df5acd0d48c2') # Your project ID +client.set_key('919c2d18fb5d4...a2ae413da83346ad2') # Your secret API key health = Health(client) -result = health.get_queue_mails() +result = health.get_queue_mails( + threshold = None # optional +) diff --git a/docs/examples/health/get-queue-messaging.md b/docs/examples/health/get-queue-messaging.md index 95200f3..3862c9e 100644 --- a/docs/examples/health/get-queue-messaging.md +++ b/docs/examples/health/get-queue-messaging.md @@ -1,14 +1,12 @@ 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 -) +client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint +client.set_project('5df5acd0d48c2') # Your project ID +client.set_key('919c2d18fb5d4...a2ae413da83346ad2') # Your secret API key health = Health(client) -result = health.get_queue_messaging() +result = health.get_queue_messaging( + threshold = None # optional +) diff --git a/docs/examples/health/get-queue-migrations.md b/docs/examples/health/get-queue-migrations.md index 1c91663..85a5e56 100644 --- a/docs/examples/health/get-queue-migrations.md +++ b/docs/examples/health/get-queue-migrations.md @@ -1,14 +1,12 @@ 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 -) +client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint +client.set_project('5df5acd0d48c2') # Your project ID +client.set_key('919c2d18fb5d4...a2ae413da83346ad2') # Your secret API key health = Health(client) -result = health.get_queue_migrations() +result = health.get_queue_migrations( + threshold = None # optional +) diff --git a/docs/examples/health/get-queue-usage-dump.md b/docs/examples/health/get-queue-usage-dump.md new file mode 100644 index 0000000..2b8e302 --- /dev/null +++ b/docs/examples/health/get-queue-usage-dump.md @@ -0,0 +1,12 @@ +from appwrite.client import Client + +client = Client() +client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint +client.set_project('5df5acd0d48c2') # Your project ID +client.set_key('919c2d18fb5d4...a2ae413da83346ad2') # Your secret API key + +health = Health(client) + +result = health.get_queue_usage_dump( + threshold = None # optional +) diff --git a/docs/examples/health/get-queue-usage.md b/docs/examples/health/get-queue-usage.md new file mode 100644 index 0000000..42d7281 --- /dev/null +++ b/docs/examples/health/get-queue-usage.md @@ -0,0 +1,12 @@ +from appwrite.client import Client + +client = Client() +client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint +client.set_project('5df5acd0d48c2') # Your project ID +client.set_key('919c2d18fb5d4...a2ae413da83346ad2') # Your secret API key + +health = Health(client) + +result = health.get_queue_usage( + threshold = None # optional +) diff --git a/docs/examples/health/get-queue-webhooks.md b/docs/examples/health/get-queue-webhooks.md index 8406de1..435ba95 100644 --- a/docs/examples/health/get-queue-webhooks.md +++ b/docs/examples/health/get-queue-webhooks.md @@ -1,14 +1,12 @@ 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 -) +client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint +client.set_project('5df5acd0d48c2') # Your project ID +client.set_key('919c2d18fb5d4...a2ae413da83346ad2') # Your secret API key health = Health(client) -result = health.get_queue_webhooks() +result = health.get_queue_webhooks( + threshold = None # optional +) diff --git a/docs/examples/health/get-queue.md b/docs/examples/health/get-queue.md index 5a35588..81ea4ba 100644 --- a/docs/examples/health/get-queue.md +++ b/docs/examples/health/get-queue.md @@ -1,13 +1,9 @@ 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 -) +client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint +client.set_project('5df5acd0d48c2') # Your project ID +client.set_key('919c2d18fb5d4...a2ae413da83346ad2') # Your secret API key health = Health(client) diff --git a/docs/examples/health/get-storage-local.md b/docs/examples/health/get-storage-local.md index bb2533e..c262455 100644 --- a/docs/examples/health/get-storage-local.md +++ b/docs/examples/health/get-storage-local.md @@ -1,13 +1,9 @@ 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 -) +client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint +client.set_project('5df5acd0d48c2') # Your project ID +client.set_key('919c2d18fb5d4...a2ae413da83346ad2') # Your secret API key health = Health(client) diff --git a/docs/examples/health/get-storage.md b/docs/examples/health/get-storage.md new file mode 100644 index 0000000..ebe83ed --- /dev/null +++ b/docs/examples/health/get-storage.md @@ -0,0 +1,10 @@ +from appwrite.client import Client + +client = Client() +client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint +client.set_project('5df5acd0d48c2') # Your project ID +client.set_key('919c2d18fb5d4...a2ae413da83346ad2') # Your secret API key + +health = Health(client) + +result = health.get_storage() diff --git a/docs/examples/health/get-time.md b/docs/examples/health/get-time.md index 9fe313d..02405db 100644 --- a/docs/examples/health/get-time.md +++ b/docs/examples/health/get-time.md @@ -1,13 +1,9 @@ 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 -) +client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint +client.set_project('5df5acd0d48c2') # Your project ID +client.set_key('919c2d18fb5d4...a2ae413da83346ad2') # Your secret API key health = Health(client) diff --git a/docs/examples/health/get.md b/docs/examples/health/get.md index d3ff594..22034e7 100644 --- a/docs/examples/health/get.md +++ b/docs/examples/health/get.md @@ -1,13 +1,9 @@ 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 -) +client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint +client.set_project('5df5acd0d48c2') # Your project ID +client.set_key('919c2d18fb5d4...a2ae413da83346ad2') # Your secret API key health = Health(client) diff --git a/docs/examples/locale/get.md b/docs/examples/locale/get.md index 06b04f2..8915eb1 100644 --- a/docs/examples/locale/get.md +++ b/docs/examples/locale/get.md @@ -1,13 +1,9 @@ from appwrite.client import Client -from appwrite.services.locale import Locale 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 -) +client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint +client.set_project('5df5acd0d48c2') # Your project ID +client.set_session('') # The user session to authenticate with locale = Locale(client) diff --git a/docs/examples/locale/list-codes.md b/docs/examples/locale/list-codes.md index 3dc6cf8..9d2c939 100644 --- a/docs/examples/locale/list-codes.md +++ b/docs/examples/locale/list-codes.md @@ -1,13 +1,9 @@ from appwrite.client import Client -from appwrite.services.locale import Locale 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 -) +client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint +client.set_project('5df5acd0d48c2') # Your project ID +client.set_session('') # The user session to authenticate with locale = Locale(client) diff --git a/docs/examples/locale/list-continents.md b/docs/examples/locale/list-continents.md index ba9c94f..fadd5f3 100644 --- a/docs/examples/locale/list-continents.md +++ b/docs/examples/locale/list-continents.md @@ -1,13 +1,9 @@ from appwrite.client import Client -from appwrite.services.locale import Locale 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 -) +client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint +client.set_project('5df5acd0d48c2') # Your project ID +client.set_session('') # The user session to authenticate with locale = Locale(client) diff --git a/docs/examples/locale/list-countries-e-u.md b/docs/examples/locale/list-countries-e-u.md index ea4c43c..2f3bd50 100644 --- a/docs/examples/locale/list-countries-e-u.md +++ b/docs/examples/locale/list-countries-e-u.md @@ -1,13 +1,9 @@ from appwrite.client import Client -from appwrite.services.locale import Locale 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 -) +client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint +client.set_project('5df5acd0d48c2') # Your project ID +client.set_session('') # The user session to authenticate with locale = Locale(client) diff --git a/docs/examples/locale/list-countries-phones.md b/docs/examples/locale/list-countries-phones.md index 5a4cafe..134ddaa 100644 --- a/docs/examples/locale/list-countries-phones.md +++ b/docs/examples/locale/list-countries-phones.md @@ -1,13 +1,9 @@ from appwrite.client import Client -from appwrite.services.locale import Locale 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 -) +client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint +client.set_project('5df5acd0d48c2') # Your project ID +client.set_session('') # The user session to authenticate with locale = Locale(client) diff --git a/docs/examples/locale/list-countries.md b/docs/examples/locale/list-countries.md index f8ec83c..f344cc1 100644 --- a/docs/examples/locale/list-countries.md +++ b/docs/examples/locale/list-countries.md @@ -1,13 +1,9 @@ from appwrite.client import Client -from appwrite.services.locale import Locale 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 -) +client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint +client.set_project('5df5acd0d48c2') # Your project ID +client.set_session('') # The user session to authenticate with locale = Locale(client) diff --git a/docs/examples/locale/list-currencies.md b/docs/examples/locale/list-currencies.md index 347e81c..19d831f 100644 --- a/docs/examples/locale/list-currencies.md +++ b/docs/examples/locale/list-currencies.md @@ -1,13 +1,9 @@ from appwrite.client import Client -from appwrite.services.locale import Locale 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 -) +client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint +client.set_project('5df5acd0d48c2') # Your project ID +client.set_session('') # The user session to authenticate with locale = Locale(client) diff --git a/docs/examples/locale/list-languages.md b/docs/examples/locale/list-languages.md index ce50a6e..6de06d3 100644 --- a/docs/examples/locale/list-languages.md +++ b/docs/examples/locale/list-languages.md @@ -1,13 +1,9 @@ from appwrite.client import Client -from appwrite.services.locale import Locale 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 -) +client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint +client.set_project('5df5acd0d48c2') # Your project ID +client.set_session('') # The user session to authenticate with locale = Locale(client) diff --git a/docs/examples/messaging/create-apns-provider.md b/docs/examples/messaging/create-apns-provider.md new file mode 100644 index 0000000..287472f --- /dev/null +++ b/docs/examples/messaging/create-apns-provider.md @@ -0,0 +1,19 @@ +from appwrite.client import Client + +client = Client() +client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint +client.set_project('5df5acd0d48c2') # Your project ID +client.set_key('919c2d18fb5d4...a2ae413da83346ad2') # Your secret API key + +messaging = Messaging(client) + +result = messaging.create_apns_provider( + provider_id = '', + name = '', + auth_key = '', # optional + auth_key_id = '', # optional + team_id = '', # optional + bundle_id = '', # optional + sandbox = False, # optional + enabled = False # optional +) diff --git a/docs/examples/messaging/create-email.md b/docs/examples/messaging/create-email.md new file mode 100644 index 0000000..acca4d5 --- /dev/null +++ b/docs/examples/messaging/create-email.md @@ -0,0 +1,23 @@ +from appwrite.client import Client + +client = Client() +client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint +client.set_project('5df5acd0d48c2') # Your project ID +client.set_key('919c2d18fb5d4...a2ae413da83346ad2') # Your secret API key + +messaging = Messaging(client) + +result = messaging.create_email( + message_id = '', + subject = '', + content = '', + topics = [], # optional + users = [], # optional + targets = [], # optional + cc = [], # optional + bcc = [], # optional + attachments = [], # optional + draft = False, # optional + html = False, # optional + scheduled_at = '' # optional +) diff --git a/docs/examples/messaging/create-fcm-provider.md b/docs/examples/messaging/create-fcm-provider.md new file mode 100644 index 0000000..43c882b --- /dev/null +++ b/docs/examples/messaging/create-fcm-provider.md @@ -0,0 +1,15 @@ +from appwrite.client import Client + +client = Client() +client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint +client.set_project('5df5acd0d48c2') # Your project ID +client.set_key('919c2d18fb5d4...a2ae413da83346ad2') # Your secret API key + +messaging = Messaging(client) + +result = messaging.create_fcm_provider( + provider_id = '', + name = '', + service_account_json = {}, # optional + enabled = False # optional +) diff --git a/docs/examples/messaging/create-mailgun-provider.md b/docs/examples/messaging/create-mailgun-provider.md new file mode 100644 index 0000000..38eb415 --- /dev/null +++ b/docs/examples/messaging/create-mailgun-provider.md @@ -0,0 +1,21 @@ +from appwrite.client import Client + +client = Client() +client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint +client.set_project('5df5acd0d48c2') # Your project ID +client.set_key('919c2d18fb5d4...a2ae413da83346ad2') # Your secret API key + +messaging = Messaging(client) + +result = messaging.create_mailgun_provider( + provider_id = '', + name = '', + api_key = '', # optional + domain = '', # optional + is_eu_region = False, # optional + from_name = '', # optional + from_email = 'email@example.com', # optional + reply_to_name = '', # optional + reply_to_email = 'email@example.com', # optional + enabled = False # optional +) diff --git a/docs/examples/messaging/create-msg91provider.md b/docs/examples/messaging/create-msg91provider.md new file mode 100644 index 0000000..3ce1446 --- /dev/null +++ b/docs/examples/messaging/create-msg91provider.md @@ -0,0 +1,17 @@ +from appwrite.client import Client + +client = Client() +client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint +client.set_project('5df5acd0d48c2') # Your project ID +client.set_key('919c2d18fb5d4...a2ae413da83346ad2') # Your secret API key + +messaging = Messaging(client) + +result = messaging.create_msg91_provider( + provider_id = '', + name = '', + from = '+12065550100', # optional + sender_id = '', # optional + auth_key = '', # optional + enabled = False # optional +) diff --git a/docs/examples/messaging/create-push.md b/docs/examples/messaging/create-push.md new file mode 100644 index 0000000..7da7ac7 --- /dev/null +++ b/docs/examples/messaging/create-push.md @@ -0,0 +1,27 @@ +from appwrite.client import Client + +client = Client() +client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint +client.set_project('5df5acd0d48c2') # Your project ID +client.set_key('919c2d18fb5d4...a2ae413da83346ad2') # Your secret API key + +messaging = Messaging(client) + +result = messaging.create_push( + message_id = '', + title = '', + body = '<BODY>', + topics = [], # optional + users = [], # optional + targets = [], # optional + data = {}, # optional + action = '<ACTION>', # optional + image = '[ID1:ID2]', # optional + icon = '<ICON>', # optional + sound = '<SOUND>', # optional + color = '<COLOR>', # optional + tag = '<TAG>', # optional + badge = '<BADGE>', # optional + draft = False, # optional + scheduled_at = '' # optional +) diff --git a/docs/examples/messaging/create-sendgrid-provider.md b/docs/examples/messaging/create-sendgrid-provider.md new file mode 100644 index 0000000..e22dad8 --- /dev/null +++ b/docs/examples/messaging/create-sendgrid-provider.md @@ -0,0 +1,19 @@ +from appwrite.client import Client + +client = Client() +client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint +client.set_project('5df5acd0d48c2') # Your project ID +client.set_key('919c2d18fb5d4...a2ae413da83346ad2') # Your secret API key + +messaging = Messaging(client) + +result = messaging.create_sendgrid_provider( + provider_id = '<PROVIDER_ID>', + name = '<NAME>', + api_key = '<API_KEY>', # optional + from_name = '<FROM_NAME>', # optional + from_email = 'email@example.com', # optional + reply_to_name = '<REPLY_TO_NAME>', # optional + reply_to_email = 'email@example.com', # optional + enabled = False # optional +) diff --git a/docs/examples/messaging/create-sms.md b/docs/examples/messaging/create-sms.md new file mode 100644 index 0000000..38c3665 --- /dev/null +++ b/docs/examples/messaging/create-sms.md @@ -0,0 +1,18 @@ +from appwrite.client import Client + +client = Client() +client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint +client.set_project('5df5acd0d48c2') # Your project ID +client.set_key('919c2d18fb5d4...a2ae413da83346ad2') # Your secret API key + +messaging = Messaging(client) + +result = messaging.create_sms( + message_id = '<MESSAGE_ID>', + content = '<CONTENT>', + topics = [], # optional + users = [], # optional + targets = [], # optional + draft = False, # optional + scheduled_at = '' # optional +) diff --git a/docs/examples/messaging/create-smtp-provider.md b/docs/examples/messaging/create-smtp-provider.md new file mode 100644 index 0000000..b3b299b --- /dev/null +++ b/docs/examples/messaging/create-smtp-provider.md @@ -0,0 +1,25 @@ +from appwrite.client import Client + +client = Client() +client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint +client.set_project('5df5acd0d48c2') # Your project ID +client.set_key('919c2d18fb5d4...a2ae413da83346ad2') # Your secret API key + +messaging = Messaging(client) + +result = messaging.create_smtp_provider( + provider_id = '<PROVIDER_ID>', + name = '<NAME>', + host = '<HOST>', + port = 1, # optional + username = '<USERNAME>', # optional + password = '<PASSWORD>', # optional + encryption = SmtpEncryption.NONE, # optional + auto_tls = False, # optional + mailer = '<MAILER>', # optional + from_name = '<FROM_NAME>', # optional + from_email = 'email@example.com', # optional + reply_to_name = '<REPLY_TO_NAME>', # optional + reply_to_email = 'email@example.com', # optional + enabled = False # optional +) diff --git a/docs/examples/messaging/create-subscriber.md b/docs/examples/messaging/create-subscriber.md new file mode 100644 index 0000000..d6ffd09 --- /dev/null +++ b/docs/examples/messaging/create-subscriber.md @@ -0,0 +1,14 @@ +from appwrite.client import Client + +client = Client() +client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint +client.set_project('5df5acd0d48c2') # Your project ID +client.set_jwt('eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ...') # Your secret JSON Web Token + +messaging = Messaging(client) + +result = messaging.create_subscriber( + topic_id = '<TOPIC_ID>', + subscriber_id = '<SUBSCRIBER_ID>', + target_id = '<TARGET_ID>' +) diff --git a/docs/examples/messaging/create-telesign-provider.md b/docs/examples/messaging/create-telesign-provider.md new file mode 100644 index 0000000..b1fbab3 --- /dev/null +++ b/docs/examples/messaging/create-telesign-provider.md @@ -0,0 +1,17 @@ +from appwrite.client import Client + +client = Client() +client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint +client.set_project('5df5acd0d48c2') # Your project ID +client.set_key('919c2d18fb5d4...a2ae413da83346ad2') # Your secret API key + +messaging = Messaging(client) + +result = messaging.create_telesign_provider( + provider_id = '<PROVIDER_ID>', + name = '<NAME>', + from = '+12065550100', # optional + customer_id = '<CUSTOMER_ID>', # optional + api_key = '<API_KEY>', # optional + enabled = False # optional +) diff --git a/docs/examples/messaging/create-textmagic-provider.md b/docs/examples/messaging/create-textmagic-provider.md new file mode 100644 index 0000000..bd251d9 --- /dev/null +++ b/docs/examples/messaging/create-textmagic-provider.md @@ -0,0 +1,17 @@ +from appwrite.client import Client + +client = Client() +client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint +client.set_project('5df5acd0d48c2') # Your project ID +client.set_key('919c2d18fb5d4...a2ae413da83346ad2') # Your secret API key + +messaging = Messaging(client) + +result = messaging.create_textmagic_provider( + provider_id = '<PROVIDER_ID>', + name = '<NAME>', + from = '+12065550100', # optional + username = '<USERNAME>', # optional + api_key = '<API_KEY>', # optional + enabled = False # optional +) diff --git a/docs/examples/messaging/create-topic.md b/docs/examples/messaging/create-topic.md new file mode 100644 index 0000000..e8532b2 --- /dev/null +++ b/docs/examples/messaging/create-topic.md @@ -0,0 +1,14 @@ +from appwrite.client import Client + +client = Client() +client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint +client.set_project('5df5acd0d48c2') # Your project ID +client.set_key('919c2d18fb5d4...a2ae413da83346ad2') # Your secret API key + +messaging = Messaging(client) + +result = messaging.create_topic( + topic_id = '<TOPIC_ID>', + name = '<NAME>', + subscribe = ["any"] # optional +) diff --git a/docs/examples/messaging/create-twilio-provider.md b/docs/examples/messaging/create-twilio-provider.md new file mode 100644 index 0000000..3535fd0 --- /dev/null +++ b/docs/examples/messaging/create-twilio-provider.md @@ -0,0 +1,17 @@ +from appwrite.client import Client + +client = Client() +client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint +client.set_project('5df5acd0d48c2') # Your project ID +client.set_key('919c2d18fb5d4...a2ae413da83346ad2') # Your secret API key + +messaging = Messaging(client) + +result = messaging.create_twilio_provider( + provider_id = '<PROVIDER_ID>', + name = '<NAME>', + from = '+12065550100', # optional + account_sid = '<ACCOUNT_SID>', # optional + auth_token = '<AUTH_TOKEN>', # optional + enabled = False # optional +) diff --git a/docs/examples/messaging/create-vonage-provider.md b/docs/examples/messaging/create-vonage-provider.md new file mode 100644 index 0000000..6078096 --- /dev/null +++ b/docs/examples/messaging/create-vonage-provider.md @@ -0,0 +1,17 @@ +from appwrite.client import Client + +client = Client() +client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint +client.set_project('5df5acd0d48c2') # Your project ID +client.set_key('919c2d18fb5d4...a2ae413da83346ad2') # Your secret API key + +messaging = Messaging(client) + +result = messaging.create_vonage_provider( + provider_id = '<PROVIDER_ID>', + name = '<NAME>', + from = '+12065550100', # optional + api_key = '<API_KEY>', # optional + api_secret = '<API_SECRET>', # optional + enabled = False # optional +) diff --git a/docs/examples/messaging/delete-provider.md b/docs/examples/messaging/delete-provider.md new file mode 100644 index 0000000..58e1684 --- /dev/null +++ b/docs/examples/messaging/delete-provider.md @@ -0,0 +1,12 @@ +from appwrite.client import Client + +client = Client() +client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint +client.set_project('5df5acd0d48c2') # Your project ID +client.set_key('919c2d18fb5d4...a2ae413da83346ad2') # Your secret API key + +messaging = Messaging(client) + +result = messaging.delete_provider( + provider_id = '<PROVIDER_ID>' +) diff --git a/docs/examples/messaging/delete-subscriber.md b/docs/examples/messaging/delete-subscriber.md new file mode 100644 index 0000000..4988d06 --- /dev/null +++ b/docs/examples/messaging/delete-subscriber.md @@ -0,0 +1,13 @@ +from appwrite.client import Client + +client = Client() +client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint +client.set_project('5df5acd0d48c2') # Your project ID +client.set_jwt('eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ...') # Your secret JSON Web Token + +messaging = Messaging(client) + +result = messaging.delete_subscriber( + topic_id = '<TOPIC_ID>', + subscriber_id = '<SUBSCRIBER_ID>' +) diff --git a/docs/examples/messaging/delete-topic.md b/docs/examples/messaging/delete-topic.md new file mode 100644 index 0000000..769df6e --- /dev/null +++ b/docs/examples/messaging/delete-topic.md @@ -0,0 +1,12 @@ +from appwrite.client import Client + +client = Client() +client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint +client.set_project('5df5acd0d48c2') # Your project ID +client.set_key('919c2d18fb5d4...a2ae413da83346ad2') # Your secret API key + +messaging = Messaging(client) + +result = messaging.delete_topic( + topic_id = '<TOPIC_ID>' +) diff --git a/docs/examples/messaging/delete.md b/docs/examples/messaging/delete.md new file mode 100644 index 0000000..a25e80b --- /dev/null +++ b/docs/examples/messaging/delete.md @@ -0,0 +1,12 @@ +from appwrite.client import Client + +client = Client() +client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint +client.set_project('5df5acd0d48c2') # Your project ID +client.set_key('919c2d18fb5d4...a2ae413da83346ad2') # Your secret API key + +messaging = Messaging(client) + +result = messaging.delete( + message_id = '<MESSAGE_ID>' +) diff --git a/docs/examples/messaging/get-message.md b/docs/examples/messaging/get-message.md new file mode 100644 index 0000000..db6506e --- /dev/null +++ b/docs/examples/messaging/get-message.md @@ -0,0 +1,12 @@ +from appwrite.client import Client + +client = Client() +client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint +client.set_project('5df5acd0d48c2') # Your project ID +client.set_key('919c2d18fb5d4...a2ae413da83346ad2') # Your secret API key + +messaging = Messaging(client) + +result = messaging.get_message( + message_id = '<MESSAGE_ID>' +) diff --git a/docs/examples/messaging/get-provider.md b/docs/examples/messaging/get-provider.md new file mode 100644 index 0000000..3e71e95 --- /dev/null +++ b/docs/examples/messaging/get-provider.md @@ -0,0 +1,12 @@ +from appwrite.client import Client + +client = Client() +client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint +client.set_project('5df5acd0d48c2') # Your project ID +client.set_key('919c2d18fb5d4...a2ae413da83346ad2') # Your secret API key + +messaging = Messaging(client) + +result = messaging.get_provider( + provider_id = '<PROVIDER_ID>' +) diff --git a/docs/examples/messaging/get-subscriber.md b/docs/examples/messaging/get-subscriber.md new file mode 100644 index 0000000..e8bb030 --- /dev/null +++ b/docs/examples/messaging/get-subscriber.md @@ -0,0 +1,13 @@ +from appwrite.client import Client + +client = Client() +client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint +client.set_project('5df5acd0d48c2') # Your project ID +client.set_key('919c2d18fb5d4...a2ae413da83346ad2') # Your secret API key + +messaging = Messaging(client) + +result = messaging.get_subscriber( + topic_id = '<TOPIC_ID>', + subscriber_id = '<SUBSCRIBER_ID>' +) diff --git a/docs/examples/messaging/get-topic.md b/docs/examples/messaging/get-topic.md new file mode 100644 index 0000000..a5e9e7b --- /dev/null +++ b/docs/examples/messaging/get-topic.md @@ -0,0 +1,12 @@ +from appwrite.client import Client + +client = Client() +client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint +client.set_project('5df5acd0d48c2') # Your project ID +client.set_key('919c2d18fb5d4...a2ae413da83346ad2') # Your secret API key + +messaging = Messaging(client) + +result = messaging.get_topic( + topic_id = '<TOPIC_ID>' +) diff --git a/docs/examples/messaging/list-message-logs.md b/docs/examples/messaging/list-message-logs.md new file mode 100644 index 0000000..1cfbb2e --- /dev/null +++ b/docs/examples/messaging/list-message-logs.md @@ -0,0 +1,13 @@ +from appwrite.client import Client + +client = Client() +client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint +client.set_project('5df5acd0d48c2') # Your project ID +client.set_key('919c2d18fb5d4...a2ae413da83346ad2') # Your secret API key + +messaging = Messaging(client) + +result = messaging.list_message_logs( + message_id = '<MESSAGE_ID>', + queries = [] # optional +) diff --git a/docs/examples/messaging/list-messages.md b/docs/examples/messaging/list-messages.md new file mode 100644 index 0000000..4292733 --- /dev/null +++ b/docs/examples/messaging/list-messages.md @@ -0,0 +1,13 @@ +from appwrite.client import Client + +client = Client() +client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint +client.set_project('5df5acd0d48c2') # Your project ID +client.set_key('919c2d18fb5d4...a2ae413da83346ad2') # Your secret API key + +messaging = Messaging(client) + +result = messaging.list_messages( + queries = [], # optional + search = '<SEARCH>' # optional +) diff --git a/docs/examples/messaging/list-provider-logs.md b/docs/examples/messaging/list-provider-logs.md new file mode 100644 index 0000000..be2f735 --- /dev/null +++ b/docs/examples/messaging/list-provider-logs.md @@ -0,0 +1,13 @@ +from appwrite.client import Client + +client = Client() +client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint +client.set_project('5df5acd0d48c2') # Your project ID +client.set_key('919c2d18fb5d4...a2ae413da83346ad2') # Your secret API key + +messaging = Messaging(client) + +result = messaging.list_provider_logs( + provider_id = '<PROVIDER_ID>', + queries = [] # optional +) diff --git a/docs/examples/messaging/list-providers.md b/docs/examples/messaging/list-providers.md new file mode 100644 index 0000000..477c3b2 --- /dev/null +++ b/docs/examples/messaging/list-providers.md @@ -0,0 +1,13 @@ +from appwrite.client import Client + +client = Client() +client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint +client.set_project('5df5acd0d48c2') # Your project ID +client.set_key('919c2d18fb5d4...a2ae413da83346ad2') # Your secret API key + +messaging = Messaging(client) + +result = messaging.list_providers( + queries = [], # optional + search = '<SEARCH>' # optional +) diff --git a/docs/examples/messaging/list-subscriber-logs.md b/docs/examples/messaging/list-subscriber-logs.md new file mode 100644 index 0000000..744b53f --- /dev/null +++ b/docs/examples/messaging/list-subscriber-logs.md @@ -0,0 +1,13 @@ +from appwrite.client import Client + +client = Client() +client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint +client.set_project('5df5acd0d48c2') # Your project ID +client.set_key('919c2d18fb5d4...a2ae413da83346ad2') # Your secret API key + +messaging = Messaging(client) + +result = messaging.list_subscriber_logs( + subscriber_id = '<SUBSCRIBER_ID>', + queries = [] # optional +) diff --git a/docs/examples/messaging/list-subscribers.md b/docs/examples/messaging/list-subscribers.md new file mode 100644 index 0000000..ec8ef1d --- /dev/null +++ b/docs/examples/messaging/list-subscribers.md @@ -0,0 +1,14 @@ +from appwrite.client import Client + +client = Client() +client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint +client.set_project('5df5acd0d48c2') # Your project ID +client.set_key('919c2d18fb5d4...a2ae413da83346ad2') # Your secret API key + +messaging = Messaging(client) + +result = messaging.list_subscribers( + topic_id = '<TOPIC_ID>', + queries = [], # optional + search = '<SEARCH>' # optional +) diff --git a/docs/examples/messaging/list-targets.md b/docs/examples/messaging/list-targets.md new file mode 100644 index 0000000..7ccc6f9 --- /dev/null +++ b/docs/examples/messaging/list-targets.md @@ -0,0 +1,13 @@ +from appwrite.client import Client + +client = Client() +client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint +client.set_project('5df5acd0d48c2') # Your project ID +client.set_key('919c2d18fb5d4...a2ae413da83346ad2') # Your secret API key + +messaging = Messaging(client) + +result = messaging.list_targets( + message_id = '<MESSAGE_ID>', + queries = [] # optional +) diff --git a/docs/examples/messaging/list-topic-logs.md b/docs/examples/messaging/list-topic-logs.md new file mode 100644 index 0000000..4813049 --- /dev/null +++ b/docs/examples/messaging/list-topic-logs.md @@ -0,0 +1,13 @@ +from appwrite.client import Client + +client = Client() +client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint +client.set_project('5df5acd0d48c2') # Your project ID +client.set_key('919c2d18fb5d4...a2ae413da83346ad2') # Your secret API key + +messaging = Messaging(client) + +result = messaging.list_topic_logs( + topic_id = '<TOPIC_ID>', + queries = [] # optional +) diff --git a/docs/examples/messaging/list-topics.md b/docs/examples/messaging/list-topics.md new file mode 100644 index 0000000..6bae445 --- /dev/null +++ b/docs/examples/messaging/list-topics.md @@ -0,0 +1,13 @@ +from appwrite.client import Client + +client = Client() +client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint +client.set_project('5df5acd0d48c2') # Your project ID +client.set_key('919c2d18fb5d4...a2ae413da83346ad2') # Your secret API key + +messaging = Messaging(client) + +result = messaging.list_topics( + queries = [], # optional + search = '<SEARCH>' # optional +) diff --git a/docs/examples/messaging/update-apns-provider.md b/docs/examples/messaging/update-apns-provider.md new file mode 100644 index 0000000..4e3f998 --- /dev/null +++ b/docs/examples/messaging/update-apns-provider.md @@ -0,0 +1,19 @@ +from appwrite.client import Client + +client = Client() +client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint +client.set_project('5df5acd0d48c2') # Your project ID +client.set_key('919c2d18fb5d4...a2ae413da83346ad2') # Your secret API key + +messaging = Messaging(client) + +result = messaging.update_apns_provider( + provider_id = '<PROVIDER_ID>', + name = '<NAME>', # optional + enabled = False, # optional + auth_key = '<AUTH_KEY>', # optional + auth_key_id = '<AUTH_KEY_ID>', # optional + team_id = '<TEAM_ID>', # optional + bundle_id = '<BUNDLE_ID>', # optional + sandbox = False # optional +) diff --git a/docs/examples/messaging/update-email.md b/docs/examples/messaging/update-email.md new file mode 100644 index 0000000..4d6a17e --- /dev/null +++ b/docs/examples/messaging/update-email.md @@ -0,0 +1,22 @@ +from appwrite.client import Client + +client = Client() +client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint +client.set_project('5df5acd0d48c2') # Your project ID +client.set_key('919c2d18fb5d4...a2ae413da83346ad2') # Your secret API key + +messaging = Messaging(client) + +result = messaging.update_email( + message_id = '<MESSAGE_ID>', + topics = [], # optional + users = [], # optional + targets = [], # optional + subject = '<SUBJECT>', # optional + content = '<CONTENT>', # optional + draft = False, # optional + html = False, # optional + cc = [], # optional + bcc = [], # optional + scheduled_at = '' # optional +) diff --git a/docs/examples/messaging/update-fcm-provider.md b/docs/examples/messaging/update-fcm-provider.md new file mode 100644 index 0000000..d2179b6 --- /dev/null +++ b/docs/examples/messaging/update-fcm-provider.md @@ -0,0 +1,15 @@ +from appwrite.client import Client + +client = Client() +client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint +client.set_project('5df5acd0d48c2') # Your project ID +client.set_key('919c2d18fb5d4...a2ae413da83346ad2') # Your secret API key + +messaging = Messaging(client) + +result = messaging.update_fcm_provider( + provider_id = '<PROVIDER_ID>', + name = '<NAME>', # optional + enabled = False, # optional + service_account_json = {} # optional +) diff --git a/docs/examples/messaging/update-mailgun-provider.md b/docs/examples/messaging/update-mailgun-provider.md new file mode 100644 index 0000000..d04c617 --- /dev/null +++ b/docs/examples/messaging/update-mailgun-provider.md @@ -0,0 +1,21 @@ +from appwrite.client import Client + +client = Client() +client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint +client.set_project('5df5acd0d48c2') # Your project ID +client.set_key('919c2d18fb5d4...a2ae413da83346ad2') # Your secret API key + +messaging = Messaging(client) + +result = messaging.update_mailgun_provider( + provider_id = '<PROVIDER_ID>', + name = '<NAME>', # optional + api_key = '<API_KEY>', # optional + domain = '<DOMAIN>', # optional + is_eu_region = False, # optional + enabled = False, # optional + from_name = '<FROM_NAME>', # optional + from_email = 'email@example.com', # optional + reply_to_name = '<REPLY_TO_NAME>', # optional + reply_to_email = '<REPLY_TO_EMAIL>' # optional +) diff --git a/docs/examples/messaging/update-msg91provider.md b/docs/examples/messaging/update-msg91provider.md new file mode 100644 index 0000000..2f88686 --- /dev/null +++ b/docs/examples/messaging/update-msg91provider.md @@ -0,0 +1,17 @@ +from appwrite.client import Client + +client = Client() +client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint +client.set_project('5df5acd0d48c2') # Your project ID +client.set_key('919c2d18fb5d4...a2ae413da83346ad2') # Your secret API key + +messaging = Messaging(client) + +result = messaging.update_msg91_provider( + provider_id = '<PROVIDER_ID>', + name = '<NAME>', # optional + enabled = False, # optional + sender_id = '<SENDER_ID>', # optional + auth_key = '<AUTH_KEY>', # optional + from = '<FROM>' # optional +) diff --git a/docs/examples/messaging/update-push.md b/docs/examples/messaging/update-push.md new file mode 100644 index 0000000..ff136b9 --- /dev/null +++ b/docs/examples/messaging/update-push.md @@ -0,0 +1,27 @@ +from appwrite.client import Client + +client = Client() +client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint +client.set_project('5df5acd0d48c2') # Your project ID +client.set_key('919c2d18fb5d4...a2ae413da83346ad2') # Your secret API key + +messaging = Messaging(client) + +result = messaging.update_push( + message_id = '<MESSAGE_ID>', + topics = [], # optional + users = [], # optional + targets = [], # optional + title = '<TITLE>', # optional + body = '<BODY>', # optional + data = {}, # optional + action = '<ACTION>', # optional + image = '[ID1:ID2]', # optional + icon = '<ICON>', # optional + sound = '<SOUND>', # optional + color = '<COLOR>', # optional + tag = '<TAG>', # optional + badge = None, # optional + draft = False, # optional + scheduled_at = '' # optional +) diff --git a/docs/examples/messaging/update-sendgrid-provider.md b/docs/examples/messaging/update-sendgrid-provider.md new file mode 100644 index 0000000..4d10aad --- /dev/null +++ b/docs/examples/messaging/update-sendgrid-provider.md @@ -0,0 +1,19 @@ +from appwrite.client import Client + +client = Client() +client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint +client.set_project('5df5acd0d48c2') # Your project ID +client.set_key('919c2d18fb5d4...a2ae413da83346ad2') # Your secret API key + +messaging = Messaging(client) + +result = messaging.update_sendgrid_provider( + provider_id = '<PROVIDER_ID>', + name = '<NAME>', # optional + enabled = False, # optional + api_key = '<API_KEY>', # optional + from_name = '<FROM_NAME>', # optional + from_email = 'email@example.com', # optional + reply_to_name = '<REPLY_TO_NAME>', # optional + reply_to_email = '<REPLY_TO_EMAIL>' # optional +) diff --git a/docs/examples/messaging/update-sms.md b/docs/examples/messaging/update-sms.md new file mode 100644 index 0000000..4b9319b --- /dev/null +++ b/docs/examples/messaging/update-sms.md @@ -0,0 +1,18 @@ +from appwrite.client import Client + +client = Client() +client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint +client.set_project('5df5acd0d48c2') # Your project ID +client.set_key('919c2d18fb5d4...a2ae413da83346ad2') # Your secret API key + +messaging = Messaging(client) + +result = messaging.update_sms( + message_id = '<MESSAGE_ID>', + topics = [], # optional + users = [], # optional + targets = [], # optional + content = '<CONTENT>', # optional + draft = False, # optional + scheduled_at = '' # optional +) diff --git a/docs/examples/messaging/update-smtp-provider.md b/docs/examples/messaging/update-smtp-provider.md new file mode 100644 index 0000000..f3a9b96 --- /dev/null +++ b/docs/examples/messaging/update-smtp-provider.md @@ -0,0 +1,25 @@ +from appwrite.client import Client + +client = Client() +client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint +client.set_project('5df5acd0d48c2') # Your project ID +client.set_key('919c2d18fb5d4...a2ae413da83346ad2') # Your secret API key + +messaging = Messaging(client) + +result = messaging.update_smtp_provider( + provider_id = '<PROVIDER_ID>', + name = '<NAME>', # optional + host = '<HOST>', # optional + port = 1, # optional + username = '<USERNAME>', # optional + password = '<PASSWORD>', # optional + encryption = SmtpEncryption.NONE, # optional + auto_tls = False, # optional + mailer = '<MAILER>', # optional + from_name = '<FROM_NAME>', # optional + from_email = 'email@example.com', # optional + reply_to_name = '<REPLY_TO_NAME>', # optional + reply_to_email = '<REPLY_TO_EMAIL>', # optional + enabled = False # optional +) diff --git a/docs/examples/messaging/update-telesign-provider.md b/docs/examples/messaging/update-telesign-provider.md new file mode 100644 index 0000000..9c3c5bb --- /dev/null +++ b/docs/examples/messaging/update-telesign-provider.md @@ -0,0 +1,17 @@ +from appwrite.client import Client + +client = Client() +client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint +client.set_project('5df5acd0d48c2') # Your project ID +client.set_key('919c2d18fb5d4...a2ae413da83346ad2') # Your secret API key + +messaging = Messaging(client) + +result = messaging.update_telesign_provider( + provider_id = '<PROVIDER_ID>', + name = '<NAME>', # optional + enabled = False, # optional + customer_id = '<CUSTOMER_ID>', # optional + api_key = '<API_KEY>', # optional + from = '<FROM>' # optional +) diff --git a/docs/examples/messaging/update-textmagic-provider.md b/docs/examples/messaging/update-textmagic-provider.md new file mode 100644 index 0000000..4da5e71 --- /dev/null +++ b/docs/examples/messaging/update-textmagic-provider.md @@ -0,0 +1,17 @@ +from appwrite.client import Client + +client = Client() +client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint +client.set_project('5df5acd0d48c2') # Your project ID +client.set_key('919c2d18fb5d4...a2ae413da83346ad2') # Your secret API key + +messaging = Messaging(client) + +result = messaging.update_textmagic_provider( + provider_id = '<PROVIDER_ID>', + name = '<NAME>', # optional + enabled = False, # optional + username = '<USERNAME>', # optional + api_key = '<API_KEY>', # optional + from = '<FROM>' # optional +) diff --git a/docs/examples/messaging/update-topic.md b/docs/examples/messaging/update-topic.md new file mode 100644 index 0000000..73c2c88 --- /dev/null +++ b/docs/examples/messaging/update-topic.md @@ -0,0 +1,14 @@ +from appwrite.client import Client + +client = Client() +client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint +client.set_project('5df5acd0d48c2') # Your project ID +client.set_key('919c2d18fb5d4...a2ae413da83346ad2') # Your secret API key + +messaging = Messaging(client) + +result = messaging.update_topic( + topic_id = '<TOPIC_ID>', + name = '<NAME>', # optional + subscribe = ["any"] # optional +) diff --git a/docs/examples/messaging/update-twilio-provider.md b/docs/examples/messaging/update-twilio-provider.md new file mode 100644 index 0000000..8461df0 --- /dev/null +++ b/docs/examples/messaging/update-twilio-provider.md @@ -0,0 +1,17 @@ +from appwrite.client import Client + +client = Client() +client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint +client.set_project('5df5acd0d48c2') # Your project ID +client.set_key('919c2d18fb5d4...a2ae413da83346ad2') # Your secret API key + +messaging = Messaging(client) + +result = messaging.update_twilio_provider( + provider_id = '<PROVIDER_ID>', + name = '<NAME>', # optional + enabled = False, # optional + account_sid = '<ACCOUNT_SID>', # optional + auth_token = '<AUTH_TOKEN>', # optional + from = '<FROM>' # optional +) diff --git a/docs/examples/messaging/update-vonage-provider.md b/docs/examples/messaging/update-vonage-provider.md new file mode 100644 index 0000000..32708b0 --- /dev/null +++ b/docs/examples/messaging/update-vonage-provider.md @@ -0,0 +1,17 @@ +from appwrite.client import Client + +client = Client() +client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint +client.set_project('5df5acd0d48c2') # Your project ID +client.set_key('919c2d18fb5d4...a2ae413da83346ad2') # Your secret API key + +messaging = Messaging(client) + +result = messaging.update_vonage_provider( + provider_id = '<PROVIDER_ID>', + name = '<NAME>', # optional + enabled = False, # optional + api_key = '<API_KEY>', # optional + api_secret = '<API_SECRET>', # optional + from = '<FROM>' # optional +) diff --git a/docs/examples/storage/create-bucket.md b/docs/examples/storage/create-bucket.md index 72ffdcc..bbeebf1 100644 --- a/docs/examples/storage/create-bucket.md +++ b/docs/examples/storage/create-bucket.md @@ -1,14 +1,21 @@ from appwrite.client import Client -from appwrite.services.storage import Storage 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 -) +client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint +client.set_project('5df5acd0d48c2') # Your project ID +client.set_key('919c2d18fb5d4...a2ae413da83346ad2') # Your secret API key storage = Storage(client) -result = storage.create_bucket('[BUCKET_ID]', '[NAME]') +result = storage.create_bucket( + bucket_id = '<BUCKET_ID>', + name = '<NAME>', + permissions = ["read("any")"], # optional + file_security = False, # optional + enabled = False, # optional + maximum_file_size = 1, # optional + allowed_file_extensions = [], # optional + compression = .NONE, # optional + encryption = False, # optional + antivirus = False # optional +) diff --git a/docs/examples/storage/create-file.md b/docs/examples/storage/create-file.md index b469b5b..b8cae35 100644 --- a/docs/examples/storage/create-file.md +++ b/docs/examples/storage/create-file.md @@ -1,15 +1,16 @@ from appwrite.client import Client from appwrite.input_file import InputFile -from appwrite.services.storage import Storage 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 -) +client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint +client.set_project('5df5acd0d48c2') # Your project ID +client.set_session('') # The user session to authenticate with storage = Storage(client) -result = storage.create_file('[BUCKET_ID]', '[FILE_ID]', InputFile.from_path('file.png')) +result = storage.create_file( + bucket_id = '<BUCKET_ID>', + file_id = '<FILE_ID>', + file = InputFile.from_path('file.png'), + permissions = ["read("any")"] # optional +) diff --git a/docs/examples/storage/delete-bucket.md b/docs/examples/storage/delete-bucket.md index 60dc107..cd008a7 100644 --- a/docs/examples/storage/delete-bucket.md +++ b/docs/examples/storage/delete-bucket.md @@ -1,14 +1,12 @@ from appwrite.client import Client -from appwrite.services.storage import Storage 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 -) +client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint +client.set_project('5df5acd0d48c2') # Your project ID +client.set_key('919c2d18fb5d4...a2ae413da83346ad2') # Your secret API key storage = Storage(client) -result = storage.delete_bucket('[BUCKET_ID]') +result = storage.delete_bucket( + bucket_id = '<BUCKET_ID>' +) diff --git a/docs/examples/storage/delete-file.md b/docs/examples/storage/delete-file.md index 9bed0af..69fe398 100644 --- a/docs/examples/storage/delete-file.md +++ b/docs/examples/storage/delete-file.md @@ -1,14 +1,13 @@ from appwrite.client import Client -from appwrite.services.storage import Storage 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 -) +client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint +client.set_project('5df5acd0d48c2') # Your project ID +client.set_session('') # The user session to authenticate with storage = Storage(client) -result = storage.delete_file('[BUCKET_ID]', '[FILE_ID]') +result = storage.delete_file( + bucket_id = '<BUCKET_ID>', + file_id = '<FILE_ID>' +) diff --git a/docs/examples/storage/get-bucket.md b/docs/examples/storage/get-bucket.md index 7ea64f2..8740eb5 100644 --- a/docs/examples/storage/get-bucket.md +++ b/docs/examples/storage/get-bucket.md @@ -1,14 +1,12 @@ from appwrite.client import Client -from appwrite.services.storage import Storage 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 -) +client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint +client.set_project('5df5acd0d48c2') # Your project ID +client.set_key('919c2d18fb5d4...a2ae413da83346ad2') # Your secret API key storage = Storage(client) -result = storage.get_bucket('[BUCKET_ID]') +result = storage.get_bucket( + bucket_id = '<BUCKET_ID>' +) diff --git a/docs/examples/storage/get-file-download.md b/docs/examples/storage/get-file-download.md index e9f5cce..30fff99 100644 --- a/docs/examples/storage/get-file-download.md +++ b/docs/examples/storage/get-file-download.md @@ -1,14 +1,13 @@ from appwrite.client import Client -from appwrite.services.storage import Storage 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 -) +client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint +client.set_project('5df5acd0d48c2') # Your project ID +client.set_session('') # The user session to authenticate with storage = Storage(client) -result = storage.get_file_download('[BUCKET_ID]', '[FILE_ID]') +result = storage.get_file_download( + bucket_id = '<BUCKET_ID>', + file_id = '<FILE_ID>' +) diff --git a/docs/examples/storage/get-file-preview.md b/docs/examples/storage/get-file-preview.md index 4e12291..08dcb47 100644 --- a/docs/examples/storage/get-file-preview.md +++ b/docs/examples/storage/get-file-preview.md @@ -1,14 +1,24 @@ from appwrite.client import Client -from appwrite.services.storage import Storage 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 -) +client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint +client.set_project('5df5acd0d48c2') # Your project ID +client.set_session('') # The user session to authenticate with storage = Storage(client) -result = storage.get_file_preview('[BUCKET_ID]', '[FILE_ID]') +result = storage.get_file_preview( + bucket_id = '<BUCKET_ID>', + file_id = '<FILE_ID>', + width = 0, # optional + height = 0, # optional + gravity = ImageGravity.CENTER, # optional + quality = 0, # optional + border_width = 0, # optional + border_color = '', # optional + border_radius = 0, # optional + opacity = 0, # optional + rotation = -360, # optional + background = '', # optional + output = ImageFormat.JPG # optional +) diff --git a/docs/examples/storage/get-file-view.md b/docs/examples/storage/get-file-view.md index 01cbfaf..6cf8565 100644 --- a/docs/examples/storage/get-file-view.md +++ b/docs/examples/storage/get-file-view.md @@ -1,14 +1,13 @@ from appwrite.client import Client -from appwrite.services.storage import Storage 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 -) +client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint +client.set_project('5df5acd0d48c2') # Your project ID +client.set_session('') # The user session to authenticate with storage = Storage(client) -result = storage.get_file_view('[BUCKET_ID]', '[FILE_ID]') +result = storage.get_file_view( + bucket_id = '<BUCKET_ID>', + file_id = '<FILE_ID>' +) diff --git a/docs/examples/storage/get-file.md b/docs/examples/storage/get-file.md index f83ed8a..f54c7a5 100644 --- a/docs/examples/storage/get-file.md +++ b/docs/examples/storage/get-file.md @@ -1,14 +1,13 @@ from appwrite.client import Client -from appwrite.services.storage import Storage 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 -) +client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint +client.set_project('5df5acd0d48c2') # Your project ID +client.set_session('') # The user session to authenticate with storage = Storage(client) -result = storage.get_file('[BUCKET_ID]', '[FILE_ID]') +result = storage.get_file( + bucket_id = '<BUCKET_ID>', + file_id = '<FILE_ID>' +) diff --git a/docs/examples/storage/list-buckets.md b/docs/examples/storage/list-buckets.md index 204fd95..909d6f7 100644 --- a/docs/examples/storage/list-buckets.md +++ b/docs/examples/storage/list-buckets.md @@ -1,14 +1,13 @@ from appwrite.client import Client -from appwrite.services.storage import Storage 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 -) +client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint +client.set_project('5df5acd0d48c2') # Your project ID +client.set_key('919c2d18fb5d4...a2ae413da83346ad2') # Your secret API key storage = Storage(client) -result = storage.list_buckets() +result = storage.list_buckets( + queries = [], # optional + search = '<SEARCH>' # optional +) diff --git a/docs/examples/storage/list-files.md b/docs/examples/storage/list-files.md index 63101e2..73f4a28 100644 --- a/docs/examples/storage/list-files.md +++ b/docs/examples/storage/list-files.md @@ -1,14 +1,14 @@ from appwrite.client import Client -from appwrite.services.storage import Storage 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 -) +client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint +client.set_project('5df5acd0d48c2') # Your project ID +client.set_session('') # The user session to authenticate with storage = Storage(client) -result = storage.list_files('[BUCKET_ID]') +result = storage.list_files( + bucket_id = '<BUCKET_ID>', + queries = [], # optional + search = '<SEARCH>' # optional +) diff --git a/docs/examples/storage/update-bucket.md b/docs/examples/storage/update-bucket.md index fb1b76b..4722284 100644 --- a/docs/examples/storage/update-bucket.md +++ b/docs/examples/storage/update-bucket.md @@ -1,14 +1,21 @@ from appwrite.client import Client -from appwrite.services.storage import Storage 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 -) +client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint +client.set_project('5df5acd0d48c2') # Your project ID +client.set_key('919c2d18fb5d4...a2ae413da83346ad2') # Your secret API key storage = Storage(client) -result = storage.update_bucket('[BUCKET_ID]', '[NAME]') +result = storage.update_bucket( + bucket_id = '<BUCKET_ID>', + name = '<NAME>', + permissions = ["read("any")"], # optional + file_security = False, # optional + enabled = False, # optional + maximum_file_size = 1, # optional + allowed_file_extensions = [], # optional + compression = .NONE, # optional + encryption = False, # optional + antivirus = False # optional +) diff --git a/docs/examples/storage/update-file.md b/docs/examples/storage/update-file.md index 24a92e3..0a0b78c 100644 --- a/docs/examples/storage/update-file.md +++ b/docs/examples/storage/update-file.md @@ -1,14 +1,15 @@ from appwrite.client import Client -from appwrite.services.storage import Storage 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 -) +client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint +client.set_project('5df5acd0d48c2') # Your project ID +client.set_session('') # The user session to authenticate with storage = Storage(client) -result = storage.update_file('[BUCKET_ID]', '[FILE_ID]') +result = storage.update_file( + bucket_id = '<BUCKET_ID>', + file_id = '<FILE_ID>', + name = '<NAME>', # optional + permissions = ["read("any")"] # optional +) diff --git a/docs/examples/teams/create-membership.md b/docs/examples/teams/create-membership.md index cde8455..5be1405 100644 --- a/docs/examples/teams/create-membership.md +++ b/docs/examples/teams/create-membership.md @@ -1,14 +1,18 @@ from appwrite.client import Client -from appwrite.services.teams import Teams 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 -) +client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint +client.set_project('5df5acd0d48c2') # Your project ID +client.set_session('') # The user session to authenticate with teams = Teams(client) -result = teams.create_membership('[TEAM_ID]', []) +result = teams.create_membership( + team_id = '<TEAM_ID>', + roles = [], + email = 'email@example.com', # optional + user_id = '<USER_ID>', # optional + phone = '+12065550100', # optional + url = 'https://example.com', # optional + name = '<NAME>' # optional +) diff --git a/docs/examples/teams/create.md b/docs/examples/teams/create.md index c690123..c305b46 100644 --- a/docs/examples/teams/create.md +++ b/docs/examples/teams/create.md @@ -1,14 +1,14 @@ from appwrite.client import Client -from appwrite.services.teams import Teams 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 -) +client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint +client.set_project('5df5acd0d48c2') # Your project ID +client.set_session('') # The user session to authenticate with teams = Teams(client) -result = teams.create('[TEAM_ID]', '[NAME]') +result = teams.create( + team_id = '<TEAM_ID>', + name = '<NAME>', + roles = [] # optional +) diff --git a/docs/examples/teams/delete-membership.md b/docs/examples/teams/delete-membership.md index f8d8759..b9f34aa 100644 --- a/docs/examples/teams/delete-membership.md +++ b/docs/examples/teams/delete-membership.md @@ -1,14 +1,13 @@ from appwrite.client import Client -from appwrite.services.teams import Teams 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 -) +client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint +client.set_project('5df5acd0d48c2') # Your project ID +client.set_session('') # The user session to authenticate with teams = Teams(client) -result = teams.delete_membership('[TEAM_ID]', '[MEMBERSHIP_ID]') +result = teams.delete_membership( + team_id = '<TEAM_ID>', + membership_id = '<MEMBERSHIP_ID>' +) diff --git a/docs/examples/teams/delete.md b/docs/examples/teams/delete.md index 4fc0fa4..18623d1 100644 --- a/docs/examples/teams/delete.md +++ b/docs/examples/teams/delete.md @@ -1,14 +1,12 @@ from appwrite.client import Client -from appwrite.services.teams import Teams 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 -) +client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint +client.set_project('5df5acd0d48c2') # Your project ID +client.set_session('') # The user session to authenticate with teams = Teams(client) -result = teams.delete('[TEAM_ID]') +result = teams.delete( + team_id = '<TEAM_ID>' +) diff --git a/docs/examples/teams/get-membership.md b/docs/examples/teams/get-membership.md index e9c62ae..06d270a 100644 --- a/docs/examples/teams/get-membership.md +++ b/docs/examples/teams/get-membership.md @@ -1,14 +1,13 @@ from appwrite.client import Client -from appwrite.services.teams import Teams 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 -) +client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint +client.set_project('5df5acd0d48c2') # Your project ID +client.set_session('') # The user session to authenticate with teams = Teams(client) -result = teams.get_membership('[TEAM_ID]', '[MEMBERSHIP_ID]') +result = teams.get_membership( + team_id = '<TEAM_ID>', + membership_id = '<MEMBERSHIP_ID>' +) diff --git a/docs/examples/teams/get-prefs.md b/docs/examples/teams/get-prefs.md index 40909fa..046d638 100644 --- a/docs/examples/teams/get-prefs.md +++ b/docs/examples/teams/get-prefs.md @@ -1,14 +1,12 @@ from appwrite.client import Client -from appwrite.services.teams import Teams client = Client() - -(client - .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint - .set_project('5df5acd0d48c2') # Your project ID - .set_jwt('eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ...') # Your secret JSON Web Token -) +client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint +client.set_project('5df5acd0d48c2') # Your project ID +client.set_session('') # The user session to authenticate with teams = Teams(client) -result = teams.get_prefs('[TEAM_ID]') +result = teams.get_prefs( + team_id = '<TEAM_ID>' +) diff --git a/docs/examples/teams/get.md b/docs/examples/teams/get.md index fdca2fc..ee5fdf6 100644 --- a/docs/examples/teams/get.md +++ b/docs/examples/teams/get.md @@ -1,14 +1,12 @@ from appwrite.client import Client -from appwrite.services.teams import Teams 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 -) +client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint +client.set_project('5df5acd0d48c2') # Your project ID +client.set_session('') # The user session to authenticate with teams = Teams(client) -result = teams.get('[TEAM_ID]') +result = teams.get( + team_id = '<TEAM_ID>' +) diff --git a/docs/examples/teams/list-memberships.md b/docs/examples/teams/list-memberships.md index 63e662a..997a106 100644 --- a/docs/examples/teams/list-memberships.md +++ b/docs/examples/teams/list-memberships.md @@ -1,14 +1,14 @@ from appwrite.client import Client -from appwrite.services.teams import Teams 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 -) +client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint +client.set_project('5df5acd0d48c2') # Your project ID +client.set_session('') # The user session to authenticate with teams = Teams(client) -result = teams.list_memberships('[TEAM_ID]') +result = teams.list_memberships( + team_id = '<TEAM_ID>', + queries = [], # optional + search = '<SEARCH>' # optional +) diff --git a/docs/examples/teams/list.md b/docs/examples/teams/list.md index e60cb60..f066e01 100644 --- a/docs/examples/teams/list.md +++ b/docs/examples/teams/list.md @@ -1,14 +1,13 @@ from appwrite.client import Client -from appwrite.services.teams import Teams 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 -) +client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint +client.set_project('5df5acd0d48c2') # Your project ID +client.set_session('') # The user session to authenticate with teams = Teams(client) -result = teams.list() +result = teams.list( + queries = [], # optional + search = '<SEARCH>' # optional +) diff --git a/docs/examples/teams/update-membership-status.md b/docs/examples/teams/update-membership-status.md index a6cd4cd..5ab354e 100644 --- a/docs/examples/teams/update-membership-status.md +++ b/docs/examples/teams/update-membership-status.md @@ -1,14 +1,15 @@ from appwrite.client import Client -from appwrite.services.teams import Teams client = Client() - -(client - .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint - .set_project('5df5acd0d48c2') # Your project ID - .set_jwt('eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ...') # Your secret JSON Web Token -) +client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint +client.set_project('5df5acd0d48c2') # Your project ID +client.set_session('') # The user session to authenticate with teams = Teams(client) -result = teams.update_membership_status('[TEAM_ID]', '[MEMBERSHIP_ID]', '[USER_ID]', '[SECRET]') +result = teams.update_membership_status( + team_id = '<TEAM_ID>', + membership_id = '<MEMBERSHIP_ID>', + user_id = '<USER_ID>', + secret = '<SECRET>' +) diff --git a/docs/examples/teams/update-membership.md b/docs/examples/teams/update-membership.md index 816c6ad..a681533 100644 --- a/docs/examples/teams/update-membership.md +++ b/docs/examples/teams/update-membership.md @@ -1,14 +1,14 @@ from appwrite.client import Client -from appwrite.services.teams import Teams 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 -) +client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint +client.set_project('5df5acd0d48c2') # Your project ID +client.set_session('') # The user session to authenticate with teams = Teams(client) -result = teams.update_membership('[TEAM_ID]', '[MEMBERSHIP_ID]', []) +result = teams.update_membership( + team_id = '<TEAM_ID>', + membership_id = '<MEMBERSHIP_ID>', + roles = [] +) diff --git a/docs/examples/teams/update-name.md b/docs/examples/teams/update-name.md index 929f4ec..2430570 100644 --- a/docs/examples/teams/update-name.md +++ b/docs/examples/teams/update-name.md @@ -1,14 +1,13 @@ from appwrite.client import Client -from appwrite.services.teams import Teams 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 -) +client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint +client.set_project('5df5acd0d48c2') # Your project ID +client.set_session('') # The user session to authenticate with teams = Teams(client) -result = teams.update_name('[TEAM_ID]', '[NAME]') +result = teams.update_name( + team_id = '<TEAM_ID>', + name = '<NAME>' +) diff --git a/docs/examples/teams/update-prefs.md b/docs/examples/teams/update-prefs.md index 4176c62..27de647 100644 --- a/docs/examples/teams/update-prefs.md +++ b/docs/examples/teams/update-prefs.md @@ -1,14 +1,13 @@ from appwrite.client import Client -from appwrite.services.teams import Teams client = Client() - -(client - .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint - .set_project('5df5acd0d48c2') # Your project ID - .set_jwt('eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ...') # Your secret JSON Web Token -) +client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint +client.set_project('5df5acd0d48c2') # Your project ID +client.set_session('') # The user session to authenticate with teams = Teams(client) -result = teams.update_prefs('[TEAM_ID]', {}) +result = teams.update_prefs( + team_id = '<TEAM_ID>', + prefs = {} +) diff --git a/docs/examples/users/create-argon2user.md b/docs/examples/users/create-argon2user.md index be1e8ce..2317c81 100644 --- a/docs/examples/users/create-argon2user.md +++ b/docs/examples/users/create-argon2user.md @@ -1,14 +1,15 @@ from appwrite.client import Client -from appwrite.services.users import Users 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 -) +client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint +client.set_project('5df5acd0d48c2') # Your project ID +client.set_key('919c2d18fb5d4...a2ae413da83346ad2') # Your secret API key users = Users(client) -result = users.create_argon2_user('[USER_ID]', 'email@example.com', 'password') +result = users.create_argon2_user( + user_id = '<USER_ID>', + email = 'email@example.com', + password = 'password', + name = '<NAME>' # optional +) diff --git a/docs/examples/users/create-bcrypt-user.md b/docs/examples/users/create-bcrypt-user.md index 77c9918..7ea2345 100644 --- a/docs/examples/users/create-bcrypt-user.md +++ b/docs/examples/users/create-bcrypt-user.md @@ -1,14 +1,15 @@ from appwrite.client import Client -from appwrite.services.users import Users 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 -) +client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint +client.set_project('5df5acd0d48c2') # Your project ID +client.set_key('919c2d18fb5d4...a2ae413da83346ad2') # Your secret API key users = Users(client) -result = users.create_bcrypt_user('[USER_ID]', 'email@example.com', 'password') +result = users.create_bcrypt_user( + user_id = '<USER_ID>', + email = 'email@example.com', + password = 'password', + name = '<NAME>' # optional +) diff --git a/docs/examples/users/create-m-d5user.md b/docs/examples/users/create-m-d5user.md index f3ab3f8..10b33e5 100644 --- a/docs/examples/users/create-m-d5user.md +++ b/docs/examples/users/create-m-d5user.md @@ -1,14 +1,15 @@ from appwrite.client import Client -from appwrite.services.users import Users 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 -) +client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint +client.set_project('5df5acd0d48c2') # Your project ID +client.set_key('919c2d18fb5d4...a2ae413da83346ad2') # Your secret API key users = Users(client) -result = users.create_md5_user('[USER_ID]', 'email@example.com', 'password') +result = users.create_md5_user( + user_id = '<USER_ID>', + email = 'email@example.com', + password = 'password', + name = '<NAME>' # optional +) diff --git a/docs/examples/users/create-mfa-recovery-codes.md b/docs/examples/users/create-mfa-recovery-codes.md new file mode 100644 index 0000000..35706cc --- /dev/null +++ b/docs/examples/users/create-mfa-recovery-codes.md @@ -0,0 +1,12 @@ +from appwrite.client import Client + +client = Client() +client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint +client.set_project('5df5acd0d48c2') # Your project ID +client.set_key('919c2d18fb5d4...a2ae413da83346ad2') # Your secret API key + +users = Users(client) + +result = users.create_mfa_recovery_codes( + user_id = '<USER_ID>' +) diff --git a/docs/examples/users/create-p-h-pass-user.md b/docs/examples/users/create-p-h-pass-user.md index e715f47..5f92330 100644 --- a/docs/examples/users/create-p-h-pass-user.md +++ b/docs/examples/users/create-p-h-pass-user.md @@ -1,14 +1,15 @@ from appwrite.client import Client -from appwrite.services.users import Users 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 -) +client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint +client.set_project('5df5acd0d48c2') # Your project ID +client.set_key('919c2d18fb5d4...a2ae413da83346ad2') # Your secret API key users = Users(client) -result = users.create_ph_pass_user('[USER_ID]', 'email@example.com', 'password') +result = users.create_ph_pass_user( + user_id = '<USER_ID>', + email = 'email@example.com', + password = 'password', + name = '<NAME>' # optional +) diff --git a/docs/examples/users/create-s-h-a-user.md b/docs/examples/users/create-s-h-a-user.md index 2a2db5a..c4c9a92 100644 --- a/docs/examples/users/create-s-h-a-user.md +++ b/docs/examples/users/create-s-h-a-user.md @@ -1,14 +1,16 @@ from appwrite.client import Client -from appwrite.services.users import Users 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 -) +client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint +client.set_project('5df5acd0d48c2') # Your project ID +client.set_key('919c2d18fb5d4...a2ae413da83346ad2') # Your secret API key users = Users(client) -result = users.create_sha_user('[USER_ID]', 'email@example.com', 'password') +result = users.create_sha_user( + user_id = '<USER_ID>', + email = 'email@example.com', + password = 'password', + password_version = PasswordHash.SHA1, # optional + name = '<NAME>' # optional +) diff --git a/docs/examples/users/create-scrypt-modified-user.md b/docs/examples/users/create-scrypt-modified-user.md index 0b42e98..321642f 100644 --- a/docs/examples/users/create-scrypt-modified-user.md +++ b/docs/examples/users/create-scrypt-modified-user.md @@ -1,14 +1,18 @@ from appwrite.client import Client -from appwrite.services.users import Users 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 -) +client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint +client.set_project('5df5acd0d48c2') # Your project ID +client.set_key('919c2d18fb5d4...a2ae413da83346ad2') # Your secret API key users = Users(client) -result = users.create_scrypt_modified_user('[USER_ID]', 'email@example.com', 'password', '[PASSWORD_SALT]', '[PASSWORD_SALT_SEPARATOR]', '[PASSWORD_SIGNER_KEY]') +result = users.create_scrypt_modified_user( + user_id = '<USER_ID>', + email = 'email@example.com', + password = 'password', + password_salt = '<PASSWORD_SALT>', + password_salt_separator = '<PASSWORD_SALT_SEPARATOR>', + password_signer_key = '<PASSWORD_SIGNER_KEY>', + name = '<NAME>' # optional +) diff --git a/docs/examples/users/create-scrypt-user.md b/docs/examples/users/create-scrypt-user.md index b445623..e7da3a5 100644 --- a/docs/examples/users/create-scrypt-user.md +++ b/docs/examples/users/create-scrypt-user.md @@ -1,14 +1,20 @@ from appwrite.client import Client -from appwrite.services.users import Users 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 -) +client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint +client.set_project('5df5acd0d48c2') # Your project ID +client.set_key('919c2d18fb5d4...a2ae413da83346ad2') # Your secret API key users = Users(client) -result = users.create_scrypt_user('[USER_ID]', 'email@example.com', 'password', '[PASSWORD_SALT]', None, None, None, None) +result = users.create_scrypt_user( + user_id = '<USER_ID>', + email = 'email@example.com', + password = 'password', + password_salt = '<PASSWORD_SALT>', + password_cpu = None, + password_memory = None, + password_parallel = None, + password_length = None, + name = '<NAME>' # optional +) diff --git a/docs/examples/users/create-session.md b/docs/examples/users/create-session.md new file mode 100644 index 0000000..2440e50 --- /dev/null +++ b/docs/examples/users/create-session.md @@ -0,0 +1,12 @@ +from appwrite.client import Client + +client = Client() +client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint +client.set_project('5df5acd0d48c2') # Your project ID +client.set_key('919c2d18fb5d4...a2ae413da83346ad2') # Your secret API key + +users = Users(client) + +result = users.create_session( + user_id = '<USER_ID>' +) diff --git a/docs/examples/users/create-target.md b/docs/examples/users/create-target.md new file mode 100644 index 0000000..123a092 --- /dev/null +++ b/docs/examples/users/create-target.md @@ -0,0 +1,18 @@ +from appwrite.client import Client +from appwrite.enums import MessagingProviderType + +client = Client() +client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint +client.set_project('5df5acd0d48c2') # Your project ID +client.set_key('919c2d18fb5d4...a2ae413da83346ad2') # Your secret API key + +users = Users(client) + +result = users.create_target( + user_id = '<USER_ID>', + target_id = '<TARGET_ID>', + provider_type = MessagingProviderType.EMAIL, + identifier = '<IDENTIFIER>', + provider_id = '<PROVIDER_ID>', # optional + name = '<NAME>' # optional +) diff --git a/docs/examples/users/create-token.md b/docs/examples/users/create-token.md new file mode 100644 index 0000000..27e4f51 --- /dev/null +++ b/docs/examples/users/create-token.md @@ -0,0 +1,14 @@ +from appwrite.client import Client + +client = Client() +client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint +client.set_project('5df5acd0d48c2') # Your project ID +client.set_key('919c2d18fb5d4...a2ae413da83346ad2') # Your secret API key + +users = Users(client) + +result = users.create_token( + user_id = '<USER_ID>', + length = 4, # optional + expire = 60 # optional +) diff --git a/docs/examples/users/create.md b/docs/examples/users/create.md index 05249c0..716c4ac 100644 --- a/docs/examples/users/create.md +++ b/docs/examples/users/create.md @@ -1,14 +1,16 @@ from appwrite.client import Client -from appwrite.services.users import Users 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 -) +client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint +client.set_project('5df5acd0d48c2') # Your project ID +client.set_key('919c2d18fb5d4...a2ae413da83346ad2') # Your secret API key users = Users(client) -result = users.create('[USER_ID]') +result = users.create( + user_id = '<USER_ID>', + email = 'email@example.com', # optional + phone = '+12065550100', # optional + password = '', # optional + name = '<NAME>' # optional +) diff --git a/docs/examples/users/delete-identity.md b/docs/examples/users/delete-identity.md index d103824..8e9918f 100644 --- a/docs/examples/users/delete-identity.md +++ b/docs/examples/users/delete-identity.md @@ -1,14 +1,12 @@ from appwrite.client import Client -from appwrite.services.users import Users 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 -) +client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint +client.set_project('5df5acd0d48c2') # Your project ID +client.set_key('919c2d18fb5d4...a2ae413da83346ad2') # Your secret API key users = Users(client) -result = users.delete_identity('[IDENTITY_ID]') +result = users.delete_identity( + identity_id = '<IDENTITY_ID>' +) diff --git a/docs/examples/users/delete-mfa-authenticator.md b/docs/examples/users/delete-mfa-authenticator.md new file mode 100644 index 0000000..d418107 --- /dev/null +++ b/docs/examples/users/delete-mfa-authenticator.md @@ -0,0 +1,14 @@ +from appwrite.client import Client +from appwrite.enums import AuthenticatorType + +client = Client() +client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint +client.set_project('5df5acd0d48c2') # Your project ID +client.set_key('919c2d18fb5d4...a2ae413da83346ad2') # Your secret API key + +users = Users(client) + +result = users.delete_mfa_authenticator( + user_id = '<USER_ID>', + type = AuthenticatorType.TOTP +) diff --git a/docs/examples/users/delete-session.md b/docs/examples/users/delete-session.md index 26b041d..b3bdcb2 100644 --- a/docs/examples/users/delete-session.md +++ b/docs/examples/users/delete-session.md @@ -1,14 +1,13 @@ from appwrite.client import Client -from appwrite.services.users import Users 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 -) +client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint +client.set_project('5df5acd0d48c2') # Your project ID +client.set_key('919c2d18fb5d4...a2ae413da83346ad2') # Your secret API key users = Users(client) -result = users.delete_session('[USER_ID]', '[SESSION_ID]') +result = users.delete_session( + user_id = '<USER_ID>', + session_id = '<SESSION_ID>' +) diff --git a/docs/examples/users/delete-sessions.md b/docs/examples/users/delete-sessions.md index dabe4f6..08640f5 100644 --- a/docs/examples/users/delete-sessions.md +++ b/docs/examples/users/delete-sessions.md @@ -1,14 +1,12 @@ from appwrite.client import Client -from appwrite.services.users import Users 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 -) +client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint +client.set_project('5df5acd0d48c2') # Your project ID +client.set_key('919c2d18fb5d4...a2ae413da83346ad2') # Your secret API key users = Users(client) -result = users.delete_sessions('[USER_ID]') +result = users.delete_sessions( + user_id = '<USER_ID>' +) diff --git a/docs/examples/users/delete-target.md b/docs/examples/users/delete-target.md new file mode 100644 index 0000000..5309b17 --- /dev/null +++ b/docs/examples/users/delete-target.md @@ -0,0 +1,13 @@ +from appwrite.client import Client + +client = Client() +client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint +client.set_project('5df5acd0d48c2') # Your project ID +client.set_key('919c2d18fb5d4...a2ae413da83346ad2') # Your secret API key + +users = Users(client) + +result = users.delete_target( + user_id = '<USER_ID>', + target_id = '<TARGET_ID>' +) diff --git a/docs/examples/users/delete.md b/docs/examples/users/delete.md index 7fdc775..bb73199 100644 --- a/docs/examples/users/delete.md +++ b/docs/examples/users/delete.md @@ -1,14 +1,12 @@ from appwrite.client import Client -from appwrite.services.users import Users 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 -) +client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint +client.set_project('5df5acd0d48c2') # Your project ID +client.set_key('919c2d18fb5d4...a2ae413da83346ad2') # Your secret API key users = Users(client) -result = users.delete('[USER_ID]') +result = users.delete( + user_id = '<USER_ID>' +) diff --git a/docs/examples/users/get-mfa-recovery-codes.md b/docs/examples/users/get-mfa-recovery-codes.md new file mode 100644 index 0000000..529346a --- /dev/null +++ b/docs/examples/users/get-mfa-recovery-codes.md @@ -0,0 +1,12 @@ +from appwrite.client import Client + +client = Client() +client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint +client.set_project('5df5acd0d48c2') # Your project ID +client.set_key('919c2d18fb5d4...a2ae413da83346ad2') # Your secret API key + +users = Users(client) + +result = users.get_mfa_recovery_codes( + user_id = '<USER_ID>' +) diff --git a/docs/examples/users/get-prefs.md b/docs/examples/users/get-prefs.md index 2bbaa88..34614de 100644 --- a/docs/examples/users/get-prefs.md +++ b/docs/examples/users/get-prefs.md @@ -1,14 +1,12 @@ from appwrite.client import Client -from appwrite.services.users import Users 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 -) +client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint +client.set_project('5df5acd0d48c2') # Your project ID +client.set_key('919c2d18fb5d4...a2ae413da83346ad2') # Your secret API key users = Users(client) -result = users.get_prefs('[USER_ID]') +result = users.get_prefs( + user_id = '<USER_ID>' +) diff --git a/docs/examples/users/get-target.md b/docs/examples/users/get-target.md new file mode 100644 index 0000000..d07591f --- /dev/null +++ b/docs/examples/users/get-target.md @@ -0,0 +1,13 @@ +from appwrite.client import Client + +client = Client() +client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint +client.set_project('5df5acd0d48c2') # Your project ID +client.set_key('919c2d18fb5d4...a2ae413da83346ad2') # Your secret API key + +users = Users(client) + +result = users.get_target( + user_id = '<USER_ID>', + target_id = '<TARGET_ID>' +) diff --git a/docs/examples/users/get.md b/docs/examples/users/get.md index 463957d..efa5941 100644 --- a/docs/examples/users/get.md +++ b/docs/examples/users/get.md @@ -1,14 +1,12 @@ from appwrite.client import Client -from appwrite.services.users import Users 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 -) +client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint +client.set_project('5df5acd0d48c2') # Your project ID +client.set_key('919c2d18fb5d4...a2ae413da83346ad2') # Your secret API key users = Users(client) -result = users.get('[USER_ID]') +result = users.get( + user_id = '<USER_ID>' +) diff --git a/docs/examples/users/list-identities.md b/docs/examples/users/list-identities.md index 0addd3e..e19a3dd 100644 --- a/docs/examples/users/list-identities.md +++ b/docs/examples/users/list-identities.md @@ -1,14 +1,13 @@ from appwrite.client import Client -from appwrite.services.users import Users 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 -) +client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint +client.set_project('5df5acd0d48c2') # Your project ID +client.set_key('919c2d18fb5d4...a2ae413da83346ad2') # Your secret API key users = Users(client) -result = users.list_identities() +result = users.list_identities( + queries = [], # optional + search = '<SEARCH>' # optional +) diff --git a/docs/examples/users/list-logs.md b/docs/examples/users/list-logs.md index ca3a5eb..54e6886 100644 --- a/docs/examples/users/list-logs.md +++ b/docs/examples/users/list-logs.md @@ -1,14 +1,13 @@ from appwrite.client import Client -from appwrite.services.users import Users 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 -) +client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint +client.set_project('5df5acd0d48c2') # Your project ID +client.set_key('919c2d18fb5d4...a2ae413da83346ad2') # Your secret API key users = Users(client) -result = users.list_logs('[USER_ID]') +result = users.list_logs( + user_id = '<USER_ID>', + queries = [] # optional +) diff --git a/docs/examples/users/list-memberships.md b/docs/examples/users/list-memberships.md index 0dfb97a..d0de2fb 100644 --- a/docs/examples/users/list-memberships.md +++ b/docs/examples/users/list-memberships.md @@ -1,14 +1,12 @@ from appwrite.client import Client -from appwrite.services.users import Users 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 -) +client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint +client.set_project('5df5acd0d48c2') # Your project ID +client.set_key('919c2d18fb5d4...a2ae413da83346ad2') # Your secret API key users = Users(client) -result = users.list_memberships('[USER_ID]') +result = users.list_memberships( + user_id = '<USER_ID>' +) diff --git a/docs/examples/users/list-mfa-factors.md b/docs/examples/users/list-mfa-factors.md new file mode 100644 index 0000000..8092b0f --- /dev/null +++ b/docs/examples/users/list-mfa-factors.md @@ -0,0 +1,12 @@ +from appwrite.client import Client + +client = Client() +client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint +client.set_project('5df5acd0d48c2') # Your project ID +client.set_key('919c2d18fb5d4...a2ae413da83346ad2') # Your secret API key + +users = Users(client) + +result = users.list_mfa_factors( + user_id = '<USER_ID>' +) diff --git a/docs/examples/users/list-sessions.md b/docs/examples/users/list-sessions.md index 5f8fbd6..f4a5946 100644 --- a/docs/examples/users/list-sessions.md +++ b/docs/examples/users/list-sessions.md @@ -1,14 +1,12 @@ from appwrite.client import Client -from appwrite.services.users import Users 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 -) +client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint +client.set_project('5df5acd0d48c2') # Your project ID +client.set_key('919c2d18fb5d4...a2ae413da83346ad2') # Your secret API key users = Users(client) -result = users.list_sessions('[USER_ID]') +result = users.list_sessions( + user_id = '<USER_ID>' +) diff --git a/docs/examples/users/list-targets.md b/docs/examples/users/list-targets.md new file mode 100644 index 0000000..3b1e28b --- /dev/null +++ b/docs/examples/users/list-targets.md @@ -0,0 +1,13 @@ +from appwrite.client import Client + +client = Client() +client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint +client.set_project('5df5acd0d48c2') # Your project ID +client.set_key('919c2d18fb5d4...a2ae413da83346ad2') # Your secret API key + +users = Users(client) + +result = users.list_targets( + user_id = '<USER_ID>', + queries = [] # optional +) diff --git a/docs/examples/users/list.md b/docs/examples/users/list.md index baaf42c..9dbe774 100644 --- a/docs/examples/users/list.md +++ b/docs/examples/users/list.md @@ -1,14 +1,13 @@ from appwrite.client import Client -from appwrite.services.users import Users 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 -) +client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint +client.set_project('5df5acd0d48c2') # Your project ID +client.set_key('919c2d18fb5d4...a2ae413da83346ad2') # Your secret API key users = Users(client) -result = users.list() +result = users.list( + queries = [], # optional + search = '<SEARCH>' # optional +) diff --git a/docs/examples/users/update-email-verification.md b/docs/examples/users/update-email-verification.md index 8be33ad..7c541c9 100644 --- a/docs/examples/users/update-email-verification.md +++ b/docs/examples/users/update-email-verification.md @@ -1,14 +1,13 @@ from appwrite.client import Client -from appwrite.services.users import Users 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 -) +client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint +client.set_project('5df5acd0d48c2') # Your project ID +client.set_key('919c2d18fb5d4...a2ae413da83346ad2') # Your secret API key users = Users(client) -result = users.update_email_verification('[USER_ID]', False) +result = users.update_email_verification( + user_id = '<USER_ID>', + email_verification = False +) diff --git a/docs/examples/users/update-email.md b/docs/examples/users/update-email.md index 4899bd3..e1c95ee 100644 --- a/docs/examples/users/update-email.md +++ b/docs/examples/users/update-email.md @@ -1,14 +1,13 @@ from appwrite.client import Client -from appwrite.services.users import Users 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 -) +client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint +client.set_project('5df5acd0d48c2') # Your project ID +client.set_key('919c2d18fb5d4...a2ae413da83346ad2') # Your secret API key users = Users(client) -result = users.update_email('[USER_ID]', 'email@example.com') +result = users.update_email( + user_id = '<USER_ID>', + email = 'email@example.com' +) diff --git a/docs/examples/users/update-labels.md b/docs/examples/users/update-labels.md index b2d4c2d..2a54e76 100644 --- a/docs/examples/users/update-labels.md +++ b/docs/examples/users/update-labels.md @@ -1,14 +1,13 @@ from appwrite.client import Client -from appwrite.services.users import Users 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 -) +client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint +client.set_project('5df5acd0d48c2') # Your project ID +client.set_key('919c2d18fb5d4...a2ae413da83346ad2') # Your secret API key users = Users(client) -result = users.update_labels('[USER_ID]', []) +result = users.update_labels( + user_id = '<USER_ID>', + labels = [] +) diff --git a/docs/examples/users/update-mfa-recovery-codes.md b/docs/examples/users/update-mfa-recovery-codes.md new file mode 100644 index 0000000..5ff7bfe --- /dev/null +++ b/docs/examples/users/update-mfa-recovery-codes.md @@ -0,0 +1,12 @@ +from appwrite.client import Client + +client = Client() +client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint +client.set_project('5df5acd0d48c2') # Your project ID +client.set_key('919c2d18fb5d4...a2ae413da83346ad2') # Your secret API key + +users = Users(client) + +result = users.update_mfa_recovery_codes( + user_id = '<USER_ID>' +) diff --git a/docs/examples/users/update-mfa.md b/docs/examples/users/update-mfa.md new file mode 100644 index 0000000..305566a --- /dev/null +++ b/docs/examples/users/update-mfa.md @@ -0,0 +1,13 @@ +from appwrite.client import Client + +client = Client() +client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint +client.set_project('5df5acd0d48c2') # Your project ID +client.set_key('919c2d18fb5d4...a2ae413da83346ad2') # Your secret API key + +users = Users(client) + +result = users.update_mfa( + user_id = '<USER_ID>', + mfa = False +) diff --git a/docs/examples/users/update-name.md b/docs/examples/users/update-name.md index 66bb6b2..17ebfb6 100644 --- a/docs/examples/users/update-name.md +++ b/docs/examples/users/update-name.md @@ -1,14 +1,13 @@ from appwrite.client import Client -from appwrite.services.users import Users 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 -) +client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint +client.set_project('5df5acd0d48c2') # Your project ID +client.set_key('919c2d18fb5d4...a2ae413da83346ad2') # Your secret API key users = Users(client) -result = users.update_name('[USER_ID]', '[NAME]') +result = users.update_name( + user_id = '<USER_ID>', + name = '<NAME>' +) diff --git a/docs/examples/users/update-password.md b/docs/examples/users/update-password.md index e79f125..1ee3edb 100644 --- a/docs/examples/users/update-password.md +++ b/docs/examples/users/update-password.md @@ -1,14 +1,13 @@ from appwrite.client import Client -from appwrite.services.users import Users 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 -) +client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint +client.set_project('5df5acd0d48c2') # Your project ID +client.set_key('919c2d18fb5d4...a2ae413da83346ad2') # Your secret API key users = Users(client) -result = users.update_password('[USER_ID]', '') +result = users.update_password( + user_id = '<USER_ID>', + password = '' +) diff --git a/docs/examples/users/update-phone-verification.md b/docs/examples/users/update-phone-verification.md index e42317c..70ce29f 100644 --- a/docs/examples/users/update-phone-verification.md +++ b/docs/examples/users/update-phone-verification.md @@ -1,14 +1,13 @@ from appwrite.client import Client -from appwrite.services.users import Users 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 -) +client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint +client.set_project('5df5acd0d48c2') # Your project ID +client.set_key('919c2d18fb5d4...a2ae413da83346ad2') # Your secret API key users = Users(client) -result = users.update_phone_verification('[USER_ID]', False) +result = users.update_phone_verification( + user_id = '<USER_ID>', + phone_verification = False +) diff --git a/docs/examples/users/update-phone.md b/docs/examples/users/update-phone.md index 6df39fc..10c5e61 100644 --- a/docs/examples/users/update-phone.md +++ b/docs/examples/users/update-phone.md @@ -1,14 +1,13 @@ from appwrite.client import Client -from appwrite.services.users import Users 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 -) +client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint +client.set_project('5df5acd0d48c2') # Your project ID +client.set_key('919c2d18fb5d4...a2ae413da83346ad2') # Your secret API key users = Users(client) -result = users.update_phone('[USER_ID]', '+12065550100') +result = users.update_phone( + user_id = '<USER_ID>', + number = '+12065550100' +) diff --git a/docs/examples/users/update-prefs.md b/docs/examples/users/update-prefs.md index 53d1e52..df77346 100644 --- a/docs/examples/users/update-prefs.md +++ b/docs/examples/users/update-prefs.md @@ -1,14 +1,13 @@ from appwrite.client import Client -from appwrite.services.users import Users 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 -) +client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint +client.set_project('5df5acd0d48c2') # Your project ID +client.set_key('919c2d18fb5d4...a2ae413da83346ad2') # Your secret API key users = Users(client) -result = users.update_prefs('[USER_ID]', {}) +result = users.update_prefs( + user_id = '<USER_ID>', + prefs = {} +) diff --git a/docs/examples/users/update-status.md b/docs/examples/users/update-status.md index 6d1577d..6b8e8b8 100644 --- a/docs/examples/users/update-status.md +++ b/docs/examples/users/update-status.md @@ -1,14 +1,13 @@ from appwrite.client import Client -from appwrite.services.users import Users 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 -) +client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint +client.set_project('5df5acd0d48c2') # Your project ID +client.set_key('919c2d18fb5d4...a2ae413da83346ad2') # Your secret API key users = Users(client) -result = users.update_status('[USER_ID]', False) +result = users.update_status( + user_id = '<USER_ID>', + status = False +) diff --git a/docs/examples/users/update-target.md b/docs/examples/users/update-target.md new file mode 100644 index 0000000..c7ec1a6 --- /dev/null +++ b/docs/examples/users/update-target.md @@ -0,0 +1,16 @@ +from appwrite.client import Client + +client = Client() +client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint +client.set_project('5df5acd0d48c2') # Your project ID +client.set_key('919c2d18fb5d4...a2ae413da83346ad2') # Your secret API key + +users = Users(client) + +result = users.update_target( + user_id = '<USER_ID>', + target_id = '<TARGET_ID>', + identifier = '<IDENTIFIER>', # optional + provider_id = '<PROVIDER_ID>', # optional + name = '<NAME>' # optional +) diff --git a/setup.py b/setup.py index 49f3672..d330bb7 100644 --- a/setup.py +++ b/setup.py @@ -8,7 +8,7 @@ setuptools.setup( name = 'appwrite', packages = ['appwrite', 'appwrite/services'], - version = '4.1.0', + version = '5.0.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.1.0.tar.gz', + download_url='https://github.com/appwrite/sdk-for-python/archive/5.0.0.tar.gz', # keywords = ['SOME', 'MEANINGFULL', 'KEYWORDS'], install_requires=[ 'requests',