Add wallet history request

kassacom · Jan 15, 2025 · eda41f1 · eda41f1
1 parent b8739c4
commit eda41f1
Show file tree

Hide file tree

Showing 5 changed files with 222 additions and 2 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,3 +1,7 @@
+## 1.9.4 - January 2025
+
+- Add wallet history request
+
 ## 1.9.3 - July 2024
 
 - Add `sbp_oper_id` for payout method response

diff --git a/src/Client.php b/src/Client.php
@@ -66,6 +66,9 @@
 use KassaCom\SDK\Model\Request\Reports\PayoutsReportRequest;
 use KassaCom\SDK\Model\Request\Reports\PayoutsReportSerializer;
 use KassaCom\SDK\Model\Request\Reports\PayoutsReportTransport;
+use KassaCom\SDK\Model\Request\Reports\WalletHistoryReportRequest;
+use KassaCom\SDK\Model\Request\Reports\WalletHistoryReportSerializer;
+use KassaCom\SDK\Model\Request\Reports\WalletHistoryReportTransport;
 use KassaCom\SDK\Model\Request\Subscription\GetSubscriptionRequest;
 use KassaCom\SDK\Model\Request\Subscription\GetSubscriptionSerializer;
 use KassaCom\SDK\Model\Request\Subscription\GetSubscriptionTransport;
@@ -92,7 +95,7 @@
 
 class Client
 {
-    const VERSION = '1.9.3';
+    const VERSION = '1.9.4';
 
     /** @var AbstractApiTransport */
     private $apiTransport;
@@ -431,7 +434,7 @@ public function getPayoutsReport($payoutsReport)
         $payoutsReportTransport = new PayoutsReportTransport($payoutsReportSerializer);
 
         $filename = [];
-        $filename[] = '$payouts_report';
+        $filename[] = 'payouts_report';
         $filename[] = $payoutsReport->getDatetimeFrom()->format('Y-m-d-H-i-s');
         $filename[] = '_';
         $filename[] = $payoutsReport->getDatetimeTo()->format('Y-m-d-H-i-s');
@@ -440,6 +443,32 @@ public function getPayoutsReport($payoutsReport)
         return $this->download($payoutsReportTransport, join($filename));
     }
 
