OctopusDeploy release: 5.0.3

globalpayments · Oct 4, 2022 · 937b361 · 937b361
1 parent 4dcb924
commit 937b361
Show file tree

Hide file tree

Showing 9 changed files with 188 additions and 32 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -6,6 +6,10 @@
 
 ## Latest version
 #### Enhancements:
+- GP-API: PayLink enhancements
+
+## v5.0.2 (09/29/2022)
+#### Enhancements:
 - GP-API: Add fraud management feature 
 - GP-ECOM: Billing/Shipping country value should be ISO2 country code
 - GP-API: Add missing request properties for /transactions and /initiate endpoints

diff --git a/metadata.xml b/metadata.xml
@@ -1,3 +1,3 @@
 <xml>
-  <releaseNumber>5.0.2</releaseNumber>
+  <releaseNumber>5.0.3</releaseNumber>
 </xml>
diff --git a/src/Builders/RequestBuilder/GpApi/GpApiAuthorizationRequestBuilder.php b/src/Builders/RequestBuilder/GpApi/GpApiAuthorizationRequestBuilder.php
@@ -129,8 +129,7 @@ public function buildRequest(BaseBuilder $builder, $config)
                     $requestData['reference'] = $builder->clientTransactionId;
                     $requestData['name'] = $payLink->name;
                     $requestData['description'] = $builder->description;
-                    $requestData['shippable'] = isset($payLink->isShippable) ?
-                        json_encode($payLink->isShippable) : false;
+                    $requestData['shippable'] = $payLink->isShippable == true ? 'YES' : 'NO';
                     $requestData['shipping_amount'] = StringUtils::toNumeric($payLink->shippingAmount);
                     $requestData['expiration_date'] = !empty($payLink->expirationDate) ?
                         (new \DateTime($payLink->expirationDate))->format('Y-m-d\TH:i:s\Z') : null;

diff --git a/src/Builders/RequestBuilder/GpApi/GpApiReportRequestBuilder.php b/src/Builders/RequestBuilder/GpApi/GpApiReportRequestBuilder.php
@@ -221,6 +221,16 @@ public function buildRequest(BaseBuilder $builder, $config)
                     $builder->searchBuilder->endDate->format('Y-m-d') : null;
                 $queryParams['order'] = $builder->order;
                 $queryParams['order_by'] = $builder->payLinkOrderBy;
+                $queryParams['status'] = $builder->searchBuilder->payLinkStatus;
+                $queryParams['usage_mode'] = $builder->searchBuilder->paymentMethodUsageMode;
+                $queryParams['name'] = $builder->searchBuilder->displayName;
+                $queryParams['amount'] = StringUtils::toNumeric($builder->searchBuilder->amount);;
+                $queryParams['description'] = $builder->searchBuilder->description;
+                $queryParams['reference'] = $builder->searchBuilder->referenceNumber;
+                $queryParams['country'] = $builder->searchBuilder->country;
+                $queryParams['currency'] = $builder->searchBuilder->currency;
+                $queryParams['expiration_date'] = !empty($builder->searchBuilder->expirationDate) ?
+                    $builder->searchBuilder->expirationDate->format('Y-m-d') : null;
                 break;
             default:
                 return null;

diff --git a/src/Entities/Reporting/PayLinkSummary.php b/src/Entities/Reporting/PayLinkSummary.php
@@ -98,6 +98,9 @@ class PayLinkSummary
      */
     public $shippable;
 
+    /** @var string */
+    public $shippingAmount;
+
     /**
      * The number of times a link has been viewed.
      * @var string
@@ -117,10 +120,18 @@ class PayLinkSummary
      */
     public $images;
 
+    /**
+     * @var string
+     */
+    public $amount;
+
+    /** @var string */
+    public $currency;
+
     /**
      * List of transactions attached to this payment link
      *
      * @var array<TransactionSummary>
      */
-    public $transactions;
+    public $transactions = [];
 }
