v3.3.5

Author: agordn52

CHANGELOG.md

@@ -1,3 +1,8 @@
+## [3.3.5] - 2024-03-15
+
+* Added new networking methods for WooCommerce Points and Rewards
+* Dependency updates
+
 ## [3.3.4] - 2024-01-01
 
 * Update license date

README.md

@@ -28,7 +28,7 @@ In your flutter project add the dependency:
 ``` dart 
 dependencies:
   ...
-  wp_json_api: ^3.3.4
+  wp_json_api: ^3.4.0
 ```
 
 ### Usage example #
@@ -240,6 +240,29 @@ WCCustomerUpdatedResponse wcCustomerUpdatedResponse = await WPJsonAPI.instance
         ));
 ```
 
+#### WooCommerce Points and Rewards - Get user's points 
+- This is used to get the user's current points in the [WooCommerce Points and Rewards](https://woo.com/products/woocommerce-points-and-rewards/) plugin
+- The first parameter is the **userToken** which is returned from the login/register response. You should have this saved somewhere e.g. shared_pref
+
+``` dart
+WcPointsAndRewardUser wcPointsAndRewardUser = await WPJsonAPI.instance
+          .api((request) => request.wcPointsAndRewardsUser(
+          userToken
+      ));
+```
+
+#### WooCommerce Points and Rewards - Calculate the value of points
+- This is used to calculate the value of points in the [WooCommerce Points and Rewards](https://woo.com/products/woocommerce-points-and-rewards/) plugin
+- The first parameter is the **userToken** which is returned from the login/register response. You should have this saved somewhere e.g. shared_pref
+
+``` dart
+WcPointsAndRewardCalculatePoints wcPointsAndRewardsCalculatePoints = await WPJsonAPI.instance
+          .api((request) => request.wcPointsAndRewardsCalculatePoints(
+          userToken,
+          points: 100
+      ));
+```
+
 For help getting started with WooSignal, view our
 [online documentation](https://woosignal.com/docs/flutter/wp-json-api), which offers a more detailed guide.
 

example/pubspec.lock

@@ -45,10 +45,10 @@ packages:
     dependency: transitive
     description:
       name: dio
-      sha256: "797e1e341c3dd2f69f2dad42564a6feff3bfb87187d05abb93b9609e6f1645c3"
+      sha256: "49af28382aefc53562459104f64d16b9dfd1e8ef68c862d5af436cc8356ce5a8"
       url: "https://pub.dev"
     source: hosted
-    version: "5.4.0"
+    version: "5.4.1"
   fake_async:
     dependency: transitive
     description:
@@ -75,38 +75,62 @@ packages:
       url: "https://pub.dev"
     source: hosted
     version: "4.0.2"
+  leak_tracker:
+    dependency: transitive
+    description:
+      name: leak_tracker
+      sha256: "78eb209deea09858f5269f5a5b02be4049535f568c07b275096836f01ea323fa"
+      url: "https://pub.dev"
+    source: hosted
+    version: "10.0.0"
+  leak_tracker_flutter_testing:
+    dependency: transitive
+    description:
+      name: leak_tracker_flutter_testing
+      sha256: b46c5e37c19120a8a01918cfaf293547f47269f7cb4b0058f21531c2465d6ef0
+      url: "https://pub.dev"
+    source: hosted
+    version: "2.0.1"
+  leak_tracker_testing:
+    dependency: transitive
+    description:
+      name: leak_tracker_testing
+      sha256: a597f72a664dbd293f3bfc51f9ba69816f84dcd403cdac7066cb3f6003f3ab47
+      url: "https://pub.dev"
+    source: hosted
+    version: "2.0.1"
   matcher:
     dependency: transitive
     description:
       name: matcher
-      sha256: "1803e76e6653768d64ed8ff2e1e67bea3ad4b923eb5c56a295c3e634bad5960e"
+      sha256: d2323aa2060500f906aa31a895b4030b6da3ebdcc5619d14ce1aada65cd161cb
       url: "https://pub.dev"
     source: hosted
-    version: "0.12.16"
+    version: "0.12.16+1"
   material_color_utilities:
     dependency: transitive
     description:
       name: material_color_utilities
-      sha256: "9528f2f296073ff54cb9fee677df673ace1218163c3bc7628093e7eed5203d41"
+      sha256: "0e0a020085b65b6083975e499759762399b4475f766c21668c4ecca34ea74e5a"
       url: "https://pub.dev"
     source: hosted
-    version: "0.5.0"
+    version: "0.8.0"
   meta:
     dependency: transitive
     description:
       name: meta
-      sha256: a6e590c838b18133bb482a2745ad77c5bb7715fb0451209e1a7567d416678b8e
+      sha256: d584fa6707a52763a52446f02cc621b077888fb63b93bbcb1143a7be5a0c0c04
       url: "https://pub.dev"
     source: hosted
-    version: "1.10.0"
+    version: "1.11.0"
   path:
     dependency: transitive
     description:
       name: path
-      sha256: "8829d8a55c13fc0e37127c29fedf290c102f4e40ae94ada574091fe0ff96c917"
+      sha256: "087ce49c3f0dc39180befefc60fdb4acd8f8620e5682fe2476afd0b3688bb4af"
       url: "https://pub.dev"
     source: hosted
-    version: "1.8.3"
+    version: "1.9.0"
   sky_engine:
     dependency: transitive
     description: flutter
@@ -176,14 +200,14 @@ packages:
       url: "https://pub.dev"
     source: hosted
     version: "2.1.4"
-  web:
+  vm_service:
     dependency: transitive
     description:
-      name: web
-      sha256: afe077240a270dcfd2aafe77602b4113645af95d0ad31128cc02bce5ac5d5152
+      name: vm_service
+      sha256: b3d56ff4341b8f182b96aceb2fa20e3dcb336b9f867bc0eafc0de10f1048e957
       url: "https://pub.dev"
     source: hosted
-    version: "0.3.0"
+    version: "13.0.0"
   wp_json_api:
     dependency: "direct dev"
     description:
@@ -192,5 +216,5 @@ packages:
     source: path
     version: "3.3.4"
 sdks:
-  dart: ">=3.2.0-194.0.dev <4.0.0"
+  dart: ">=3.2.0-0 <4.0.0"
   flutter: ">=1.17.0"

lib/enums/wp_route_type.dart

@@ -61,4 +61,8 @@ enum WPRouteType {
   /// Route type [WPRouteType.WCCustomerUpdateInfo] is used to Update WooCommerce details for a customer.
   /// For WooCommerce
   WCCustomerUpdateInfo,
+
+  WCPointsAndRewardsUser,
+
+  WCPointsAndRewardsCalculatePoints,
 }

lib/models/responses/wc_points_and_rewards_calculate_points.dart

@@ -0,0 +1,30 @@
+// Copyright (c) 2024, 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 WcPointsAndRewardCalculatePoints {
+  String? value;
+
+  WcPointsAndRewardCalculatePoints({this.value});
+
+  WcPointsAndRewardCalculatePoints.fromJson(Map<String, dynamic> json) {
+    value = json['value'];
+  }
+
+  Map<String, dynamic> toJson() {
+    final Map<String, dynamic> data = new Map<String, dynamic>();
+    data['value'] = this.value;
+    return data;
+  }
+}

lib/models/responses/wc_points_and_rewards_user.dart

@@ -0,0 +1,36 @@
+// Copyright (c) 2024, 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 WcPointsAndRewardUser {
+  int? id;
+  int? points;
+  String? value;
+
+  WcPointsAndRewardUser({this.id, this.points, this.value});
+
+  WcPointsAndRewardUser.fromJson(Map<String, dynamic> json) {
+    id = json['id'];
+    points = json['points'];
+    value = json['value'];
+  }
+
+  Map<String, dynamic> toJson() {
+    final Map<String, dynamic> data = new Map<String, dynamic>();
+    data['id'] = this.id;
+    data['points'] = this.points;
+    data['value'] = this.value;
+    return data;
+  }
+}

lib/networking/network_manager.dart

@@ -32,6 +32,8 @@ import 'package:wp_json_api/exceptions/username_taken_exception.dart';
 import 'package:wp_json_api/exceptions/woocommerce_not_found_exception.dart';
 import 'package:wp_json_api/models/responses/wc_customer_info_response.dart';
 import 'package:wp_json_api/models/responses/wc_customer_updated_response.dart';
+import 'package:wp_json_api/models/responses/wc_points_and_rewards_calculate_points.dart';
+import 'package:wp_json_api/models/responses/wc_points_and_rewards_user.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';
@@ -344,6 +346,44 @@ class WPAppNetworkManager {
         : WCCustomerInfoResponse.fromJson(json);
   }
 
+  /// Get the users points and rewards information using the [userToken].
+  ///
+  /// Returns a [WcPointsAndRewardUser] future.
+  /// Throws an [Exception] if fails.
+  Future<WcPointsAndRewardUser> wcPointsAndRewardsUser(String userToken) async {
+    // send http request
+    final json = await _http(
+      method: "POST",
+      url: _urlForRouteType(WPRouteType.WCPointsAndRewardsUser),
+      userToken: userToken,
+    );
+
+    // return response
+    return _jsonHasBadStatus(json)
+        ? this._throwExceptionForStatusCode(json)
+        : WcPointsAndRewardUser.fromJson(json['data']);
+  }
+
+  /// Calculate the value of points using the [userToken] and [points].
+  ///
+  /// Returns a [WcPointsAndRewardCalculatePoints] future.
+  /// Throws an [Exception] if fails.
+  Future<WcPointsAndRewardCalculatePoints> wcPointsAndRewardsCalculatePoints(
+      String userToken,
+      {required double points}) async {
+    // send http request
+    final json = await _http(
+        method: "POST",
+        url: _urlForRouteType(WPRouteType.WCPointsAndRewardsCalculatePoints),
+        userToken: userToken,
+        body: {"points": points});
+
+    // return response
+    return _jsonHasBadStatus(json)
+        ? this._throwExceptionForStatusCode(json)
+        : WcPointsAndRewardCalculatePoints.fromJson(json['data']);
+  }
+
   /// Sends a request to update a users WooCommerce details using
   /// a valid [userToken], set optional parameters for updating user.
   ///
@@ -579,6 +619,14 @@ class WPAppNetworkManager {
         {
           return "/wpapp/wc/$apiVersion/update/user/info";
         }
+      case WPRouteType.WCPointsAndRewardsUser:
+        {
+          return "/wpapp/wc-points-and-rewards/$apiVersion/user";
+        }
+      case WPRouteType.WCPointsAndRewardsCalculatePoints:
+        {
+          return "/wpapp/wc-points-and-rewards/$apiVersion/calculate_points";
+        }
       default:
         {
           return "";