+    /**
+     * @param array|WalletHistoryReportRequest $walletHistoryReport
+     *
+     * @return Psr7\MessageTrait
+     * @throws TransportException
+     */
+    public function getWalletHistoryReport($walletHistoryReport)
+    {
+        if (!($walletHistoryReport instanceof WalletHistoryReportRequest)) {
+            $walletHistoryReport = RequestCreator::create(WalletHistoryReportRequest::class, $walletHistoryReport);
+        }
+
+        ObjectRecursiveValidator::validate($walletHistoryReport);
+        $walletHistorySerializer = new WalletHistoryReportSerializer($walletHistoryReport);
+        $walletHistoryTransport = new WalletHistoryReportTransport($walletHistorySerializer);
+
+        $filename = [];
+        $filename[] = 'wallet_history_report';
+        $filename[] = $walletHistoryReport->getDatetimeFrom()->format('Y-m-d-H-i-s');
+        $filename[] = '_';
+        $filename[] = $walletHistoryReport->getDatetimeTo()->format('Y-m-d-H-i-s');
+        $filename[] = '.csv';
+
+        return $this->download($walletHistoryTransport, join($filename));
+    }
+
     /**
      * @param string|WalletRequest $walletRequest
      *

diff --git a/src/Model/Request/Reports/WalletHistoryReportRequest.php b/src/Model/Request/Reports/WalletHistoryReportRequest.php
@@ -0,0 +1,126 @@
+<?php
+
+namespace KassaCom\SDK\Model\Request\Reports;
+
+
+use KassaCom\SDK\Model\Request\AbstractRequest;
+use KassaCom\SDK\Model\Traits\RecursiveRestoreTrait;
+
+class WalletHistoryReportRequest extends AbstractRequest
+{
+    use RecursiveRestoreTrait;
+
+    /**
+     * Начала периода, в формате datetime
+     *
+     * @var \DateTime
+     */
+    private $datetimeFrom;
+
+    /**
+     * Завершение периода, в формате datetime
+     *
+     * @var \DateTime
+     */
+    private $datetimeTo;
+
+    /**
+     * Идентификатор кошелька
+     *
+     * @var integer
+     */
+    private $walletId;
+
+    /**
+     * Фильтр по типам записей в истории.
+     *
+     * @var array|null
+     */
+    private $operationType;
+
+    /**
+     * @return \DateTime
+     */
+    public function getDatetimeFrom()
+    {
+        return $this->datetimeFrom;
+    }
+
+    /**
+     * @param \DateTime $datetimeFrom
+     */
+    public function setDatetimeFrom($datetimeFrom)
+    {
+        $this->datetimeFrom = $datetimeFrom;
+    }
+
+    /**
+     * @return \DateTime
+     */
+    public function getDatetimeTo()
+    {
+        return $this->datetimeTo;
+    }
+
+    /**
+     * @param \DateTime $datetimeTo
+     */
+    public function setDatetimeTo($datetimeTo)
+    {
+        $this->datetimeTo = $datetimeTo;
+    }
+
+    /**
+     * @return int
+     */
+    public function getWalletId()
+    {
+        return $this->walletId;
+    }
+
+    /**
+     * @param int $walletId
+     */
+    public function setWalletId($walletId)
+    {
+        $this->walletId = $walletId;
+    }
+
+    /**
+     * @return array|null
+     */
+    public function getOperationType()
+    {
+        return $this->operationType;
+    }
+
+    /**
+     * @param array|null $operationType
+     */
+    public function setOperationType($operationType)
+    {
+        $this->operationType = $operationType;
+    }
+
+    /**
+     * @inheritDoc
+     */
+    public function getRequiredFields()
+    {
+        return [
+            'datetime_from' => self::TYPE_DATE,
+            'datetime_to' => self::TYPE_DATE,
+            'wallet_id' => self::TYPE_INTEGER,
+        ];
+    }
+
+    /**
+     * @inheritDoc
+     */
+    public function getOptionalFields()
+    {
+        return [
+            'operation_type' => [self::TYPE_STRING],
+        ];
+    }
+}
diff --git a/src/Model/Request/Reports/WalletHistoryReportSerializer.php b/src/Model/Request/Reports/WalletHistoryReportSerializer.php
@@ -0,0 +1,29 @@
+<?php
+
+namespace KassaCom\SDK\Model\Request\Reports;
+
+use KassaCom\SDK\Model\Request\AbstractRequestSerializer;
+
+class WalletHistoryReportSerializer extends AbstractRequestSerializer
+{
+    /**
+     * @inheritDoc
+     */
+    public function getSerializedData()
+    {
+        /** @var WalletHistoryReportRequest $request */
+        $request = $this->request;
+
+        $data = [
+            'datetime_from' => $request->getDatetimeFrom()->format('c'),
+            'datetime_to' => $request->getDatetimeTo()->format('c'),
+            'wallet_id' => $request->getWalletId(),
+        ];
+
+        if ($request->getOperationType() !== null) {
+            $data['operation_type'] = $request->getOperationType();
+        }
+
+        return $data;
+    }
+}
diff --git a/src/Model/Request/Reports/WalletHistoryReportTransport.php b/src/Model/Request/Reports/WalletHistoryReportTransport.php
@@ -0,0 +1,32 @@
+<?php
+
+namespace KassaCom\SDK\Model\Request\Reports;
+
+use KassaCom\SDK\Model\Request\AbstractRequestTransport;
+use KassaCom\SDK\Transport\AbstractApiTransport;
+
+class WalletHistoryReportTransport extends AbstractRequestTransport
+{
+    const PATH = 'report/wallet/registry.csv';
+
+    /**
+     * @inheritDoc
+     */
+    public function getPath()
+    {
+        return self::PATH;
+    }
+
+    /**
+     * @inheritDoc
+     */
+    public function getMethod()
+    {
+        return AbstractApiTransport::METHOD_GET;
+    }
+
+    public function getBodyForRequest()
+    {
+        return $this->getBody();
+    }
+}