Amazon Pay PHP SDK 3.6.0

bjguillot · bjguillot · commit 9b59f3a5b258 · 2019-11-21T13:15:11.000-08:00
diff --git a/.gitignore b/.gitignore
@@ -1,3 +1,4 @@
 vendor
 composer.lock
-
+amazon-pay.phar
+build
diff --git a/AmazonPay/Client.php b/AmazonPay/Client.php
@@ -23,7 +23,7 @@
 
 class Client implements ClientInterface, LoggerAwareInterface
 {
-    const SDK_VERSION = '3.5.0';
+    const SDK_VERSION = '3.6.0';
     const MWS_VERSION = '2013-01-01';
     const MAX_ERROR_RETRY = 3;
 
@@ -365,7 +365,7 @@ private function setParametersAndPost($parameters, $fieldMappings, $requestParam
                 if (!is_bool($value)) {
                     throw new \Exception($param . ' value ' . $value . ' is of type ' . gettype($value) . ' and should be a boolean value');
                 }
-            } elseif ($param === 'provider_credit_details' || $param === 'provider_credit_reversal_details' || $param === 'order_item_categories') {
+            } elseif ($param === 'provider_credit_details' || $param === 'provider_credit_reversal_details' || $param === 'order_item_categories' || $param === 'notification_configuration_list') {
                 if (!is_array($value)) {
                     throw new \Exception($param . ' value ' . $value . ' is of type ' . gettype($value) . ' and should be an array value');
                 }
@@ -382,6 +382,8 @@ private function setParametersAndPost($parameters, $fieldMappings, $requestParam
                         $parameters = $this->setProviderCreditReversalDetails($parameters, $value);
                     } elseif ($param === 'order_item_categories') {
                         $parameters = $this->setOrderItemCategories($parameters, $value);
+                    } elseif ($param == 'notification_configuration_list') {
+                        $parameters = $this->setNotificationConfigurationList($parameters, $value);
                     }
 
                 } else {
@@ -459,6 +461,32 @@ private function setOrderItemCategories($parameters, $categories)
     }
 
 
+    /* setMerchantNotificationUrls - helper function used by SetMerchantNotificationConfiguration API to set
+     * one or more Notification Configurations
+    */
+    private function setNotificationConfigurationList($parameters, $configuration)
+    {
+        $configurationIndex = 0;
+        if (!is_array($configuration)) {
+            throw new \Exception('Notification Configuration List value ' . $configuration . ' is of type ' . gettype($configuration) . ' and should be an array value');
+        }
+        foreach ($configuration as $url => $events) {
+            $configurationIndex = $configurationIndex + 1;
+            $parameters['NotificationConfigurationList.NotificationConfiguration.' . $configurationIndex . '.NotificationUrl'] = $url;
+            $eventIndex = 0;
+            if (!is_array($events)) {
+                throw new \Exception('Notification Configuration Events value ' . $events . ' is of type ' . gettype($events) . ' and should be an array value');
+            }
+            foreach ($events as $event) {
+                $eventIndex = $eventIndex + 1;
+                $parameters['NotificationConfigurationList.NotificationConfiguration.' . $configurationIndex . '.EventTypes.EventTypeList.' . $eventIndex] = $event;
+            }
+        }
+
+        return $parameters;
+    }
+
+
     /* setProviderCreditDetails - sets the provider credit details sent via the Capture or Authorize API calls
      * @param provider_id - [String]
      * @param credit_amount - [String]
@@ -1336,6 +1364,50 @@ public function closeBillingAgreement($requestParameters = array())
     }
 
 
+    /* GetMerchantNotificationConfiguration API Call - Returns details about the defined IPN endpoints
+     *
+     * @param requestParameters['merchant_id'] - [String]
+     * @optional requestParameters['mws_auth_token'] - [String]
+     */
+    public function getMerchantNotificationConfiguration($requestParameters = array())
+    {
+        $parameters           = array();
+        $parameters['Action'] = 'GetMerchantNotificationConfiguration';
+        $requestParameters    = array_change_key_case($requestParameters, CASE_LOWER);
+
+        $fieldMappings = array(
+            'merchant_id'                 => 'SellerId',
+            'mws_auth_token'              => 'MWSAuthToken'
+        );
+
+        $responseObject = $this->setParametersAndPost($parameters, $fieldMappings, $requestParameters);
+        return ($responseObject);
+    }
+
+
+    /* SetMerchantNotificationConfiguration API Call - Set IPN endpoints
+     *
+     * @param requestParameters['merchant_id'] - [String]
+     * @param requestParameters['notification_configuration_list'] - [Array]
+     * @optional requestParameters['mws_auth_token'] - [String]
+     */
+    public function setMerchantNotificationConfiguration($requestParameters = array())
+    {
+        $parameters           = array();
+        $parameters['Action'] = 'SetMerchantNotificationConfiguration';
+        $requestParameters    = array_change_key_case($requestParameters, CASE_LOWER);
+
+        $fieldMappings = array(
+            'merchant_id'                     => 'SellerId',
+            'notification_configuration_list' => array(),
+            'mws_auth_token'                  => 'MWSAuthToken'
+        );
+
+        $responseObject = $this->setParametersAndPost($parameters, $fieldMappings, $requestParameters);
+        return ($responseObject);
+    }
+
+
     /* charge convenience method
      * Performs the API calls
      * 1. SetOrderReferenceDetails / SetBillingAgreementDetails
diff --git a/AmazonPay/ClientInterface.php b/AmazonPay/ClientInterface.php
@@ -391,6 +391,23 @@ public function authorizeOnBillingAgreement($requestParameters = array());
     public function closeBillingAgreement($requestParameters = array());
 
 
+    /* GetMerchantNotificationConfiguration API Call - Returns details about the defined IPN endpoints
+     *
+     * @param requestParameters['merchant_id'] - [String]
+     * @optional requestParameters['mws_auth_token'] - [String]
+     */
+    public function getMerchantNotificationConfiguration($requestParameters = array());
+
+
+    /* SetMerchantNotificationConfiguration API Call - Set IPN endpoints
+     *
+     * @param requestParameters['merchant_id'] - [String]
+     * @param requestParameters['notification_configuration_list'] - [Array]
+     * @optional requestParameters['mws_auth_token'] - [String]
+     */
+    public function setMerchantNotificationConfiguration($requestParameters = array());
+
+
     /* charge convenience method
      * Performs the API calls
      * 1. SetOrderReferenceDetails / SetBillingAgreementDetails
diff --git a/CHANGES.txt b/CHANGES.txt
@@ -1,3 +1,7 @@
+3.6.0 - November 2019
+- Add GetMerchantNotificationConfiguration API call
+- Add SetMerchantNotificationConfiguration API call
+
 3.5.0 - August 2019
 - Added additional attributes (success_url, failure_url) to ConfirmBillingAgreement and (subscription_amount, currency_code) to SetBillingAgreement Details..  See Amazon Pay Strong Customer Authentication (SCA) Upgrade Integration Guide for more information.
 - Synced missing changes in ClientInterface.php
diff --git a/README.md b/README.md
@@ -299,7 +299,7 @@ See the [API Response](https://github.com/amzn/amazon-pay-sdk-php#api-response)
 ### IPN Handling
 
 1. To receive IPN's successfully you will need an valid SSL on your domain.
-2. You can set up your Notification endpoints in Seller Central by accessing the Integration Settings page in the Settings tab.
+2. You can set up your Notification endpoints by either (a) using the Seller Central Integration Settings page Settings tab, or (b) by using the SetMerchantNotificationConfiguration API call.
 3. IpnHandler.php class handles verification of the source and the data of the IPN
 
 Add the below code into any file and set the URL to the file location in Merchant/Integrator URL by accessing Integration Settings page in the Settings tab.
@@ -320,6 +320,34 @@ $ipnHandler = new IpnHandler($headers, $body);
 ```
 See the [IPN Response](https://github.com/amzn/amazon-pay-sdk-php#ipn-response) section for information on parsing the IPN response.
 
+#### Setting notification endpoints using SetMerchantNotificationConfiguration API
+
+```php
+$client = new AmazonPay\Client($config);
+
+// possible array values: ALL, ORDER_REFERENCE, PAYMENT_AUTHORIZE, PAYMENT_CAPTURE, PAYMENT_REFUND, BILLING_AGREEMENT, CHARGEBACK_DETAILED
+$notificationConfiguration['https://dev.null/ipn/onetime'] = array('ORDER_REFERENCE', 'PAYMENT_AUTHORIZE', 'PAYMENT_CAPTURE');
+$notificationConfiguration['https://dev.null/ipn/recurring'] = array('BILLING_AGREEMENT');
+$notificationConfiguration['https://dev.null/ipn/refunds'] = array('PAYMENT_REFUND', 'CHARGEBACK_DETAILED');
+$requestParameters['notification_configuration_list'] = $notificationConfiguration;
+
+// or, if you prefer all IPNs come to the same endpoint, do this one-liner instead:
+// $requestParameters['notification_configuration_list'] = array('https://dev.null/ipn' => array('ALL'));
+
+// if you are calling on behalf of another merhcant using delegated access, be sure to set the merchant ID and auth token:
+// $requestParameters['merchant_id'] = 'A3URCZVLDMDI45';
+// $requestParameters['mws_auth_token'] = 'amzn.mws.d6ac8f2d-6a5f-b06a-bc12-1d0dbf4ca63d';
+
+$response = $client->setMerchantNotificationConfiguration($requestParameters);
+if ($response->toArray()['ResponseStatus'] !== '200') {
+    print "error occured calling API";
+}
+
+// to troubleshoot, you can call GetMerchantNotificationConfiguration to view current IPN settings
+$response = $client->getMerchantNotificationConfiguration($requestParameters);
+print $response->toXml();
+```
+
 ### Convenience Methods
 
 #### Charge Method
diff --git a/composer.json b/composer.json
@@ -2,7 +2,7 @@
    "name": "amzn/amazon-pay-sdk-php",
    "type": "library",
    "description": "Amazon Pay SDK (PHP)",
-   "version": "3.5.0",
+   "version": "3.6.0",
    "keywords": [
       "amazon",
       "pay",
diff --git a/tst/unit/ClientTest.php b/tst/unit/ClientTest.php
@@ -1015,7 +1015,6 @@ public function testCloseBillingAgreement()
 
         $action = 'CloseBillingAgreement';
 
-
         $parameters = $this->setParametersAndPost($fieldMappings, $action);
         $expectedParameters = $parameters['expectedParameters'];
         $apiCallParams = $parameters['apiCallParams'];
@@ -1029,6 +1028,58 @@ public function testCloseBillingAgreement()
         $this->assertEquals($apiParametersString, $expectedStringParams);
     }
 
+    public function testGetMerchantNotificationConfiguration()
+    {
+        $client = new Client($this->configParams);
+        $fieldMappings = array(
+            'merchant_id'                 => 'SellerId',
+            'mws_auth_token'              => 'MWSAuthToken'
+        );
+
+        $action = 'GetMerchantNotificationConfiguration';
+
+        $parameters = $this->setParametersAndPost($fieldMappings, $action);
+        $expectedParameters = $parameters['expectedParameters'];
+        $apiCallParams = $parameters['apiCallParams'];
+
+        $expectedStringParams = $this->callPrivateMethod($client, 'calculateSignatureAndParametersToString', $expectedParameters);
+
+        $response = $client->getMerchantNotificationConfiguration($apiCallParams);
+
+        $apiParametersString = $client->getParameters();
+
+        $this->assertEquals($apiParametersString, $expectedStringParams);
+    }
+
+    public function testSetMerchantNotificationConfiguration()
+    {
+        $client = new Client($this->configParams);
+        $fieldMappings = array(
+            'merchant_id'                     => 'SellerId',
+            'notification_configuration_list' => array(),
+            'mws_auth_token'                  => 'MWSAuthToken'
+        );
+
+        $action = 'SetMerchantNotificationConfiguration';
+
+        $parameters = $this->setParametersAndPost($fieldMappings, $action);
+        $expectedParameters = $parameters['expectedParameters'];
+        $expectedParameters['NotificationConfigurationList.NotificationConfiguration.1.NotificationUrl'] = 'https://dev.null/one';
+        $expectedParameters['NotificationConfigurationList.NotificationConfiguration.2.NotificationUrl'] = 'https://dev.null/two';
+        $expectedParameters['NotificationConfigurationList.NotificationConfiguration.1.EventTypes.EventTypeList.1'] = 'ORDER_REFERENCE';
+        $expectedParameters['NotificationConfigurationList.NotificationConfiguration.1.EventTypes.EventTypeList.2'] = 'PAYMENT_AUTHORIZE';
+        $expectedParameters['NotificationConfigurationList.NotificationConfiguration.2.EventTypes.EventTypeList.1'] = 'ALL';
+        $apiCallParams = $parameters['apiCallParams'];
+
+        $expectedStringParams = $this->callPrivateMethod($client, 'calculateSignatureAndParametersToString', $expectedParameters);
+
+        $response = $client->setMerchantNotificationConfiguration($apiCallParams);
+
+        $apiParametersString = $client->getParameters();
+
+        $this->assertEquals($apiParametersString, $expectedStringParams);
+    }
+
     public function testCharge()
     {
         $client = new Client($this->configParams);
@@ -1183,6 +1234,10 @@ private function setParametersAndPost($fieldMappings, $action)
                 $apiCallParams[$parm] = array('Antiques', 'Electronics');
             } elseif ($parm === 'order_status_list') {
                 $apiCallParams[$parm] = array('Open', 'Closed');
+            } elseif ($parm === 'notification_configuration_list') {
+                $notificationConfiguration['https://dev.null/one'] = array('ORDER_REFERENCE', 'PAYMENT_AUTHORIZE');
+                $notificationConfiguration['https://dev.null/two'] = array('ALL');
+                $apiCallParams[$parm] = $notificationConfiguration;
             } elseif (!isset($expectedParameters[$value])) {
                 $unique_id = uniqid();
                 $expectedParameters[$value] = $unique_id;

-Original file line number
+Diff line change
@@ @@ -1,3 +1,4 @@ @@
 vendor
 composer.lock
+-
 +amazon-pay.phar
 +build