Merge pull request #93 from appwrite/dev

feat: Dart SDK update for version 19.1.0

Author: abnegate

CHANGELOG.md

@@ -1,5 +1,10 @@
 # Change Log
 
+## 19.1.0
+
+* Deprecate `createVerification` method in `Account` service
+* Add `createEmailVerification` method in `Account` service
+
 ## 18.1.0
 
 * Add `orderRandom` query support

README.md

@@ -23,7 +23,7 @@ Add this to your package's `pubspec.yaml` file:
 
 ```yml
 dependencies:
-  dart_appwrite: ^19.0.0
+  dart_appwrite: ^19.1.0
 ```
 
 You can install packages from the command line:

docs/examples/account/create-email-verification.md

@@ -0,0 +1,12 @@
+import 'package:dart_appwrite/dart_appwrite.dart';
+
+Client client = Client()
+    .setEndpoint('https://<REGION>.cloud.appwrite.io/v1') // Your API Endpoint
+    .setProject('<YOUR_PROJECT_ID>') // Your project ID
+    .setSession(''); // The user session to authenticate with
+
+Account account = Account(client);
+
+Token result = await account.createEmailVerification(
+    url: 'https://example.com',
+);

docs/examples/account/update-email-verification.md

@@ -0,0 +1,13 @@
+import 'package:dart_appwrite/dart_appwrite.dart';
+
+Client client = Client()
+    .setEndpoint('https://<REGION>.cloud.appwrite.io/v1') // Your API Endpoint
+    .setProject('<YOUR_PROJECT_ID>') // Your project ID
+    .setSession(''); // The user session to authenticate with
+
+Account account = Account(client);
+
+Token result = await account.updateEmailVerification(
+    userId: '<USER_ID>',
+    secret: '<SECRET>',
+);

lib/services/account.dart

