2.0.0

Author: ghassani

CHANGELOG

@@ -1,3 +1,165 @@
+v2.0.0
+	- Minimum Merchant version required is now 10.x. For 9.x use the 1.x release.
+	- MMAPI-25 - Added the follwing API functions introduced in Miva Merchant 10.01.00:
+		Attribute_Delete
+		Attribute_Insert
+		Attribute_Load_Code
+		Attribute_Update
+		AttributeAndOptionList_Load_Product
+		AttributeTemplate_Delete
+		AttributeTemplate_Insert
+		AttributeTemplate_Update
+		AttributeTemplateAttribute_Delete
+		AttributeTemplateAttribute_Insert
+		AttributeTemplateAttribute_Update
+		AttributeTemplateAttributeList_Load_Query
+		AttributeTemplateList_Load_Query
+		AttributeTemplateOption_Delete
+		AttributeTemplateOption_Insert
+		AttributeTemplateOption_Set_Default
+		AttributeTemplateOption_Update
+		AttributeTemplateOptionList_Load_Attribute
+		AttributeTemplateProduct_Update_Assigned
+		AttributeTemplateProductList_Load_Query
+		AvailabilityGroup_Delete
+		AvailabilityGroup_Insert
+		AvailabilityGroup_Update
+		AvailabilityGroupBusinessAccountList_Load_Query
+		AvailabilityGroupCategory_Update_Assigned
+		AvailabilityGroupCategoryList_Load_Query
+		AvailabilityGroupCustomerList_Load_Query
+		AvailabilityGroupProductList_Load_Query
+		AvailabilityGroupShippingMethodList_Load_Query
+		Branch_SetPrimary
+		Branch_Update
+		BusinessAccount_Insert
+		BusinessAccount_Update
+		BusinessAccountCustomer_Update_Assigned
+		BusinessAccountCustomerList_Load_Query
+		BusinessAccountList_Delete
+		BusinessAccountList_Load_Query
+		CategoryURI_Insert
+		CategoryURI_Redirect
+		CategoryURI_Update
+		CategoryURIList_Delete
+		CategoryURIList_Load_Query
+		ChildCategoryList_Load_Query
+		CouponCustomer_Update_Assigned
+		CouponCustomerList_Load_Query
+		CustomerAddress_Delete
+		CustomerAddress_Insert
+		CustomerAddress_Update
+		CustomerAddress_Update_Residential
+		CustomerAddressList_Delete
+		FeedURI_Insert
+		FeedURI_Update
+		FeedURIList_Delete
+		FeedURIList_Load_Query
+		ImageTypeList_Load_Query
+		InventoryProductSettings_Update
+		Option_Delete
+		Option_Insert
+		Option_Load_Code
+		Option_Set_Default
+		Option_Update
+		OptionList_Load_Attribute
+		OrderItem_Split
+		OrderItemList_RemoveFromShipment
+		OrderShipmentList_Load_Query
+		PageURI_Insert
+		PageURI_Redirect
+		PageURI_Update
+		PageURIList_Delete
+		PageURIList_Load_Query
+		PriceGroup_Delete
+		PriceGroup_Insert
+		PriceGroup_Update
+		PriceGroupBusinessAccount_Update_Assigned
+		PriceGroupBusinessAccountList_Load_Query
+		PriceGroupCategory_Update_Assigned
+		PriceGroupCategoryList_Load_Query
+		PriceGroupExcludedCategory_Update_Assigned
+		PriceGroupExcludedCategoryList_Load_Query
+		PriceGroupExcludedProduct_Update_Assigned
+		PriceGroupExcludedProductList_Load_Query
+		PriceGroupQualifyingProduct_Update_Assigned
+		PriceGroupQualifyingProductList_Load_Query
+		ProductImage_Update_Type
+		ProductKit_Generate_Variants
+		ProductKit_Update_Parts
+		ProductKit_Variant_Count
+		ProductKitList_Load_Query
+		ProductURI_Insert
+		ProductURI_Redirect
+		ProductURI_Update
+		ProductURIList_Delete
+		ProductURIList_Load_Query
+		ProductVariant_Generate
+		ProductVariant_Generate_Delimiter
+		ProductVariant_Insert
+		ProductVariant_Update
+		ProductVariantList_Delete
+		ProductVariantList_Load_Query
+		RelatedProduct_Update_Assigned
+		RelatedProductList_Load_Query
+		Store_Load
+		StoreList_Load_Query
+		URI_Delete
+		URI_Insert
+		URI_Update
+		URIList_Delete
+		URIList_Load_Query
+	- Added the following API functions introduced in 10.00.00:
+		Branch_Copy
+		Branch_Create
+		Branch_Delete
+		BranchCSSResourceVersionList_Load_Query
+		BranchJavaScriptResourceVersionList_Load_Query
+		BranchList_Load_Query
+		BranchPropertyVersionList_Load_Query
+		BranchTemplateVersionList_Load_Query
+		Changeset_Create
+		ChangesetChangeList_Load_Query
+		ChangesetCSSResourceVersionList_Load_Query
+		ChangesetJavaScriptResourceVersionList_Load_Query
+		ChangesetList_Load_Query
+		ChangesetList_Merge
+		ChangesetPropertyVersionList_Load_Query
+		ChangesetTemplateVersionList_Load_Query
+		CustomerCreditHistory_Delete
+		CustomerCreditHistory_Insert
+		CustomerCreditHistoryList_Load_Query
+		MivaMerchantVersion
+		OrderCoupon_Update_Assigned
+		OrderCouponList_Load_Query
+		OrderItemList_CreateReturn
+		OrderPriceGroup_Update_Assigned
+		OrderPriceGroupList_Load_Query
+		OrderReturnList_Received
+		ResourceGroupList_Load_Query
+	- OrderItemOption model no longer has the attribute property. It has been renamed to attribute_code.
+	- Removed fields from OrderItemOption model:
+		- attribute (now use attribute_code)
+	- New fields on OrderItemOption model:
+		- attribute_id (attr_code)
+		- attribute_code (attr_id)
+		- attribute_template_attribute_id (attmpat_id)
+	- New client option `operation_timeout` allows the control of the timeout for multicall operations
+	- New MultiCallRequest option, auto_timeout_continue
+	- All Request objects can now set header data in the underlying request with `Request::processRequestHeaders`
+	- All Response objects now include the underlying HTTP Response object
+	- Other Bugs Fixed:
+		- Fixed an issue where MultiCallRequest instances were serializing the same function name for all requests
+	- New Request option, binaryEncoding allows specifying the exchange of binary information for supported requests.
+	- Client now supports logging. See Client.setLogger()
+	- MMAPI-6 - All date time fields now support native Date object
+	- Client now accept an optional URLSession argument, defaults to its own internal session
+	- Added support for SSH Private Key authentication
+		- See SSHClient
+		- See Examples/SSHClientExample.swift
+	- Added support for SSH Private Key authentication via a local SSH Agent (allows for authentication via security keys)
+		- See SSHAgentClient
+		- See Examples/SSHAgentClientExample.swift
 v1.1.0
 	- Added support for PriceGroupCustomer_ListLoad_Query
 	- Fixed base64 decoding issues when no padding exists

