v3.2.0 updates

agordn52 · agordn52 · commit 49872493f07e · 2022-07-07T21:20:10.000+07:00
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,3 +1,8 @@
+## [3.2.0] - 2022-07-07
+
+* New API to delete an account
+* Update code docs
+
 ## [3.1.3] - 2021-09-03
 
 * Add roles to wp_user_info_response
diff --git a/LICENSE b/LICENSE
@@ -1,6 +1,6 @@
 BSD 2-Clause License
 
-Copyright (c) 2021, WooSignal Ltd
+Copyright (c) 2022, WooSignal Ltd
 All rights reserved.
 
 Redistribution and use in source and binary forms, with or without
diff --git a/README.md b/README.md
@@ -13,6 +13,7 @@
 * Update Users Password
 * Add role to a user
 * Remove role from a user
+* Delete a user
 
 **WooCommerce**
 
@@ -27,7 +28,7 @@ In your flutter project add the dependency:
 ``` dart 
 dependencies:
   ...
-  wp_json_api: ^3.1.3
+  wp_json_api: ^3.2.0
 ```
 
 ### Usage example #
@@ -179,6 +180,18 @@ WPUserRemoveRoleResponse wpUserRemoveRoleResponse = await WPJsonAPI.instance
         ));
 ```
 
+#### WordPress - Delete a user
+- Used to delete a user in WordPress
+- The first parameter is the **userToken** which is returned from the login/register response. You should have this saved somewhere e.g. shared_pref
+- You can pass an optional argument 'reassign' to reassign posts and links to new User ID.
+
+``` dart
+WPUserDeleteResponse wpUserDeleteResponse = await WPJsonAPI.instance
+        .api((request) => request.wpUserDelete(
+            userToken
+        ));
+```
+
 #### WooCommerce - Get users info in WooCommerce
 - Used to get WooCommerce info for a given user
 - The first parameter is the **userToken** which is returned from the login/register response. You should have this saved somewhere e.g. shared_pref
diff --git a/lib/enums/wp_auth_type.dart b/lib/enums/wp_auth_type.dart
@@ -1,4 +1,4 @@
-// Copyright (c) 2021, WooSignal Ltd.
+// Copyright (c) 2022, WooSignal Ltd.
 // All rights reserved.
 //
 // Redistribution and use in source and binary forms are permitted
diff --git a/lib/enums/wp_meta_data_action_type.dart b/lib/enums/wp_meta_data_action_type.dart
@@ -1,4 +1,4 @@
-// Copyright (c) 2021, WooSignal Ltd.
+// Copyright (c) 2022, WooSignal Ltd.
 // All rights reserved.
 //
 // Redistribution and use in source and binary forms are permitted
diff --git a/lib/enums/wp_route_type.dart b/lib/enums/wp_route_type.dart
@@ -1,4 +1,4 @@
-// Copyright (c) 2021, WooSignal Ltd.
+// Copyright (c) 2022, WooSignal Ltd.
 // All rights reserved.
 //
 // Redistribution and use in source and binary forms are permitted
@@ -42,6 +42,10 @@ enum WPRouteType {
   /// For WordPress
   UserLogin,
 
+  /// Route type [WPRouteType.UserDelete] is used to delete a user from WordPress.
+  /// For WordPress
+  UserDelete,
+
   /// Route type [WPRouteType.AuthNonce] is used to get a nonce token to authenticate future API requests.
   /// For WordPress
   AuthNonce,
diff --git a/lib/exceptions/empty_username_exception.dart b/lib/exceptions/empty_username_exception.dart
@@ -1,4 +1,4 @@
-// Copyright (c) 2021, WooSignal Ltd.
+// Copyright (c) 2022, WooSignal Ltd.
 // All rights reserved.
 //
 // Redistribution and use in source and binary forms are permitted
diff --git a/lib/exceptions/existing_user_email_exception.dart b/lib/exceptions/existing_user_email_exception.dart
@@ -1,4 +1,4 @@
-// Copyright (c) 2021, WooSignal Ltd.
+// Copyright (c) 2022, WooSignal Ltd.
 // All rights reserved.
 //
 // Redistribution and use in source and binary forms are permitted
diff --git a/lib/exceptions/existing_user_login_exception.dart b/lib/exceptions/existing_user_login_exception.dart
@@ -1,4 +1,4 @@
-// Copyright (c) 2021, WooSignal Ltd.
+// Copyright (c) 2022, WooSignal Ltd.
 // All rights reserved.
 //
 // Redistribution and use in source and binary forms are permitted
diff --git a/lib/exceptions/incorrect_password_exception.dart b/lib/exceptions/incorrect_password_exception.dart
@@ -1,4 +1,4 @@
-// Copyright (c) 2021, WooSignal Ltd.
+// Copyright (c) 2022, WooSignal Ltd.
 // All rights reserved.
 //
 // Redistribution and use in source and binary forms are permitted
diff --git a/lib/exceptions/invalid_email_exception.dart b/lib/exceptions/invalid_email_exception.dart
@@ -1,4 +1,4 @@
-// Copyright (c) 2021, WooSignal Ltd.
+// Copyright (c) 2022, WooSignal Ltd.
 // All rights reserved.
 //
 // Redistribution and use in source and binary forms are permitted
diff --git a/lib/exceptions/invalid_nonce_exception.dart b/lib/exceptions/invalid_nonce_exception.dart
@@ -1,4 +1,4 @@
-// Copyright (c) 2021, WooSignal Ltd.
+// Copyright (c) 2022, WooSignal Ltd.
 // All rights reserved.
 //
 // Redistribution and use in source and binary forms are permitted
diff --git a/lib/exceptions/invalid_params_exception.dart b/lib/exceptions/invalid_params_exception.dart
@@ -1,4 +1,4 @@
-// Copyright (c) 2021, WooSignal Ltd.
+// Copyright (c) 2022, WooSignal Ltd.
 // All rights reserved.
 //
 // Redistribution and use in source and binary forms are permitted
diff --git a/lib/exceptions/invalid_user_token_exception.dart b/lib/exceptions/invalid_user_token_exception.dart
@@ -1,4 +1,4 @@
-// Copyright (c) 2021, WooSignal Ltd.
+// Copyright (c) 2022, WooSignal Ltd.
 // All rights reserved.
 //
 // Redistribution and use in source and binary forms are permitted
diff --git a/lib/exceptions/invalid_username_exception.dart b/lib/exceptions/invalid_username_exception.dart
@@ -1,4 +1,4 @@
-// Copyright (c) 2021, WooSignal Ltd.
+// Copyright (c) 2022, WooSignal Ltd.
 // All rights reserved.
 //
 // Redistribution and use in source and binary forms are permitted
diff --git a/lib/exceptions/user_already_exist_exception.dart b/lib/exceptions/user_already_exist_exception.dart
@@ -1,4 +1,4 @@
-// Copyright (c) 2021, WooSignal Ltd.
+// Copyright (c) 2022, WooSignal Ltd.
 // All rights reserved.
 //
 // Redistribution and use in source and binary forms are permitted
diff --git a/lib/exceptions/user_exists_exception.dart b/lib/exceptions/user_exists_exception.dart
@@ -1,4 +1,4 @@
-// Copyright (c) 2021, WooSignal Ltd.
+// Copyright (c) 2022, WooSignal Ltd.
 // All rights reserved.
 //
 // Redistribution and use in source and binary forms are permitted
diff --git a/lib/exceptions/username_taken_exception.dart b/lib/exceptions/username_taken_exception.dart
@@ -1,4 +1,4 @@
-// Copyright (c) 2021, WooSignal Ltd.
+// Copyright (c) 2022, WooSignal Ltd.
 // All rights reserved.
 //
 // Redistribution and use in source and binary forms are permitted
diff --git a/lib/exceptions/woocommerce_not_found_exception.dart b/lib/exceptions/woocommerce_not_found_exception.dart
@@ -1,4 +1,4 @@
-// Copyright (c) 2021, WooSignal Ltd.
+// Copyright (c) 2022, WooSignal Ltd.
 // All rights reserved.
 //
 // Redistribution and use in source and binary forms are permitted
diff --git a/lib/helpers/typedefs.dart b/lib/helpers/typedefs.dart
@@ -1,4 +1,4 @@
-// Copyright (c) 2021, WooSignal Ltd.
+// Copyright (c) 2022, WooSignal Ltd.
 // All rights reserved.
 //
 // Redistribution and use in source and binary forms are permitted
diff --git a/lib/models/responses/wc_customer_info_response.dart b/lib/models/responses/wc_customer_info_response.dart
@@ -1,4 +1,4 @@
-// Copyright (c) 2021, WooSignal Ltd.
+// Copyright (c) 2022, WooSignal Ltd.
 // All rights reserved.
 //
 // Redistribution and use in source and binary forms are permitted
diff --git a/lib/models/responses/wc_customer_updated_response.dart b/lib/models/responses/wc_customer_updated_response.dart
@@ -1,4 +1,4 @@
-// Copyright (c) 2021, WooSignal Ltd.
+// Copyright (c) 2022, WooSignal Ltd.
 // All rights reserved.
 //
 // Redistribution and use in source and binary forms are permitted
diff --git a/lib/models/responses/wp_nonce_response.dart b/lib/models/responses/wp_nonce_response.dart
@@ -1,4 +1,4 @@
-// Copyright (c) 2021, WooSignal Ltd.
+// Copyright (c) 2022, WooSignal Ltd.
 // All rights reserved.
 //
 // Redistribution and use in source and binary forms are permitted
diff --git a/lib/models/responses/wp_nonce_verified_response.dart b/lib/models/responses/wp_nonce_verified_response.dart
@@ -1,4 +1,4 @@
-// Copyright (c) 2021, WooSignal Ltd.
+// Copyright (c) 2022, WooSignal Ltd.
 // All rights reserved.
 //
 // Redistribution and use in source and binary forms are permitted
diff --git a/lib/models/responses/wp_user_add_role_response.dart b/lib/models/responses/wp_user_add_role_response.dart
@@ -1,4 +1,4 @@
-// Copyright (c) 2021, WooSignal Ltd.
+// Copyright (c) 2022, WooSignal Ltd.
 // All rights reserved.
 //
 // Redistribution and use in source and binary forms are permitted
diff --git a/lib/models/responses/wp_user_delete_response.dart b/lib/models/responses/wp_user_delete_response.dart
@@ -0,0 +1,40 @@
+// Copyright (c) 2022, WooSignal Ltd.
+// All rights reserved.
+//
+// Redistribution and use in source and binary forms are permitted
+// provided that the above copyright notice and this paragraph are
+// duplicated in all such forms and that any documentation,
+// advertising materials, and other materials related to such
+// distribution and use acknowledge that the software was developed
+// by the WooSignal. The name of the
+// WooSignal may not be used to endorse or promote products derived
+// from this software without specific prior written permission.
+// THIS SOFTWARE IS PROVIDED ``AS IS'' AND WITHOUT ANY EXPRESS OR
+// IMPLIED WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED
+// WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE.
+
+class WPUserDeleteResponse {
+  List<dynamic>? data;
+  String? message;
+  int? status;
+
+  WPUserDeleteResponse({this.data, this.message, this.status});
+
+  WPUserDeleteResponse.fromJson(Map<String, dynamic> json) {
+    if (json['data'] != null) {
+      data = json['data'];
+    }
+    message = json['message'];
+    status = json['status'];
+  }
+
+  Map<String, dynamic> toJson() {
+    final Map<String, dynamic> data = new Map<String, dynamic>();
+    if (this.data != null) {
+      data['data'] = this.data!.map((v) => v.toJson()).toList();
+    }
+    data['message'] = this.message;
+    data['status'] = this.status;
+    return data;
+  }
+}
diff --git a/lib/models/responses/wp_user_info_response.dart b/lib/models/responses/wp_user_info_response.dart
@@ -1,4 +1,4 @@
-// Copyright (c) 2021, WooSignal Ltd.
+// Copyright (c) 2022, WooSignal Ltd.
 // All rights reserved.
 //
 // Redistribution and use in source and binary forms are permitted
diff --git a/lib/models/responses/wp_user_info_updated_response.dart b/lib/models/responses/wp_user_info_updated_response.dart
@@ -1,4 +1,4 @@
-// Copyright (c) 2021, WooSignal Ltd.
+// Copyright (c) 2022, WooSignal Ltd.
 // All rights reserved.
 //
 // Redistribution and use in source and binary forms are permitted
diff --git a/lib/models/responses/wp_user_login_response.dart b/lib/models/responses/wp_user_login_response.dart
@@ -1,4 +1,4 @@
-// Copyright (c) 2021, WooSignal Ltd.
+// Copyright (c) 2022, WooSignal Ltd.
 // All rights reserved.
 //
 // Redistribution and use in source and binary forms are permitted
diff --git a/lib/models/responses/wp_user_register_response.dart b/lib/models/responses/wp_user_register_response.dart
@@ -1,4 +1,4 @@
-// Copyright (c) 2021, WooSignal Ltd.
+// Copyright (c) 2022, WooSignal Ltd.
 // All rights reserved.
 //
 // Redistribution and use in source and binary forms are permitted
diff --git a/lib/models/responses/wp_user_remove_role_response.dart b/lib/models/responses/wp_user_remove_role_response.dart
@@ -1,4 +1,4 @@
-// Copyright (c) 2021, WooSignal Ltd.
+// Copyright (c) 2022, WooSignal Ltd.
 // All rights reserved.
 //
 // Redistribution and use in source and binary forms are permitted
diff --git a/lib/models/responses/wp_user_reset_password_response.dart b/lib/models/responses/wp_user_reset_password_response.dart
@@ -1,4 +1,4 @@
-// Copyright (c) 2021, WooSignal Ltd.
+// Copyright (c) 2022, WooSignal Ltd.
 // All rights reserved.
 //
 // Redistribution and use in source and binary forms are permitted
diff --git a/lib/models/wp_meta_meta.dart b/lib/models/wp_meta_meta.dart
@@ -1,4 +1,4 @@
-// Copyright (c) 2021, WooSignal Ltd.
+// Copyright (c) 2022, WooSignal Ltd.
 // All rights reserved.
 //
 // Redistribution and use in source and binary forms are permitted
diff --git a/lib/networking/network_manager.dart b/lib/networking/network_manager.dart
@@ -1,4 +1,4 @@
-// Copyright (c) 2021, WooSignal Ltd.
+// Copyright (c) 2022, WooSignal Ltd.
 // All rights reserved.
 //
 // Redistribution and use in source and binary forms are permitted
@@ -35,6 +35,7 @@ import 'package:wp_json_api/models/responses/wc_customer_updated_response.dart';
 import 'package:wp_json_api/models/responses/wp_nonce_response.dart';
 import 'package:wp_json_api/models/responses/wp_nonce_verified_response.dart';
 import 'package:wp_json_api/models/responses/wp_user_add_role_response.dart';
+import 'package:wp_json_api/models/responses/wp_user_delete_response.dart';
 import 'package:wp_json_api/models/responses/wp_user_info_updated_response.dart';
 import 'package:wp_json_api/models/responses/wp_user_login_response.dart';
 import 'package:wp_json_api/models/responses/wp_user_register_response.dart';
@@ -262,6 +263,31 @@ class WPAppNetworkManager {
         : WPUserAddRoleResponse.fromJson(json);
   }
 
+  /// Sends a request to delete a WordPress user. Include a valid
+  /// [userToken] and an optional [reassign] argument to send a successful request.
+  ///
+  /// Returns a [WPUserDeleteResponse] future.
+  /// Throws an [Exception] if fails.
+  Future<WPUserDeleteResponse> wpUserDelete(userToken, {int? reassign}) async {
+    Map<String, dynamic> payload = {};
+    if (reassign != null) {
+      payload["reassign"] = reassign;
+    }
+
+    // send http request
+    final json = await _http(
+      method: "POST",
+      url: _urlForRouteType(WPRouteType.UserDelete),
+      userToken: userToken,
+      body: payload,
+    );
+
+    // return response
+    return _jsonHasBadStatus(json)
+        ? this._throwExceptionForStatusCode(json)
+        : WPUserDeleteResponse.fromJson(json);
+  }
+
   /// Sends a request to remove a role from a WordPress user. Include a valid
   /// [userToken] and [role] to send a successful request.
   ///
@@ -556,6 +582,10 @@ class WPAppNetworkManager {
         {
           return "/wpapp/api/$apiVersion/update/user/password";
         }
+      case WPRouteType.UserDelete:
+        {
+          return "/wpapp/api/$apiVersion/user/delete";
+        }
 
       // WOOCOMMERCE API
       case WPRouteType.WCCustomerInfo:
diff --git a/lib/wp_json_api.dart b/lib/wp_json_api.dart
@@ -1,4 +1,4 @@
-// Copyright (c) 2021, WooSignal Ltd.
+// Copyright (c) 2022, WooSignal Ltd.
 // All rights reserved.
 //
 // Redistribution and use in source and binary forms are permitted
diff --git a/pubspec.lock b/pubspec.lock
diff --git a/pubspec.yaml b/pubspec.yaml

Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-// Copyright (c) 2021, WooSignal Ltd.`
	`1`	`+// Copyright (c) 2022, WooSignal Ltd.`
`2`	`2`	`// All rights reserved.`
`3`	`3`	`//`
`4`	`4`	`// Redistribution and use in source and binary forms are permitted`