Merged in feature/WFA-4-api-orders-notes (pull request #6)

Feature/WFA-4 api orders notes

Approved-by: Anthony Gordon <ants52@aol.com>

Author: agwoosignal

lib/models/response/order_notes.dart

@@ -0,0 +1,92 @@
+// To parse this JSON data, do
+//
+//     final orderNote = orderNoteFromJson(jsonString);
+
+import 'dart:convert';
+
+OrderNote orderNoteFromJson(String str) => OrderNote.fromJson(json.decode(str));
+
+String orderNoteToJson(OrderNote data) => json.encode(data.toJson());
+
+class OrderNote {
+  OrderNote({
+    this.id,
+    this.author,
+    this.dateCreated,
+    this.dateCreatedGmt,
+    this.note,
+    this.customerNote,
+    this.links,
+  });
+
+  int id;
+  String author;
+  DateTime dateCreated;
+  DateTime dateCreatedGmt;
+  String note;
+  bool customerNote;
+  Links links;
+
+  factory OrderNote.fromJson(Map<String, dynamic> json) => OrderNote(
+        id: json["id"],
+        author: json["author"],
+        dateCreated: DateTime.parse(json["date_created"]),
+        dateCreatedGmt: DateTime.parse(json["date_created_gmt"]),
+        note: json["note"],
+        customerNote: json["customer_note"],
+        links: Links.fromJson(json["_links"]),
+      );
+
+  Map<String, dynamic> toJson() => {
+        "id": id,
+        "author": author,
+        "date_created": dateCreated.toIso8601String(),
+        "date_created_gmt": dateCreatedGmt.toIso8601String(),
+        "note": note,
+        "customer_note": customerNote,
+        "_links": links.toJson(),
+      };
+}
+
+class Links {
+  Links({
+    this.self,
+    this.collection,
+    this.up,
+  });
+
+  List<Collection> self;
+  List<Collection> collection;
+  List<Collection> up;
+
+  factory Links.fromJson(Map<String, dynamic> json) => Links(
+        self: List<Collection>.from(
+            json["self"].map((x) => Collection.fromJson(x))),
+        collection: List<Collection>.from(
+            json["collection"].map((x) => Collection.fromJson(x))),
+        up: List<Collection>.from(
+            json["up"].map((x) => Collection.fromJson(x))),
+      );
+
+  Map<String, dynamic> toJson() => {
+        "self": List<dynamic>.from(self.map((x) => x.toJson())),
+        "collection": List<dynamic>.from(collection.map((x) => x.toJson())),
+        "up": List<dynamic>.from(up.map((x) => x.toJson())),
+      };
+}
+
+class Collection {
+  Collection({
+    this.href,
+  });
+
+  String href;
+
+  factory Collection.fromJson(Map<String, dynamic> json) => Collection(
+        href: json["href"],
+      );
+
+  Map<String, dynamic> toJson() => {
+        "href": href,
+      };
+}

lib/woosignal.dart

@@ -16,6 +16,7 @@ library woosignal;
 // WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE.
 
 import 'package:flutter/cupertino.dart';
+import 'package:woosignal/models/response/order_notes.dart';
 import 'package:woosignal/models/response/coupon.dart';
 import 'package:woosignal/models/response/coupon_batch.dart';
 import 'package:woosignal/models/response/customer_batch.dart';
@@ -717,6 +718,90 @@ class WooSignal {
     return payloadRsp;
   }
 
+// Retrieve an order note
+// This API lets you retrieve and view a specific note from an order
+  Future<OrderNote> retrieveOrderNote({
+    @required int orderId,
+    @required int noteId,
+  }) async {
+    Map<String, dynamic> payload = {};
+    _printLog("Parameters: " + payload.toString());
+    payload = _standardPayload("get", payload,
+        "orders/${orderId.toString()}/notes/${noteId.toString()}");
+
+    OrderNote orderNote;
+    await _apiProvider.post("/request", payload).then((json) {
+      orderNote = OrderNote.fromJson(json);
+    });
+    _printLog(orderNote.toString());
+    return orderNote;
+  }
+
+// https://woocommerce.github.io/woocommerce-rest-api-docs/?php#list-all-order-notes
+// List All order notes
+// This API helps you to view all the notes from an order.
+  Future<List<OrderNote>> getOrderNotes({
+    @required int orderId,
+    String context,
+    String type,
+  }) async {
+    Map<String, dynamic> payload = {};
+    if (type != null) payload["type"] = type;
+
+    _printLog("Parameters: " + payload.toString());
+    payload =
+        _standardPayload("get", payload, "orders/${orderId.toString()}/notes");
+
+    List<OrderNote> orderNotes = [];
+    await _apiProvider.post("/request", payload).then((json) {
+      orderNotes = (json as List).map((i) => OrderNote.fromJson(i)).toList();
+    });
+    _printLog(orderNotes.toString());
+    return orderNotes;
+  }
+
+// Create an order note
+// This API helps you to create a new note for an order.
+  Future<OrderNote> createOrderNote({
+    @required int id,
+    Map<String, dynamic> data,
+  }) async {
+    Map<String, dynamic> payload = {};
+    if (data != null) payload['data'] = data;
+    _printLog(payload.toString());
+    payload =
+        _standardPayload("post", payload, "orders/${id.toString()}/notes");
+    OrderNote orderNote;
+    await _apiProvider.post("/request", payload).then((json) {
+      orderNote = OrderNote.fromJson(json);
+    });
+    _printLog(orderNote.toString());
+    return orderNote;
+  }
+
+// Delete an order note
+// This API helps you delete an order note.
+  Future<OrderNote> deleteOrderNote(
+    int orderId,
+    int noteId) async {
+    Map<String, dynamic> data;
+    data = {'force': true};
+    Map<String, dynamic> payload = data;
+
+    _printLog(payload.toString());
+
+    // There is the usage of + instead of ${} if error Occurs
+    payload = _standardPayload("delete", payload,
+        "orders/${orderId.toString()}/notes/${noteId.toString()}");
+
+    OrderNote orderNote;
+    await _apiProvider.post("/request", payload).then((json) {
+      orderNote = OrderNote.fromJson(json);
+    });
+    _printLog(orderNote.toString());
+    return orderNote;
+    }
+
   Future<Coupon> retrieveCoupons({int id}) async {
     Map<String, dynamic> payload = {};
     _printLog("Parameters: " + payload.toString());