Examples/CallingModuleApiFunctionsExample.swift

@@ -3,8 +3,6 @@
  *
  * For the full copyright and license information, please view the LICENSE
  * file that was distributed with this source code.
- *
- * $Id: CallingModuleApiFunctionsExample.swift 73830 2019-03-05 23:40:40Z gidriss $
  */
 
 import MerchantAPI
@@ -47,9 +45,14 @@ try request.send() { response, error in
         /// Handle Error
         return
     }
-    
+
     if (!response.isSuccess()) {
         print(String(format: "Error: %@: %@", response.getErrorCode(), response.getErrorMessage()))
+
+        // accessing the data from the module response can be done by iterating through a VariableValue instance
+        if let moduleResponseData = response.getData() {
+            // iterate over the value
+        }
     } else {
         print("Success");
     }

Examples/ClientExample.swift

@@ -3,8 +3,6 @@
  *
  * For the full copyright and license information, please view the LICENSE
  * file that was distributed with this source code.
- *
- * $Id: ClientExample.swift 73172 2019-02-01 22:05:55Z gidriss $
  */
 
 import MerchantAPI
@@ -18,3 +16,18 @@ let client = Client(
     requireTimestamps: true,
     defaultStoreCode : "STORE_CODE"
 )
+
+/// Request Logging can be enabled by assigning a Logger instance to the client
+
+/// Currently, we provide two logger types:
+//       FileLogger - logs to a local file
+//       ConsoleLogger - logs to std out/err
+
+// Setting up a FileLogger
+client.setLogger(ConsoleLogger(filePath: "/path/to/my/logfile.log"))
+
+// Setting up a ConsoleLogger to log to stdout
+client.setLogger(ConsoleLogger(destination: ConsoleLogger.OutputDestination.StdOut))
+
+// Setting up a ConsoleLogger to log to stderr
+client.setLogger(ConsoleLogger(destination: ConsoleLogger.OutputDestination.StdErr))

Examples/CreateProductExample.swift

@@ -3,20 +3,18 @@
  *
  * For the full copyright and license information, please view the LICENSE
  * file that was distributed with this source code.