@@ -1235,8 +1235,43 @@ class Account extends Service {
   /// the only valid redirect URLs are the ones from domains you have set when
   /// adding your platforms in the console interface.
   ///
+  Future<models.Token> createEmailVerification({required String url}) async {
+    final String apiPath = '/account/verifications/email';
+
+    final Map<String, dynamic> apiParams = {'url': url};
+
+    final Map<String, String> apiHeaders = {'content-type': 'application/json'};
+
+    final res = await client.call(
+      HttpMethod.post,
+      path: apiPath,
+      params: apiParams,
+      headers: apiHeaders,
+    );
+
+    return models.Token.fromMap(res.data);
+  }
+
+  /// Use this endpoint to send a verification message to your user email address
+  /// to confirm they are the valid owners of that address. Both the **userId**
+  /// and **secret** arguments will be passed as query parameters to the URL you
+  /// have provided to be attached to the verification email. The provided URL
+  /// should redirect the user back to your app and allow you to complete the
+  /// verification process by verifying both the **userId** and **secret**
+  /// parameters. Learn more about how to [complete the verification
+  /// process](https://appwrite.io/docs/references/cloud/client-web/account#updateVerification).
+  /// The verification link sent to the user's email address is valid for 7 days.
+  ///
+  /// Please note that in order to avoid a [Redirect
+  /// Attack](https://github.com/OWASP/CheatSheetSeries/blob/master/cheatsheets/Unvalidated_Redirects_and_Forwards_Cheat_Sheet.md),
+  /// the only valid redirect URLs are the ones from domains you have set when
+  /// adding your platforms in the console interface.
+  ///
+  @Deprecated(
+    'This API has been deprecated since 1.8.0. Please use `Account.createEmailVerification` instead.',
+  )
   Future<models.Token> createVerification({required String url}) async {
-    final String apiPath = '/account/verification';
+    final String apiPath = '/account/verifications/email';
 
     final Map<String, dynamic> apiParams = {'url': url};
 
@@ -1256,11 +1291,38 @@ class Account extends Service {
   /// the **userId** and **secret** parameters that were attached to your app URL
   /// to verify the user email ownership. If confirmed this route will return a
   /// 200 status code.
+  Future<models.Token> updateEmailVerification({
+    required String userId,
+    required String secret,
+  }) async {
+    final String apiPath = '/account/verifications/email';
+
+    final Map<String, dynamic> apiParams = {'userId': userId, 'secret': secret};
+
+    final Map<String, String> apiHeaders = {'content-type': 'application/json'};
+
+    final res = await client.call(
+      HttpMethod.put,
+      path: apiPath,
+      params: apiParams,
+      headers: apiHeaders,
+    );
+
+    return models.Token.fromMap(res.data);
+  }
+
+  /// Use this endpoint to complete the user email verification process. Use both
+  /// the **userId** and **secret** parameters that were attached to your app URL
+  /// to verify the user email ownership. If confirmed this route will return a
+  /// 200 status code.
+  @Deprecated(
+    'This API has been deprecated since 1.8.0. Please use `Account.updateEmailVerification` instead.',
+  )
   Future<models.Token> updateVerification({
     required String userId,
     required String secret,
   }) async {
-    final String apiPath = '/account/verification';
+    final String apiPath = '/account/verifications/email';
 
     final Map<String, dynamic> apiParams = {'userId': userId, 'secret': secret};
 
@@ -1285,7 +1347,7 @@ class Account extends Service {
   /// The verification code sent to the user's phone number is valid for 15
   /// minutes.
   Future<models.Token> createPhoneVerification() async {
-    final String apiPath = '/account/verification/phone';
+    final String apiPath = '/account/verifications/phone';
 
     final Map<String, dynamic> apiParams = {};
 
@@ -1309,7 +1371,7 @@ class Account extends Service {
     required String userId,
     required String secret,
   }) async {
-    final String apiPath = '/account/verification/phone';
+    final String apiPath = '/account/verifications/phone';
 
     final Map<String, dynamic> apiParams = {'userId': userId, 'secret': secret};
 

lib/services/functions.dart

@@ -360,7 +360,7 @@ class Functions extends Service {
   /// Create a deployment based on a template.
   ///
   /// Use this endpoint with combination of
-  /// [listTemplates](https://appwrite.io/docs/server/functions#listTemplates) to
+  /// [listTemplates](https://appwrite.io/docs/products/functions/templates) to
   /// find the template details.
   Future<models.Deployment> createTemplateDeployment({
     required String functionId,

lib/services/sites.dart

@@ -338,8 +338,8 @@ class Sites extends Service {
   /// Create a deployment based on a template.
   ///
   /// Use this endpoint with combination of
-  /// [listTemplates](https://appwrite.io/docs/server/sites#listTemplates) to
-  /// find the template details.
+  /// [listTemplates](https://appwrite.io/docs/products/sites/templates) to find
+  /// the template details.
   Future<models.Deployment> createTemplateDeployment({
     required String siteId,
     required String repository,

lib/services/tables_db.dart

@@ -155,7 +155,7 @@ class TablesDB extends Service {
 
   /// Create a new Table. Before using this route, you should create a new
   /// database resource using either a [server
-  /// integration](https://appwrite.io/docs/server/tablesdb#tablesDBCreateTable)
+  /// integration](https://appwrite.io/docs/references/cloud/server-dart/tablesDB#createTable)
   /// API or directly from your database console.
   Future<models.Table> createTable({
     required String databaseId,
@@ -1396,7 +1396,7 @@ class TablesDB extends Service {
 
   /// Create a new Row. Before using this route, you should create a new table
   /// resource using either a [server
-  /// integration](https://appwrite.io/docs/server/tablesdb#tablesDBCreateTable)
+  /// integration](https://appwrite.io/docs/references/cloud/server-dart/tablesDB#createTable)
   /// API or directly from your database console.
   Future<models.Row> createRow({
     required String databaseId,
@@ -1429,7 +1429,7 @@ class TablesDB extends Service {
 
   /// Create new Rows. Before using this route, you should create a new table
   /// resource using either a [server
-  /// integration](https://appwrite.io/docs/server/tablesdb#tablesDBCreateTable)
+  /// integration](https://appwrite.io/docs/references/cloud/server-dart/tablesDB#createTable)
   /// API or directly from your database console.
   Future<models.RowList> createRows({
     required String databaseId,
@@ -1456,7 +1456,7 @@ class TablesDB extends Service {
 
   /// Create or update Rows. Before using this route, you should create a new
   /// table resource using either a [server
-  /// integration](https://appwrite.io/docs/server/tablesdb#tablesDBCreateTable)
+  /// integration](https://appwrite.io/docs/references/cloud/server-dart/tablesDB#createTable)
   /// API or directly from your database console.
   ///
   Future<models.RowList> upsertRows({
@@ -1563,7 +1563,7 @@ class TablesDB extends Service {
 
   /// Create or update a Row. Before using this route, you should create a new
   /// table resource using either a [server
-  /// integration](https://appwrite.io/docs/server/tablesdb#tablesDBCreateTable)
+  /// integration](https://appwrite.io/docs/references/cloud/server-dart/tablesDB#createTable)
   /// API or directly from your database console.
   Future<models.Row> upsertRow({
     required String databaseId,

lib/src/client_browser.dart

@@ -30,7 +30,7 @@ class ClientBrowser extends ClientBase with ClientMixin {
       'x-sdk-name': 'Dart',
       'x-sdk-platform': 'server',
       'x-sdk-language': 'dart',
-      'x-sdk-version': '19.0.0',
+      'x-sdk-version': '19.1.0',
       'X-Appwrite-Response-Format': '1.8.0',
     };
 

lib/src/client_io.dart

@@ -36,9 +36,9 @@ class ClientIO extends ClientBase with ClientMixin {
       'x-sdk-name': 'Dart',
       'x-sdk-platform': 'server',
       'x-sdk-language': 'dart',
-      'x-sdk-version': '19.0.0',
+      'x-sdk-version': '19.1.0',
       'user-agent':
-          'AppwriteDartSDK/19.0.0 (${Platform.operatingSystem}; ${Platform.operatingSystemVersion})',
+          'AppwriteDartSDK/19.1.0 (${Platform.operatingSystem}; ${Platform.operatingSystemVersion})',
       'X-Appwrite-Response-Format': '1.8.0',
     };