add sample for getCustomerPaymentProfileList

Author: adavidw

CustomerProfiles/get-customer-payment-profile-list.js

@@ -0,0 +1,100 @@
+"use strict";
+
+var ApiContracts = require("authorizenet").APIContracts;
+var ApiControllers = require("authorizenet").APIControllers;
+var utils = require("../utils.js");
+var constants = require("../constants.js");
+
+function getCustomerPaymentProfileList(callback) {
+
+	// Create a merchantAuthenticationType object with authentication details
+    // retrieved from the constants file
+	var merchantAuthenticationType = new ApiContracts.MerchantAuthenticationType();
+	merchantAuthenticationType.setName(constants.apiLoginKey);
+	merchantAuthenticationType.setTransactionKey(constants.transactionKey);
+
+	// Set the transaction"s refId
+	var refId = utils.getRandomInt();
+
+    // Set the paging (this particular API call will only return up to 10 results at a time)
+	var paging = new ApiContracts.Paging();
+	paging.setLimit(10);
+	paging.setOffset(1);
+
+    // Set the sorting
+    var sorting = new ApiContracts.CustomerPaymentProfileSorting;
+    sorting.setOrderBy(ApiContracts.CustomerPaymentProfileOrderFieldEnum.ID);
+    sorting.setOrderDescending(false);
+
+	// Set search parameters
+	var search = ApiContracts.CustomerPaymentProfileSearchTypeEnum.CARDSEXPIRINGINMONTH;
+    var month = "2020-12";
+
+	// Creating the request with the required parameters
+	var getRequest = new ApiContracts.GetCustomerPaymentProfileListRequest();
+	getRequest.setMerchantAuthentication(merchantAuthenticationType);
+	getRequest.setRefId(refId);
+	getRequest.setPaging(paging);
+	getRequest.setSorting(sorting);
+	getRequest.setSearchType(search);
+	getRequest.setMonth(month);
+
+	// uncomment to print request
+	// console.log(JSON.stringify(getRequest.getJSON(), null, 2));
+		
+	var ctrl = new ApiControllers.GetCustomerPaymentProfileListController(getRequest.getJSON());
+
+	ctrl.execute(function(){
+
+		var apiResponse = ctrl.getResponse();
+
+		var response = new ApiContracts.GetCustomerPaymentProfileListResponse(apiResponse);
+
+		// uncomment to print response
+		// console.log(JSON.stringify(response, null, 2));
+
+		if(response != null) 
+		{
+			if(response.getMessages().getResultCode() == ApiContracts.MessageTypeEnum.OK)
+			{
+				console.log("SUCCESS");
+				console.log("Total Num in Result Set: " + response.getTotalNumInResultSet());
+				var profiles = response.getPaymentProfiles().getPaymentProfile();
+				for (var i=0;i<profiles.length;i++)
+				{
+					console.log("Profile ID: " + profiles[i].getCustomerProfileId());
+					console.log("Payment Profile ID: " + profiles[i].getCustomerPaymentProfileId());					
+					if(profiles[i].payment.creditCard)
+					{
+						console.log("Card: " + profiles[i].payment.creditCard.cardNumber);
+					}
+					else if(profiles[i].payment.bankAccount)
+					{
+						console.log("Bank Account: " + profiles[i].payment.bankAccount.accountNumber);
+					}		
+					console.log("");
+				}
+			}
+			else
+			{
+				console.log("Result Code: " + response.getMessages().getResultCode());
+				console.log("Error Code: " + response.getMessages().getMessage()[0].getCode());
+				console.log("Error Message: " + response.getMessages().getMessage()[0].getText());
+			}
+		}
+		else
+		{
+			console.log("Null response received");
+		}
+
+		callback(response);
+	});
+}
+
+if (require.main === module) {
+	getCustomerPaymentProfileList(function(){
+		console.log("getCustomerPaymentProfileList call complete.");
+	});
+}
+
+module.exports.getCustomerPaymentProfileList = getCustomerPaymentProfileList;

CustomerProfiles/index.js

@@ -8,6 +8,7 @@ module.exports = {
 	deleteCustomerProfile: require('./delete-customer-profile.js').deleteCustomerProfile,
 	deleteCustomerShippingAddress: require('./delete-customer-shipping-address.js').deleteCustomerShippingAddress,
 	getCustomerPaymentProfile: require('./get-customer-payment-profile.js').getCustomerPaymentProfile,
+	getCustomerPaymentProfileList: require('./get-customer-payment-profile-list.js').getCustomerPaymentProfileList,
 	getCustomerProfileIds: require('./get-customer-profile-ids.js').getCustomerProfileIds,
 	getCustomerProfile: require('./get-customer-profile.js').getCustomerProfile,
 	getCustomerShippingAddress: require('./get-customer-shipping-address.js').getCustomerShippingAddress,

list_of_sample_codes.txt

@@ -41,6 +41,7 @@ deleteCustomerPaymentProfile,1
 deleteCustomerProfile,1
 deleteCustomerShippingAddress,1
 getCustomerPaymentProfile,1
+getCustomerPaymentProfileList,1
 getCustomerProfileIds,1
 getCustomerProfile,1
 getCustomerShippingAddress,1

package.json

@@ -4,7 +4,7 @@
   "description": "Sample code for nodejs sdk",
   "main": "constants.js",
   "dependencies": {
-    "authorizenet": "^1.0.1",
+    "authorizenet": "^1.0.3",
     "chai": "^3.5.0",
     "eslint": "^2.12.0"
   },

test-runner.js

@@ -239,6 +239,10 @@ class TestRunner {
 		});
 	}
 
+	getCustomerPaymentProfileList(validateFunctionCallback){
+		CustomerProfilesModule.getCustomerPaymentProfileList(validateFunctionCallback);
+	}
+	
 	createCustomerShippingAddress(validateFunctionCallback){
 		CustomerProfilesModule.createCustomerProfile(function(response){
 			CustomerProfilesModule.createCustomerShippingAddress(response.getCustomerProfileId(), validateFunctionCallback);