diff --git a/src/Entities/Reporting/SearchCriteria.php b/src/Entities/Reporting/SearchCriteria.php
@@ -78,4 +78,8 @@ class SearchCriteria extends Enum
     const RISK_ASSESSMENT_MODE = 'riskAssessmentMode';
     const RISK_ASSESSMENT_RESULT = 'riskAssessmentResult';
     const RISK_ASSESSMENT_REASON_CODE = 'riskAssessmentReasonCode';
+    const PAYLINK_STATUS = 'payLinkStatus';
+    const PAYMENT_METHOD_USAGE_MODE = 'paymentMethodUsageMode';
+    const DESCRIPTION = 'description';
+    const EXPIRATION_DATE = 'expirationDate';
 }
diff --git a/src/Entities/Reporting/SearchCriteriaBuilder.php b/src/Entities/Reporting/SearchCriteriaBuilder.php
@@ -9,7 +9,9 @@
 use GlobalPayments\Api\Entities\Enums\DisputeStatus;
 use GlobalPayments\Api\Entities\Enums\FraudFilterMode;
 use GlobalPayments\Api\Entities\Enums\FraudFilterResult;
+use GlobalPayments\Api\Entities\Enums\PayLinkStatus;
 use GlobalPayments\Api\Entities\Enums\PaymentEntryMode;
+use GlobalPayments\Api\Entities\Enums\PaymentMethodUsageMode;
 use GlobalPayments\Api\Entities\Enums\PaymentType;
 use GlobalPayments\Api\Entities\Enums\PaymentMethodName;
 use GlobalPayments\Api\Entities\Enums\ReasonCode;
@@ -479,6 +481,25 @@ class SearchCriteriaBuilder
      */
     public $paymentMethod;
 
+    /**
+     * This is the PayLink id
+     *
+     * @var string
+     */
+    public $payLinkId;
+
+    /** @var PaymentMethodUsageMode */
+    public $paymentMethodUsageMode;
+
+    /** @var string */
+    public $description;
+
+    /** @var \DateTime */
+    public $expirationDate;
+
+    /** @var PayLinkStatus */
+    public $payLinkStatus;
+
     /** ******************************
      * Open banking search criteria *
      ********************************/
@@ -498,13 +519,6 @@ class SearchCriteriaBuilder
      */
     public $returnPii;
 
-    /**
-     * This is the PayLink id
-     *
-     * @var string
-     */
-    public $payLinkId;
-
     /** END Open Banking search criteria */
 
 

diff --git a/src/Mapping/GpApiMapping.php b/src/Mapping/GpApiMapping.php
@@ -2,6 +2,7 @@
 
 namespace GlobalPayments\Api\Mapping;
 
+use _PHPStan_76800bfb5\Nette\Utils\DateTime;
 use GlobalPayments\Api\Entities\AlternativePaymentResponse;
 use GlobalPayments\Api\Entities\BatchSummary;
 use GlobalPayments\Api\Entities\CardIssuerResponse;
