Shipping Labels: Send customs form details in the package field of purchase payload (#15879)

Author: itsmeichigo

Modules/Sources/Networking/Model/ShippingLabel/Packages/WooShippingPackagePurchase.swift

@@ -106,7 +106,17 @@ extension WooShippingPackagePurchase: Encodable {
         try container.encode(productIDs, forKey: .products)
 
         if let hazmat = package.hazmatCategory {
-            try container.encode(package.hazmatCategory, forKey: .hazmat)
+            try container.encode(hazmat, forKey: .hazmat)
+        }
+
+        if let form = package.customsForm {
+            try container.encode(form.contentsType.rawValue, forKey: .contentsType)
+            try container.encode(form.contentExplanation, forKey: .contentsExplanation)
+            try container.encode(form.restrictionType.rawValue, forKey: .restrictionType)
+            try container.encode(form.restrictionComments, forKey: .restrictionComments)
+            try container.encode(form.nonDeliveryOption.rawValue, forKey: .nonDeliveryOption)
+            try container.encode(form.itn, forKey: .itn)
+            try container.encode(form.items, forKey: .items)
         }
 
         if selectedRate.signatureRate != nil {
@@ -195,6 +205,13 @@ extension WooShippingPackagePurchase: Encodable {
         case saturdayDelivery = "saturday_delivery"
         case additionalHandling = "additional_handling"
         case hazmat
+        case contentsType = "contents_type"
+        case contentsExplanation = "contents_explanation"
+        case restrictionType = "restriction_type"
+        case restrictionComments = "restriction_comments"
+        case nonDeliveryOption = "non_delivery_option"
+        case itn
+        case items
     }
 
     private enum ParameterKeys {

Modules/Tests/NetworkingTests/Remote/WooShippingRemoteTests.swift

@@ -366,7 +366,15 @@ final class WooShippingRemoteTests: XCTestCase {
 
         let shipmentID = "1"
         let hazmatCategory = "test-hazmat"
-        let customsForm = ShippingLabelCustomsForm.fake().copy(items: [.fake(), .fake()])
+        let customsForm = ShippingLabelCustomsForm(packageID: "test",
+                                                   packageName: "ups-test",
+                                                   contentsType: .merchandise,
+                                                   contentExplanation: "",
+                                                   restrictionType: .none,
+                                                   restrictionComments: "",
+                                                   nonDeliveryOption: .return,
+                                                   itn: "",
+                                                   items: [.fake(), .fake()])
 
         let package = WooShippingPackagePurchase.fake().copy(
             shipmentID: shipmentID,
@@ -424,6 +432,14 @@ final class WooShippingRemoteTests: XCTestCase {
         XCTAssertEqual(firstPackage["additional_handling"] as? Bool, true)
         XCTAssertEqual(firstPackage["hazmat"] as? String, hazmatCategory)
 
+        /// customs form details need to be present in package
+        XCTAssertEqual(try XCTUnwrap(firstPackage["items"] as? [Any]).count, 2)
+        XCTAssertEqual(firstPackage["contents_type"] as? String, "merchandise")
+        XCTAssertEqual(firstPackage["restriction_type"] as? String, "none")
+        XCTAssertEqual(firstPackage["non_delivery_option"] as? String, "return")
+        XCTAssertEqual(firstPackage["restriction_comments"] as? String, "")
+        XCTAssertEqual(firstPackage["contents_explanation"] as? String, "")
+
         let selectedRateParam = try XCTUnwrap(request.parameters["selected_rate"] as? [String: Any])
         let parentValue = try XCTUnwrap(selectedRateParam["parent"] as? [String: Any])
         XCTAssertEqual(parentValue["rate"] as? Double, package.selectedRate.rate.rate)