Merge pull request #3 from woosignal/master

v3.0.0 - updates

Author: agordn52

.gitignore

@@ -8,3 +8,4 @@ build/
 # Omit committing pubspec.lock for library packages; see
 # https://dart.dev/guides/libraries/private-files#pubspeclock.
 pubspec.lock
+lib/env.dart

.idea/libraries/Dart_Packages.xml

@@ -1,3 +1,11 @@
+## [3.0.0] - 2021-12-16
+
+* Breaking changes
+* Major refactor to woosignal.dart class
+* Added CustomerDownload model
+* Ability to store theme colors, theme font and social links in WooSignalApp class
+* Dependency updates
+
 ## [2.2.1] - 2021-11-02
 
 * Update readme

.idea/libraries/Flutter_Plugins.xml

@@ -3,7 +3,7 @@
 [Official WooSignal WooCommerce package](https://woosignal.com)
 
 Build apps for WooCommerce easier with our new package.
-Our API provides many requests types e.g. getProducts, getOrders, getCustomers and many more.
+Our API provides many requests types e.g. getProducts, getOrders and many more.
 Free to get started, see the simple examples below.
 
 For help getting started with WooSignal, view our
@@ -15,7 +15,7 @@ In your flutter project add the dependency:
 ``` dart 
 dependencies:
   ...
-  woosignal: ^2.2.1
+  woosignal: ^3.0.0
 ```
 
 ### Usage example #
@@ -34,16 +34,13 @@ import 'package:woosignal/woosignal.dart';
 // EXAMPLE GET PRODUCTS
 _getProducts() async {
 
-        // CONFIG FOR WOOSIGNAL
-        var wsConfig = {
-          "appKey":"your app key",
-          "debugMode":true
-        };
+        // Step 1 - Initialize WooSignal
+        WooSignal wooSignal = await WooSignal.instance.init(appKey: "your app key");
 
-        // CREATING AN INSTANCE
-        WooSignal wooSignal = await WooSignal.getInstance(config: wsConfig);
-        List<Product> products = await wooSignal.getProducts();
-        print(products[0].name);
+        // Step 2 - Call an API
+        List<Product> products = await WooSignal.instance.getProducts();
+
+        print(products[0].name); // prints a product name
   });
 }
 ```
@@ -218,4 +215,4 @@ _getProducts() async {
 [See Setting options API](https://woosignal.com/docs/api/1.0/setting-options)
 
 
-Disclaimer: This plugin is not affiliated with or supported by Automattic, Inc. All logos and trademarks are the property of their respective owners.
+Disclaimer: This plugin is not affiliated with or supported by Automattic, Inc. All logos and trademarks are the property of their respective owners.

.idea/misc.xml

@@ -1,5 +1,6 @@
 import 'package:flutter/material.dart';
 import 'package:woosignal/woosignal.dart';
+import 'package:woosignal/models/response/products.dart';
 
 void woosignal_woocommerce_example() => runApp(MyApp());
 
@@ -29,15 +30,14 @@ class _MyHomePageState extends State<MyHomePage> {
   String _productName = "";
 
   _incrementCounter() async {
-    // CONFIG FOR WOOSIGNAL
-    var wsConfig = {"appKey": "your app key", "debugMode": true};
+    // CREATING AN INSTANCE FOR WOOSIGNAL
+    WooSignal wooSignal = await WooSignal.instance.init(appKey: "your app key");
 
-    // CREATING AN INSTANCE
-    WooSignal wooSignal = await WooSignal.getInstance(config: wsConfig);
-
-    setState(() {
-      _productName = "";
-    });
+    List<Product> products = await wooSignal.getProducts();
+    if (products.isNotEmpty) {
+      _productName = products[0].name ?? "";
+    }
+    setState(() {});
   }
 
   @override
@@ -50,13 +50,11 @@ class _MyHomePageState extends State<MyHomePage> {
         child: Column(
           mainAxisAlignment: MainAxisAlignment.center,
           children: <Widget>[
-            Text(
-              'WooCommerce product :',
-            ),
-            Text(
-              '$_productName',
-              style: Theme.of(context).textTheme.headline4,
-            ),
+            Text('Tap the light bulb to get a product'),
+            if (_productName != "")
+              Text(
+                'WooCommerce product :\n $_productName',
+              ),
           ],
         ),
       ),

.idea/vcs.xml

@@ -2,18 +2,19 @@ name: woosignal_woocommerce_example
 description: Demonstrates how to use the woosignal plugin.
 
 environment:
-  sdk: '>=2.14.4 <3.0.0'
+  sdk: '>=2.15.0 <3.0.0'
 
 dependencies:
   flutter:
     sdk: flutter
 dev_dependencies:
+  lints: ^1.0.0
+  test: ^1.16.0
   flutter_test:
     sdk: flutter
 
   woosignal:
     path: ../
- 
 
 flutter: