Amazon Pay API SDK PHP 2.6.0

amzn · Mar 17, 2023 · 5d5c6a4 · alies-dev · Mar 17, 2023 · Dexterzprotege
1 parent 5b38287
commit 5d5c6a4
Show file tree

Hide file tree

Showing 5 changed files with 433 additions and 2 deletions.
diff --git a/Amazon/Pay/API/Client.php b/Amazon/Pay/API/Client.php
@@ -10,7 +10,7 @@
 
     class Client implements ClientInterface
     {
-        const SDK_VERSION = '2.5.2';
+        const SDK_VERSION = '2.6.0';
         const HASH_ALGORITHM = 'sha256';
         const API_VERSION = 'v2';
 
@@ -645,4 +645,56 @@ public function getRefund($refundId, $headers = null)
             return $this->apiCall('GET', self::API_VERSION . '/refunds/' . $refundId, null, $headers);
         }
 
+        // ----------------------------------- CV2 REPORTING APIS -----------------------------------
+
+
+        public function getReports($queryParameters = null, $headers = null)
 if (isset($queryParams)) { 
     if (!is_array($queryParams)) { 
         throw new \Exception('queryParameters must be a key-value array; e.g. array(\'accountId\' => \'ABCD1234XYZIJK\')'); 
     } 
     $url = $url . '?' . $this->createCanonicalQuery($queryParams); 
     $requestParameters = $queryParams; 
 } else { 
     $requestParameters = array(); 
 } 
 if (isset($queryParams)) { 
     if (!is_array($queryParams)) { 
         throw new \Exception('queryParameters must be a key-value array; e.g. array(\'accountId\' => \'ABCD1234XYZIJK\')'); 
     } 
     $url = $url . '?' . $this->createCanonicalQuery($queryParams); 
     $requestParameters = $queryParams; 
 } else { 
     $requestParameters = array(); 
 } 
+        {
+            return $this->apiCall('GET', self::API_VERSION . '/reports', null, $headers, $queryParameters);
+        }
+
+
+        public function getReportById($reportId, $headers = null)
+        {
+            return $this->apiCall('GET', self::API_VERSION . '/reports/' . $reportId, null, $headers);
+        }
+
+
+        public function getReportDocument($reportDocumentId, $headers = null)
+        {
+            return $this->apiCall('GET', self::API_VERSION . '/report-documents/' . $reportDocumentId, null, $headers);
+        }
+
+
+        public function getReportSchedules($reportTypes = null, $headers = null)
+        {
+            $queryParameters = array('reportTypes' => $reportTypes);
+            return $this->apiCall('GET', self::API_VERSION . '/report-schedules', null, $headers, $queryParameters);
+        }
+
+
+        public function getReportScheduleById($reportScheduleId, $headers = null)
+        {
+            return $this->apiCall('GET', self::API_VERSION . '/report-schedules/' . $reportScheduleId, null, $headers);
+        }
+
+
+        public function createReport($requestPayload, $headers = null)
+        {
+            return $this->apiCall('POST', self::API_VERSION . '/reports' , $requestPayload, $headers);
+        }
+
+
+        public function createReportSchedule($requestPayload, $headers = null)
+        {
+            return $this->apiCall('POST', self::API_VERSION . '/report-schedules' , $requestPayload, $headers);
+        }
+
+
+        public function cancelReportSchedule($reportScheduleId, $headers = null) 
+        {
+            return $this->apiCall('DELETE', self::API_VERSION . '/report-schedules/' . $reportScheduleId, null, $headers);
+        }
+
+
     }
diff --git a/Amazon/Pay/API/ClientInterface.php b/Amazon/Pay/API/ClientInterface.php
@@ -258,4 +258,89 @@ public function createSignature($http_request_method, $request_uri, $request_par
          */
         public function apiCall($method, $urlFragment, $payload, $headers = null);
 
+
+        // ----------------------------------- Reporting v2 APIs -----------------------------------
+
+
+        /* Amazon Checkout v2 Reporting APIs - Get Reports
+         *
+         * Returns report details for the reports that match the filters that you specify.
+         *
+         * @optional queryParameters - [String in JSON format] or [array]
+         * @optional headers - [array] - optional x-amz-pay-authtoken
+         */
+        public function getReports($queryParameters = null, $headers = null);
+
+
+        /* Amazon Checkout v2 Reporting APIs - Get Report By Id
+         *
+         * Returns report details for the given reportId.
+         *
+         * @param $reportId [String]
+         * @optional headers - [array] - optional x-amz-pay-authtoken
+         */
+        public function getReportById($reportId, $headers = null);
+
+
+        /* Amazon Checkout v2 Reporting APIs - Get Report Document
+         *
+         * Returns the pre-signed S3 URL for the report. The report can be downloaded using this URL.
+         *
+         * @param $reportDocumentId [String]
+         * @optional headers - [array] - optional x-amz-pay-authtoken
+         */
+        public function getReportDocument($reportDocumentId, $headers = null);
+
+
+         /* Amazon Checkout v2 Reporting APIs - Get Report Schedules
+         *
+         * Returns report schedule details that match the filters criteria specified.
+         *
+         * @optional reportTypes - [String]
+         * @optional headers - [array] - optional x-amz-pay-authtoken
+         */
+        public function getReportSchedules($reportTypes = null, $headers = null);
+
+
+
+         /* Amazon Checkout v2 Reporting APIs - Get Report Schedules By Id
+         *
+         * Returns the report schedule details that match the given ID.
+         *
+         * @param $reportScheduleId [String]
+         * @optional headers - [array] - optional x-amz-pay-authtoken
+         */
+        public function getReportScheduleById($reportScheduleId, $headers = null);
+
+
+         /* Amazon Checkout v2 Reporting APIs - Create Report
+         *
+         * Submits a request to generate a report based on the reportType and date range specified.
+         *
+         * @param $requestPayload [String in JSON format] or [array]
+         * @optional headers - [array] - optional x-amz-pay-authtoken
+         */
+        public function createReport($requestPayload, $headers);
+
+
+         /* Amazon Checkout v2 Reporting APIs - Create Report Schedule
+         *
+         * Creates a report schedule for the given reportType. Only one schedule per report type allowed.
+         *
+         * @param $requestPayload [String in JSON format] or [array]
+         * @param headers - [array] - requires x-amz-pay-Idempotency-Key header; optional x-amz-pay-authtoken
+         */
+        public function createReportSchedule($requestPayload, $headers);
+
+
+         /* Amazon Checkout v2 Reporting APIs - Cancel Report Schedule
+         *
+         * Cancels the report schedule with the given reportScheduleId.
+         *
+         * @param $reportScheduleId [String]
+         * @optional headers - [array] - optional x-amz-pay-authtoken
+         */
+        public function cancelReportSchedule($reportScheduleId, $headers = null);
+
+
     }
diff --git a/CHANGES.md b/CHANGES.md
@@ -1,3 +1,6 @@
+### Version 2.6.0 - March 2023
+* Introducing new v2 Reporting APIs. Reports allow you to retrieve consolidated data about Amazon Pay transactions and settlements. In addition to managing and downloading reports using Seller Central, Amazon Pay offers APIs to manage and retrieve your reports.
+
 ### Version 2.5.2 - March 2023
 * Added Error Code 408 to API retry logic
 * Corrected Typos & refactored codes