feat: support for 0.14.x

Author: TorstenDittmann

README.md

@@ -2,12 +2,12 @@
 
 [![pub package](https://img.shields.io/pub/v/dart_appwrite.svg?style=flat-square)](https://pub.dartlang.org/packages/dart_appwrite)
 ![License](https://img.shields.io/github/license/appwrite/sdk-for-dart.svg?style=flat-square)
-![Version](https://img.shields.io/badge/api%20version-0.13.0-blue.svg?style=flat-square)
+![Version](https://img.shields.io/badge/api%20version-0.14.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 0.13.x. For older versions, please check [previous releases](https://github.com/appwrite/sdk-for-dart/releases).**
+**This SDK is compatible with Appwrite server version 0.14.x. For older versions, please check [previous releases](https://github.com/appwrite/sdk-for-dart/releases).**
 
  > This is the Dart SDK for integrating with Appwrite from your Dart server-side code. If you're looking for the Flutter SDK you should check [appwrite/sdk-for-flutter](https://github.com/appwrite/sdk-for-flutter)
 
@@ -23,7 +23,7 @@ Add this to your package's `pubspec.yaml` file:
 
 ```yml
 dependencies:
-  dart_appwrite: ^4.0.2
+  dart_appwrite: ^5.0.0
 ```
 
 You can install packages from the command line:

docs/examples/account/delete.md docs/examples/account/update-status.mddocs/examples/account/delete.md renamed to docs/examples/account/update-status.md

@@ -10,7 +10,7 @@ void main() { // Init SDK
     .setJWT('eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ...') // Your secret JSON Web Token
   ;
 
-  Future result = account.delete();
+  Future result = account.updateStatus();
 
   result
     .then((response) {

docs/examples/health/get-queue-usage.md docs/examples/users/get-memberships.mddocs/examples/health/get-queue-usage.md renamed to docs/examples/users/get-memberships.md

@@ -2,15 +2,17 @@ import 'package:dart_appwrite/dart_appwrite.dart';
 
 void main() { // Init SDK
   Client client = Client();
-  Health health = Health(client);
+  Users users = Users(client);
 
   client
     .setEndpoint('https://[HOSTNAME_OR_IP]/v1') // Your API Endpoint
     .setProject('5df5acd0d48c2') // Your project ID
     .setKey('919c2d18fb5d4...a2ae413da83346ad2') // Your secret API key
   ;
 
-  Future result = health.getQueueUsage();
+  Future result = users.getMemberships(
+    userId: '[USER_ID]',
+  );
 
   result
     .then((response) {

lib/services/account.dart

@@ -23,29 +23,6 @@ class Account extends Service {
         return models.User.fromMap(res.data);
     }
 
-     /// Delete Account
-     ///
-     /// Delete a currently logged in user account. Behind the scene, the user
-     /// record is not deleted but permanently blocked from any access. This is done
-     /// to avoid deleted accounts being overtaken by new users with the same email
-     /// address. Any user-related resources like documents or storage files should
-     /// be deleted separately.
-     ///
-     Future delete() async {
-        final String path = '/account';
-
-        final Map<String, dynamic> params = {
-        };
-
-        final Map<String, String> headers = {
-            'content-type': 'application/json',
-        };
-
-
-        final res = await client.call(HttpMethod.delete, path: path, params: params, headers: headers);
-        return  res.data;
-    }
-
      /// Update Account Email
      ///
      /// Update currently logged in user account email address. After changing user
@@ -120,7 +97,7 @@ class Account extends Service {
      ///
      /// Update currently logged in user password. For validation, user is required
      /// to pass in the new password, and the old password. For users created with
-     /// OAuth and Team Invites, oldPassword is optional.
+     /// OAuth, Team Invites and Magic URL, oldPassword is optional.
      ///
      Future<models.User> updatePassword({required String password, String? oldPassword}) async {
         final String path = '/account/password';
@@ -300,6 +277,11 @@ class Account extends Service {
     }
 
      /// Update Session (Refresh Tokens)
+     ///
+     /// Access tokens have limited lifespan and expire to mitigate security risks.
+     /// If session was created using an OAuth provider, this route can be used to
+     /// "refresh" the access token.
+     ///
      Future<models.Session> updateSession({required String sessionId}) async {
         final String path = '/account/sessions/{sessionId}'.replaceAll('{sessionId}', sessionId);
 
@@ -337,6 +319,27 @@ class Account extends Service {
         return  res.data;
     }
 
+     /// Update Account Status
+     ///
+     /// Block the currently logged in user account. Behind the scene, the user
+     /// record is not deleted but permanently blocked from any access. To
+     /// completely delete a user, use the Users API instead.
+     ///
+     Future<models.User> updateStatus() async {
+        final String path = '/account/status';
+
+        final Map<String, dynamic> params = {
+        };
+
+        final Map<String, String> headers = {
+            'content-type': 'application/json',
+        };
+
+
+        final res = await client.call(HttpMethod.patch, path: path, params: params, headers: headers);
+        return models.User.fromMap(res.data);
+    }
+
      /// Create Email Verification
      ///
      /// Use this endpoint to send a verification message to your user email address

lib/services/avatars.dart

@@ -8,9 +8,14 @@ class Avatars extends Service {
      /// Get Browser Icon
      ///
      /// You can use this endpoint to show different browser icons to your users.
-     /// The code argument receives the browser code as it appears in your user
-     /// /account/sessions endpoint. Use width, height and quality arguments to
-     /// change the output settings.
+     /// The code argument receives the browser code as it appears in your user [GET
+     /// /account/sessions](/docs/client/account#accountGetSessions) endpoint. Use
+     /// width, height and quality arguments to change the output settings.
+     /// 
+     /// When one dimension is specified and the other is 0, the image is scaled
+     /// with preserved aspect ratio. If both dimensions are 0, the API provides an
+     /// image at source quality. If dimensions are not specified, the default size
+     /// of image returned is 100x100px.
      ///
      Future<Uint8List>  getBrowser({required String code, int? width, int? height, int? quality}) async {
         final String path = '/avatars/browsers/{code}'.replaceAll('{code}', code);
@@ -32,6 +37,12 @@ class Avatars extends Service {
      /// The credit card endpoint will return you the icon of the credit card
      /// provider you need. Use width, height and quality arguments to change the
      /// output settings.
+     /// 
+     /// When one dimension is specified and the other is 0, the image is scaled
+     /// with preserved aspect ratio. If both dimensions are 0, the API provides an
+     /// image at source quality. If dimensions are not specified, the default size
+     /// of image returned is 100x100px.
+     /// 
      ///
      Future<Uint8List>  getCreditCard({required String code, int? width, int? height, int? quality}) async {
         final String path = '/avatars/credit-cards/{code}'.replaceAll('{code}', code);
@@ -72,6 +83,12 @@ class Avatars extends Service {
      /// You can use this endpoint to show different country flags icons to your
      /// users. The code argument receives the 2 letter country code. Use width,
      /// height and quality arguments to change the output settings.
+     /// 
+     /// When one dimension is specified and the other is 0, the image is scaled
+     /// with preserved aspect ratio. If both dimensions are 0, the API provides an
+     /// image at source quality. If dimensions are not specified, the default size
+     /// of image returned is 100x100px.
+     /// 
      ///
      Future<Uint8List>  getFlag({required String code, int? width, int? height, int? quality}) async {
         final String path = '/avatars/flags/{code}'.replaceAll('{code}', code);
@@ -94,6 +111,12 @@ class Avatars extends Service {
      /// you want. This endpoint is very useful if you need to crop and display
      /// remote images in your app or in case you want to make sure a 3rd party
      /// image is properly served using a TLS protocol.
+     /// 
+     /// When one dimension is specified and the other is 0, the image is scaled
+     /// with preserved aspect ratio. If both dimensions are 0, the API provides an
+     /// image at source quality. If dimensions are not specified, the default size
+     /// of image returned is 400x400px.
+     /// 
      ///
      Future<Uint8List>  getImage({required String url, int? width, int? height}) async {
         final String path = '/avatars/image';
@@ -122,6 +145,12 @@ class Avatars extends Service {
      /// default, a random theme will be selected. The random theme will persist for
      /// the user's initials when reloading the same theme will always return for
      /// the same initials.
+     /// 
+     /// When one dimension is specified and the other is 0, the image is scaled
+     /// with preserved aspect ratio. If both dimensions are 0, the API provides an
+     /// image at source quality. If dimensions are not specified, the default size
+     /// of image returned is 100x100px.
+     /// 
      ///
      Future<Uint8List>  getInitials({String? name, int? width, int? height, String? color, String? background}) async {
         final String path = '/avatars/initials';
@@ -144,6 +173,7 @@ class Avatars extends Service {
      ///
      /// Converts a given plain text to a QR code image. You can use the query
      /// parameters to change the size and style of the resulting image.
+     /// 
      ///
      Future<Uint8List>  getQR({required String text, int? size, int? margin, bool? download}) async {
         final String path = '/avatars/qr';

lib/services/database.dart

@@ -465,9 +465,7 @@ class Database extends Service {
 
      /// Delete Document
      ///
-     /// Delete a document by its unique ID. This endpoint deletes only the parent
-     /// documents, its attributes and relations to other documents. Child documents
-     /// **will not** be deleted.
+     /// Delete a document by its unique ID.
      ///
      Future deleteDocument({required String collectionId, required String documentId}) async {
         final String path = '/database/collections/{collectionId}/documents/{documentId}'.replaceAll('{collectionId}', collectionId).replaceAll('{documentId}', documentId);

lib/services/functions.dart

@@ -60,7 +60,7 @@ class Functions extends Service {
         return models.Func.fromMap(res.data);
     }
 
-     /// List the currently active function runtimes.
+     /// List runtimes
      ///
      /// Get a list of all runtimes that are currently active on your instance.
      ///

lib/services/health.dart

@@ -135,26 +135,6 @@ class Health extends Service {
         };
 
 
-        final res = await client.call(HttpMethod.get, path: path, params: params, headers: headers);
-        return models.HealthQueue.fromMap(res.data);
-    }
-
-     /// Get Usage Queue
-     ///
-     /// Get the number of usage stats that are waiting to be processed in the
-     /// Appwrite internal queue server.
-     ///
-     Future<models.HealthQueue> getQueueUsage() async {
-        final String path = '/health/queue/usage';
-
-        final Map<String, dynamic> params = {
-        };
-
-        final Map<String, String> headers = {
-            'content-type': 'application/json',
-        };
-
-
         final res = await client.call(HttpMethod.get, path: path, params: params, headers: headers);
         return models.HealthQueue.fromMap(res.data);
     }

lib/services/users.dart

@@ -74,7 +74,11 @@ class Users extends Service {
 
      /// Delete User
      ///
-     /// Delete a user by its unique ID.
+     /// Delete a user by its unique ID, thereby releasing it's ID. Since ID is
+     /// released and can be reused, all user-related resources like documents or
+     /// storage files should be deleted before user deletion. If you want to keep
+     /// ID reserved, use the [updateStatus](/docs/server/users#usersUpdateStatus)
+     /// endpoint instead.
      ///
      Future delete({required String userId}) async {
         final String path = '/users/{userId}'.replaceAll('{userId}', userId);
@@ -132,6 +136,25 @@ class Users extends Service {
         return models.LogList.fromMap(res.data);
     }
 
+     /// Get User Memberships
+     ///
+     /// Get the user membership list by its unique ID.
+     ///
+     Future<models.MembershipList> getMemberships({required String userId}) async {
+        final String path = '/users/{userId}/memberships'.replaceAll('{userId}', userId);
+
+        final Map<String, dynamic> params = {
+        };
+
+        final Map<String, String> headers = {
+            'content-type': 'application/json',
+        };
+
+
+        final res = await client.call(HttpMethod.get, path: path, params: params, headers: headers);
+        return models.MembershipList.fromMap(res.data);
+    }
+
      /// Update Name
      ///
      /// Update the user name by its unique ID.
@@ -272,7 +295,8 @@ class Users extends Service {
 
      /// Update User Status
      ///
-     /// Update the user status by its unique ID.
+     /// Update the user status by its unique ID. Use this endpoint as an
+     /// alternative to deleting a user if you want to keep user's ID reserved.
      ///
      Future<models.User> updateStatus({required String userId, required bool status}) async {
         final String path = '/users/{userId}/status'.replaceAll('{userId}', userId);

lib/src/client_browser.dart

@@ -26,7 +26,7 @@ class ClientBrowser extends ClientBase with ClientMixin {
     _httpClient = BrowserClient();
     _headers = {
       'content-type': 'application/json',
-      'x-sdk-version': 'appwrite:dart:4.0.2',
+      'x-sdk-version': 'appwrite:dart:5.0.0',
       'X-Appwrite-Response-Format' : '0.13.0',
     };