Merge pull request #6 from appwrite/dev

christyjacob4 · web-flow · commit bddfa8fb5cd0 · 2021-07-07T15:45:40.000+05:30
feat: update version
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,3 +1,12 @@
+## 0.7.0
+- Support for Appwrite 0.9
+- Breaking - removed order type enum, now you should pass string &#039;ASC&#039; or &#039;DESC&#039;
+- Breaking - changed param name from `env` to `runtime` in the **Functions** API
+- Image Crop Gravity support in image preview service
+- New endpoint in Account getSession to get session by ID
+- New endpoint in the Users API to update user verification status 
+- Fix - issues with User-Agent when app name consisted of non-ASCII characters
+
 ## 0.6.2
 
 - Removed default values, nothing should change in usage as default values are already allocated in server
@@ -37,4 +46,4 @@
 
 ## 0.1.0
 
-- First release
+- First release
diff --git a/README.md b/README.md
@@ -2,17 +2,16 @@
 
 [![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.8.0-blue.svg?style=flat-square)
+![Version](https://img.shields.io/badge/api%20version-0.9.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_io?color=00acee&label=twitter&style=flat-square)](https://twitter.com/appwrite_io)
 [![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.8.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.9.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)
 
-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 Dart 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 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 Dart 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)
 
 
 
@@ -24,7 +23,7 @@ Add this to your package's `pubspec.yaml` file:
 
 ```yml
 dependencies:
-  dart_appwrite: ^0.6.3
+  dart_appwrite: ^0.7.0
 ```
 
 You can install packages from the command line:
@@ -76,7 +75,7 @@ try {
 ```
 
 ### Learn more
-You can use followng resources to learn more and get help
+You can use following resources to learn more and get help
 - 🚀 [Getting Started Tutorial](https://appwrite.io/docs/getting-started-for-server)
 - 📜 [Appwrite Docs](https://appwrite.io/docs)
 - 💬 [Discord Community](https://appwrite.io/discord)
diff --git a/docs/examples/account/get-session.md b/docs/examples/account/get-session.md
@@ -0,0 +1,23 @@
+import 'package:dart_appwrite/dart_appwrite.dart';
+
+void main() { // Init SDK
+  Client client = Client();
+  Account account = Account(client);
+
+  client
+    .setEndpoint('https://[HOSTNAME_OR_IP]/v1') // Your API Endpoint
+    .setProject('5df5acd0d48c2') // Your project ID
+    .setJWT('eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ...') // Your secret JSON Web Token
+  ;
+
+  Future result = account.getSession(
+    sessionId: '[SESSION_ID]',
+  );
+
+  result
+    .then((response) {
+      print(response);
+    }).catchError((error) {
+      print(error.response);
+  });
+}
diff --git a/docs/examples/functions/create.md b/docs/examples/functions/create.md
@@ -13,7 +13,7 @@ void main() { // Init SDK
   Future result = functions.create(
     name: '[NAME]',
     execute: [],
-    env: 'dotnet-3.1',
+    runtime: 'java-11.0',
   );
 
   result
diff --git a/docs/examples/users/update-verification.md b/docs/examples/users/update-verification.md
@@ -0,0 +1,24 @@
+import 'package:dart_appwrite/dart_appwrite.dart';
+
+void main() { // Init SDK
+  Client client = 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 = users.updateVerification(
+    userId: '[USER_ID]',
+    emailVerification: false,
+  );
+
+  result
+    .then((response) {
+      print(response);
+    }).catchError((error) {
+      print(error.response);
+  });
+}
diff --git a/lib/client.dart b/lib/client.dart
@@ -13,8 +13,8 @@ class Client {
         
         this.headers = {
             'content-type': 'application/json',
-            'x-sdk-version': 'appwrite:dart:0.6.3',
-            'X-Appwrite-Response-Format':'0.8.0',
+            'x-sdk-version': 'appwrite:dart:0.7.0',
+            'X-Appwrite-Response-Format':'0.9.0',
         };
 
         this.config = {};
@@ -82,7 +82,9 @@ class Client {
             };
         }
 
-        params.removeWhere((key,value) => value == null);
+        if(params.isNotEmpty) {
+            params.removeWhere((key,value) => value == null);
+        }
 
         // Origin is hardcoded for testing
         Options options = Options(
@@ -127,4 +129,4 @@ class Client {
           throw AppwriteException(e.toString());
         }
     }
-}
+}
diff --git a/lib/enums.dart b/lib/enums.dart
@@ -7,11 +7,3 @@ extension HttpMethodString on HttpMethod {
     return this.toString().split('.').last.toUpperCase();
   }
 }
-
-enum OrderType { asc, desc }
-
-extension OrderTypeString on OrderType {
-  String name() {
-    return this.toString().split('.').last.toUpperCase();
-  }
-}
diff --git a/lib/services/account.dart b/lib/services/account.dart
@@ -250,6 +250,24 @@ class Account extends Service {
         return client.call(HttpMethod.delete, path: path, params: params, headers: headers);
     }
 
+     /// Get Session By ID
+     ///
+     /// Use this endpoint to get a logged in user's session using a Session ID.
+     /// Inputting 'current' will return the current session being used.
+     ///
+    Future<Response> getSession({required String sessionId}) {
+        final String path = '/account/sessions/{sessionId}'.replaceAll(RegExp('{sessionId}'), sessionId);
+
+        final Map<String, dynamic> params = {
+        };
+
+        final Map<String, String> headers = {
+            'content-type': 'application/json',
+        };
+
+        return client.call(HttpMethod.get, path: path, params: params, headers: headers);
+    }
+
      /// Delete Account Session
      ///
      /// Use this endpoint to log out the currently logged in user from all their
diff --git a/lib/services/database.dart b/lib/services/database.dart
@@ -11,14 +11,14 @@ class Database extends Service {
      /// of the project's collections. [Learn more about different API
      /// modes](/docs/admin).
      ///
-    Future<Response> listCollections({String? search, int? limit, int? offset, OrderType? orderType}) {
+    Future<Response> listCollections({String? search, int? limit, int? offset, String? orderType}) {
         final String path = '/database/collections';
 
         final Map<String, dynamic> params = {
             'search': search,
             'limit': limit,
             'offset': offset,
-            'orderType': orderType?.name(),
+            'orderType': orderType,
         };
 
         final Map<String, String> headers = {
@@ -113,15 +113,15 @@ class Database extends Service {
      /// of the project's documents. [Learn more about different API
      /// modes](/docs/admin).
      ///
-    Future<Response> listDocuments({required String collectionId, List? filters, int? limit, int? offset, String? orderField, OrderType? orderType, String? orderCast, String? search}) {
+    Future<Response> listDocuments({required String collectionId, List? filters, int? limit, int? offset, String? orderField, String? orderType, String? orderCast, String? search}) {
         final String path = '/database/collections/{collectionId}/documents'.replaceAll(RegExp('{collectionId}'), collectionId);
 
         final Map<String, dynamic> params = {
             'filters': filters,
             'limit': limit,
             'offset': offset,
             'orderField': orderField,
-            'orderType': orderType?.name(),
+            'orderType': orderType,
             'orderCast': orderCast,
             'search': search,
         };
diff --git a/lib/services/functions.dart b/lib/services/functions.dart
@@ -9,14 +9,14 @@ class Functions extends Service {
      /// Get a list of all the project's functions. You can use the query params to
      /// filter your results.
      ///
-    Future<Response> list({String? search, int? limit, int? offset, OrderType? orderType}) {
+    Future<Response> list({String? search, int? limit, int? offset, String? orderType}) {
         final String path = '/functions';
 
         final Map<String, dynamic> params = {
             'search': search,
             'limit': limit,
             'offset': offset,
-            'orderType': orderType?.name(),
+            'orderType': orderType,
         };
 
         final Map<String, String> headers = {
@@ -32,13 +32,13 @@ class Functions extends Service {
      /// [permissions](/docs/permissions) to allow different project users or team
      /// with access to execute the function using the client API.
      ///
-    Future<Response> create({required String name, required List execute, required String env, Map? vars, List? events, String? schedule, int? timeout}) {
+    Future<Response> create({required String name, required List execute, required String runtime, Map? vars, List? events, String? schedule, int? timeout}) {
         final String path = '/functions';
 
         final Map<String, dynamic> params = {
             'name': name,
             'execute': execute,
-            'env': env,
+            'runtime': runtime,
             'vars': vars,
             'events': events,
             'schedule': schedule,
@@ -116,14 +116,14 @@ class Functions extends Service {
      /// return a list of all of the project's executions. [Learn more about
      /// different API modes](/docs/admin).
      ///
-    Future<Response> listExecutions({required String functionId, String? search, int? limit, int? offset, OrderType? orderType}) {
+    Future<Response> listExecutions({required String functionId, String? search, int? limit, int? offset, String? orderType}) {
         final String path = '/functions/{functionId}/executions'.replaceAll(RegExp('{functionId}'), functionId);
 
         final Map<String, dynamic> params = {
             'search': search,
             'limit': limit,
             'offset': offset,
-            'orderType': orderType?.name(),
+            'orderType': orderType,
         };
 
         final Map<String, String> headers = {
@@ -196,14 +196,14 @@ class Functions extends Service {
      /// Get a list of all the project's code tags. You can use the query params to
      /// filter your results.
      ///
-    Future<Response> listTags({required String functionId, String? search, int? limit, int? offset, OrderType? orderType}) {
+    Future<Response> listTags({required String functionId, String? search, int? limit, int? offset, String? orderType}) {
         final String path = '/functions/{functionId}/tags'.replaceAll(RegExp('{functionId}'), functionId);
 
         final Map<String, dynamic> params = {
             'search': search,
             'limit': limit,
             'offset': offset,
-            'orderType': orderType?.name(),
+            'orderType': orderType,
         };
 
         final Map<String, String> headers = {
diff --git a/lib/services/storage.dart b/lib/services/storage.dart
@@ -10,14 +10,14 @@ class Storage extends Service {
      /// your results. On admin mode, this endpoint will return a list of all of the
      /// project's files. [Learn more about different API modes](/docs/admin).
      ///
-    Future<Response> listFiles({String? search, int? limit, int? offset, OrderType? orderType}) {
+    Future<Response> listFiles({String? search, int? limit, int? offset, String? orderType}) {
         final String path = '/storage/files';
 
         final Map<String, dynamic> params = {
             'search': search,
             'limit': limit,
             'offset': offset,
-            'orderType': orderType?.name(),
+            'orderType': orderType,
         };
 
         final Map<String, String> headers = {
@@ -133,12 +133,13 @@ class Storage extends Service {
      /// and spreadsheets, will return the file icon image. You can also pass query
      /// string arguments for cutting and resizing your preview image.
      ///
-    Future<Response> getFilePreview({required String fileId, int? width, int? height, int? quality, int? borderWidth, String? borderColor, int? borderRadius, double? opacity, int? rotation, String? background, String? output}) {
+    Future<Response> getFilePreview({required String fileId, int? width, int? height, String? gravity, int? quality, int? borderWidth, String? borderColor, int? borderRadius, double? opacity, int? rotation, String? background, String? output}) {
         final String path = '/storage/files/{fileId}/preview'.replaceAll(RegExp('{fileId}'), fileId);
 
         final Map<String, dynamic> params = {
             'width': width,
             'height': height,
+            'gravity': gravity,
             'quality': quality,
             'borderWidth': borderWidth,
             'borderColor': borderColor,
diff --git a/lib/services/teams.dart b/lib/services/teams.dart
@@ -11,14 +11,14 @@ class Teams extends Service {
      /// of the project's teams. [Learn more about different API
      /// modes](/docs/admin).
      ///
-    Future<Response> list({String? search, int? limit, int? offset, OrderType? orderType}) {
+    Future<Response> list({String? search, int? limit, int? offset, String? orderType}) {
         final String path = '/teams';
 
         final Map<String, dynamic> params = {
             'search': search,
             'limit': limit,
             'offset': offset,
-            'orderType': orderType?.name(),
+            'orderType': orderType,
         };
 
         final Map<String, String> headers = {
@@ -110,14 +110,14 @@ class Teams extends Service {
      /// Get a team members by the team unique ID. All team members have read access
      /// for this list of resources.
      ///
-    Future<Response> getMemberships({required String teamId, String? search, int? limit, int? offset, OrderType? orderType}) {
+    Future<Response> getMemberships({required String teamId, String? search, int? limit, int? offset, String? orderType}) {
         final String path = '/teams/{teamId}/memberships'.replaceAll(RegExp('{teamId}'), teamId);
 
         final Map<String, dynamic> params = {
             'search': search,
             'limit': limit,
             'offset': offset,
-            'orderType': orderType?.name(),
+            'orderType': orderType,
         };
 
         final Map<String, String> headers = {
diff --git a/lib/services/users.dart b/lib/services/users.dart
@@ -9,14 +9,14 @@ class Users extends Service {
      /// Get a list of all the project's users. You can use the query params to
      /// filter your results.
      ///
-    Future<Response> list({String? search, int? limit, int? offset, OrderType? orderType}) {
+    Future<Response> list({String? search, int? limit, int? offset, String? orderType}) {
         final String path = '/users';
 
         final Map<String, dynamic> params = {
             'search': search,
             'limit': limit,
             'offset': offset,
-            'orderType': orderType?.name(),
+            'orderType': orderType,
         };
 
         final Map<String, String> headers = {
@@ -199,6 +199,24 @@ class Users extends Service {
             'content-type': 'application/json',
         };
 
+        return client.call(HttpMethod.patch, path: path, params: params, headers: headers);
+    }
+
+     /// Update Email Verification
+     ///
+     /// Update the user email verification status by its unique ID.
+     ///
+    Future<Response> updateVerification({required String userId, required bool emailVerification}) {
+        final String path = '/users/{userId}/verification'.replaceAll(RegExp('{userId}'), userId);
+
+        final Map<String, dynamic> params = {
+            'emailVerification': emailVerification,
+        };
+
+        final Map<String, String> headers = {
+            'content-type': 'application/json',
+        };
+
         return client.call(HttpMethod.patch, path: path, params: params, headers: headers);
     }
 }
diff --git a/pubspec.yaml b/pubspec.yaml

Original file line number	Diff line number	Diff line change
`@@ -7,11 +7,3 @@ extension HttpMethodString on HttpMethod {`
`7`	`7`	`return this.toString().split('.').last.toUpperCase();`
`8`	`8`	`}`
`9`	`9`	`}`
`10`		`-`
`11`		`-enum OrderType { asc, desc }`
`12`		`-`
`13`		`-extension OrderTypeString on OrderType {`
`14`		`- String name() {`
`15`		`- return this.toString().split('.').last.toUpperCase();`
`16`		`- }`
`17`		`-}`