잔액 조회 추가, 필요없는 주석 삭제

Author: Palbahngmiyine

composer.json

@@ -9,6 +9,12 @@
       "Nurigo\\Solapi\\": "src/"
     }
   },
+  "repositories": [
+    {
+      "type": "vcs",
+      "url": "https://github.com/solapi/solapi-php"
+    }
+  ],
   "keywords": [
     "solapi",
     "nurigo",
@@ -23,6 +29,11 @@
     {
       "name": "Nurigo CX Team",
       "email": "contact@nurigo.net"
+    },
+    {
+      "name": "Subin Lee",
+      "email": "chandar.sblee@gmail.com",
+      "homepage": "https://subux.dev"
     }
   ],
   "minimum-stability": "stable",

src/Libraries/Authenticator.php

@@ -11,7 +11,6 @@ class Authenticator
      */
     public static function getAuthorizationHeaderInfo(string $apiKey, string $apiSecretKey): string
     {
-        // TODO: Timezone 문제가 생길 수 있어 추후 수정 필요
         date_default_timezone_set("Asia/Seoul");
         $date = date("Y-m-d\TH:i:s.Z\Z", time());
         $salt = uniqid();

src/Models/Response/GetBalanceResponse.php

@@ -0,0 +1,16 @@
+<?php
+
+namespace Nurigo\Solapi\Models\Response;
+
+class GetBalanceResponse
+{
+    /**
+     * @var float
+     */
+    public $point;
+
+    /**
+     * @var float
+     */
+    public $balance;
+}

src/Services/SolapiMessageService.php

@@ -15,6 +15,7 @@
 use Nurigo\Solapi\Models\Request\GetStatisticsRequest;
 use Nurigo\Solapi\Models\Request\SendRequest;
 use Nurigo\Solapi\Models\Request\UploadFileRequest;
+use Nurigo\Solapi\Models\Response\GetBalanceResponse;
 use Nurigo\Solapi\Models\Response\GetGroupMessagesResponse;
 use Nurigo\Solapi\Models\Response\GetGroupsResponse;
 use Nurigo\Solapi\Models\Response\GetMessagesResponse;
@@ -36,7 +37,7 @@ public function __construct(string $apiKey, string $apiSecretKey)
     }
 
     /**
-     * 메시지 발송
+     * 메시지(문자, 알림톡 등) 발송 함수
      * @param Message|Message[] $messages
      * @param DateTime|null $scheduledDateTime
      * @return SendResponse
@@ -63,6 +64,7 @@ public function send($messages, DateTime $scheduledDateTime = null): SendRespons
     }
 
     /**
+     * MMS 용 이미지 또는 친구톡 이미지 업로드를 위한 함수
      * @param string $filePath 파일 경로
      * @param string $type 파일 유형(MMS, RCS, DOCUMENT, KAKAO)
      * @param string|null $name 파일 이름
@@ -98,6 +100,7 @@ public function uploadFile(string $filePath, string $type = "MMS", string $name
 
 
     /**
+     * 메시지 목록을 조회하는 함수
      * @param GetMessagesRequest|null $parameter
      * @return GetMessagesResponse|null
      */
@@ -112,6 +115,7 @@ public function getMessages(GetMessagesRequest $parameter = null)
     }
 
     /**
+     * 그룹 목록을 조회하는 함수
      * @param GetGroupsRequest|null $parameter
      * @return GetGroupsResponse|null
      */
@@ -126,6 +130,7 @@ public function getGroups(GetGroupsRequest $parameter = null)
     }
 
     /**
+     * 그룹 단일 건을 조회하는 함수
      * @param string $groupId
      * @return GroupMessageResponse|null
      */
@@ -139,6 +144,7 @@ public function getGroup(string $groupId)
     }
 
     /**
+     * 특정 그룹 내 메시지 목록을 조회하는 함수
      * @param string $groupId
      * @param GetGroupMessagesRequest|null $parameter
      * @return GetGroupMessagesResponse|null
@@ -153,6 +159,7 @@ public function getGroupMessages(string $groupId, GetGroupMessagesRequest $param
     }
 
     /**
+     * 통계를 조회하는 함수
      * @param GetStatisticsRequest|null $parameter
      * @return GetStatisticsResponse|null
      */
@@ -164,4 +171,17 @@ public function getStatistics(GetStatisticsRequest $parameter = null)
             return null;
         }
     }
+
+    /**
+     * 잔액(충전금액, 포인트)을 조회하는 함수
+     * @return GetBalanceResponse|null
+     */
+    public function getBalance()
+    {
+        try {
+            return $this->fetcherInstance->request("GET", "/cash/v1/balance");
+        } catch (Exception $exception) {
+            return null;
+        }
+    }
 }