@@ -703,7 +704,7 @@ public static function mapResponseAPM($response)
         if (!empty($response->payment_method->authorization)) {
             $authorization = $response->payment_method->authorization;
             $apm->authStatus = !empty($authorization->status) ? $authorization->status : null;
-            $apm->authAmount = !empty($authorization->amount) ? $authorization->amount : null;
+            $apm->authAmount = !empty($authorization->amount) ? StringUtils::toAmount($authorization->amount) : null;
             $apm->authAck = !empty($authorization->ack) ? $authorization->ack : null;
             $apm->authCorrelationReference = !empty($authorization->correlation_reference) ?
                 $authorization->correlation_reference : null;
@@ -731,37 +732,42 @@ public static function mapResponseAPM($response)
     public static function mapPayLinkSummary($response)
     {
         $summary = new PayLinkSummary();
-
-        $summary->id = $response->id ?? null;
         $summary->merchantId = $response->merchant_id ?? null;
         $summary->merchantName = $response->merchant_name ?? null;
         $summary->accountId = $response->account_id ?? null;
         $summary->accountName = $response->account_name ?? null;
+        $summary->id = $response->id ?? null;
         $summary->url = $response->url ?? null;
         $summary->status = $response->status ?? null;
         $summary->type = $response->type ?? null;
-        $summary->allowedPaymentMethods = $response->allowed_payment_methods ?? null; //@TODO check
         $summary->usageMode = $response->usage_mode ?? null;
-        $summary->usageCount = $response->usage_count ?? null;
+        $summary->usageLimit = $response->usage_limit ?? null; //@TODO
         $summary->reference = $response->reference ?? null;
         $summary->name = $response->name ?? null;
         $summary->description = $response->description ?? null;
-        $summary->shippable = $response->shippable ?? null;
         $summary->viewedCount = $response->viewed_count ?? null;
         $summary->expirationDate = !empty($response->expiration_date) ?
             new \DateTime($response->expiration_date) : null;
+
+        $summary->shippable = $response->shippable ?? null;
+        $summary->usageCount = $response->usage_count ?? null;
         $summary->images = $response->images ?? null;
+        $summary->shippingAmount = $response->shipping_amount ?? null;
 
         if (!empty($response->transactions)) {
-            foreach ($response->transactions as $transaction) {
-                $summary->transactions[] =  self::createTransactionSummary($transaction);
+            $summary->amount = StringUtils::toAmount($response->transactions->amount) ?? null;
+            $summary->currency = $response->transactions->currency ?? null;
+            $summary->allowedPaymentMethods = $response->transactions->allowed_payment_methods ?? null; //@TODO check
+            if (!empty($response->transactions->transaction_list)) {
+                foreach ($response->transactions->transaction_list as $transaction) {
+                    $summary->transactions[] =  self::createTransactionSummary($transaction);
+                }
             }
         }
 
         return $summary;
     }
 
-
     public static function mapPayLinkResponse($response)
     {
         $payLinkResponse = new PayLinkResponse();
@@ -775,9 +781,9 @@ public static function mapPayLinkResponse($response)
         $payLinkResponse->reference = $response->reference ?? null;
         $payLinkResponse->name = $response->name ?? null;
         $payLinkResponse->description = $response->description ?? null;
-        $payLinkResponse->isShippable = $response->shippable ?? null;
         $payLinkResponse->viewedCount = $response->viewed_count ?? null;
         $payLinkResponse->expirationDate = !empty($response->expiration_date) ? new \DateTime($response->expiration_date) : null;
+        $payLinkResponse->isShippable = $response->shippable ?? null;
 
         return $payLinkResponse;
     }
@@ -793,9 +799,8 @@ private static function createTransactionSummary($response)
     {
         $transaction = new TransactionSummary();
         $transaction->transactionId = isset($response->id) ? $response->id : null;
-//        $transaction->transactionDate = $response->time_created;
-        $transaction->transactionDate = !empty($response->time_created) ?
-            new \DateTime($response->time_created) : '';
+        $timeCreated = self::validateStringDate($response->time_created);
+        $transaction->transactionDate = !empty($timeCreated) ? new \DateTime($timeCreated) : '';
         $transaction->transactionStatus = $response->status;
         $transaction->transactionType = $response->type;
         $transaction->channel = !empty($response->channel) ? $response->channel : null;
@@ -806,6 +811,20 @@ private static function createTransactionSummary($response)
         return $transaction;
     }
 
+    private static function validateStringDate($date)
+    {
+        try {
+            new \DateTime($date);
+        } catch (\Exception $e) {
+            $errors = \DateTime::getLastErrors();
+            if (isset($errors['error_count']) && $errors['error_count'] > 0) {
+                return current(explode('.', $date));
+            }
+        }
+
+        return $date;
+    }
+
     /**
      * Map the result codes directly from the card issuer.
      *