- *
- * $Id: CreateProductExample.swift 73830 2019-03-05 23:40:40Z gidriss $
  */
 
 import MerchantAPI
 
 /* Initialize a client */
 let client = Client(
-  url : "https://www.mystore.com/mm5/json.mvc", 
-  apiToken : "MY_API_TOKEN", 
-  signingKey : "MY_SIGNING_KEY", 
+  url : "https://www.mystore.com/mm5/json.mvc",
+  apiToken : "MY_API_TOKEN",
+  signingKey : "MY_SIGNING_KEY",
   signingType : MerchantAPI.ClientSignType.SHA256,
-  requireTimestamps: true, 
-  defaultStoreCode : "STORE_CODE" 
+  requireTimestamps: true,
+  defaultStoreCode : "STORE_CODE"
 )
 
 /* Create a ProductInsert request instance, passing client to the constructor */

Examples/LoadAndEditProductExample.swift

@@ -3,8 +3,6 @@
  *
  * For the full copyright and license information, please view the LICENSE
  * file that was distributed with this source code.
- *
- * $Id: LoadAndEditProductExample.swift 73950 2019-03-07 21:14:58Z gidriss $
  */
 
 import MerchantAPI
@@ -38,58 +36,58 @@ try loadProductRequest.send() { loadProductResponse, error in
         /// Handle Error
         return
     }
-    
+
     if !loadProductResponse.isSuccess() {
         print(String(format: "Load Product Error", loadProductResponse.getErrorCode(), loadProductResponse.getErrorMessage()))
         return
     } else if loadProductResponse.getProducts().count == 0 {
         print("Product Not Found")
         return
     }
-    
+
     var product = loadProductResponse.getProducts().first
-    
+
     print(String(format: "Loaded Product %s Code %s Name %s", product.getId(), product.getCode(), product.getName()))
-    
+
     /*
      * You can access the custom fields of the product from the CustomFieldValues model
      */
     let myCustomFieldValue = product.getCustomFieldValues().getValue("MyField")
-    
+
     /*
      * to get a specific module field, specify the optional 2rd argument with the module code.
      */
     let myModuleCustomFieldValue = product.getCustomFieldValues().getValue("MyField", "MyModule");
-    
+
     /*
      * Some requests accept a Model object in their constructor
      * which will allow the Request object to inherit data from.
      * ProductUpdate accepts a Product model.
      */
     var request = ProductUpdateRequest(client: client, product: product)
-    
+
     request.setProductName("The New Product Name")
         .setProductDescription("New Product Description")
         .setProductPrice(39.99)
         .setProductCost(29.99)
         .setProductWeight(2.5);
-    
+
     /*
      * You can update custom field values using the CustomFieldValues model.
      */
     request.getCustomFieldValues().addValue("MyField", "MyValue");
-    
+
     /*
      * to update a specific module field, specify the optional 3rd argument with the module code.
      */
     request.getCustomFieldValues().addValue("MyField", "MyValue", "MyModule");
-    
+
     try request.send() { response, error in
         guard let response = response, error == nil else {
             /// Handle Error
             return
         }
-        
+
         if !response.isSuccess() {
             print(String(format: "Load Product Error", response.getErrorCode(), response.getErrorMessage()))
         } else {

Examples/LoadOrdersExample.swift

@@ -3,8 +3,6 @@
  *
  * For the full copyright and license information, please view the LICENSE
  * file that was distributed with this source code.
- *
- * $Id: LoadOrdersExample.swift 73830 2019-03-05 23:40:40Z gidriss $
  */
 
 import MerchantAPI
@@ -54,7 +52,7 @@ try request.send() { response, error in
         /// Handle Error
         return
     }
-    
+
     if (!response.isSuccess()) {
         print(String(format: "Error Loading Order List", response.getErrorCode(), response.getErrorMessage()))
     } else {

Examples/LoadQueryExample.swift

@@ -4,8 +4,6 @@
  *
  * For the full copyright and license information, please view the LICENSE
  * file that was distributed with this source code.
- *
- * $Id: LoadQueryExample.swift 73830 2019-03-05 23:40:40Z gidriss $
  */
 
 import MerchantAPI
@@ -126,20 +124,20 @@ try request.send() { response, error in
         /// Handle Error
         return
     }
-    
+
     if (!response.isSuccess()) {
         print(String(format: "Error Loading Order List", response.getErrorCode(), response.getErrorMessage()))
     } else {
         for product in response.getProducts() {
             print(String(format: "Product ID: %d Code: %s Name: %s", product.getId(), product.getCode(), product.getName()))
-            
+
             /*
              * Custom Field Values can be accessed via the CustomFieldValues model object
              * @see CustomFieldValues
              */
-            
+
             var myCustomField       = product.getCustomFieldValues().getValue("MyFieldCode");
-            
+
             var myModuleCustomField = product.getCustomFieldValues().getValue("MyModuleFieldCode", "MyModule");
         }
     }