Merge pull request #305 from plivo/SMS-5391

SMS-5391: Add replaced_sender in MDR Get and List apis
plivo · May 3, 2023 · 8ae2746 · 8ae2746
2 parents 28bd799 + dff5e08
commit 8ae2746
Show file tree

Hide file tree

Showing 7 changed files with 63 additions and 25 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,5 +1,9 @@
 # Change Log
 
+## [v4.46.0](https://github.com/plivo/plivo-php/tree/v4.46.0) (2023-04-25)
+- Add `replacedSender` to the response for the [list all messages API](https://www.plivo.com/docs/sms/api/message/list-all-messages/) and the [get message details API](https://www.plivo.com/docs/sms/api/message#retrieve-a-message)
+- Add `apiId` to the responses for the list all messages API and the get message details API
+
 ## [v4.45.0](https://github.com/plivo/plivo-php/tree/v4.45.1) (2023-04-11)
 **Feature - Added New Param 'source_ip' in GetCall and ListCalls**
 - Add `source_ip` to the response for the [retrieve a call details API](https://www.plivo.com/docs/voice/api/call#retrieve-a-call) and the [retreive all call details API](https://www.plivo.com/docs/voice/api/call#retrieve-all-calls)

diff --git a/src/Plivo/Resources/Message/Message.php b/src/Plivo/Resources/Message/Message.php
@@ -20,6 +20,7 @@
  * @property string $totalAmount
  * @property string $totalRate
  * @property string $units
+ * @property string $replacedSender
  * @property ?string $errorCode
  * @property ?string $powerpackID
  * @property ?string $requesterIP
@@ -50,10 +51,14 @@ public function __construct(
             'totalAmount' => $response['total_amount'],
             'totalRate' => $response['total_rate'],
             'units' => $response['units'],
-            'destination_country_iso2' => $response['destination_country_iso2']
+            'destination_country_iso2' => $response['destination_country_iso2'],
+            'replacedSender' => $response['replaced_sender']
         ];
 
         // handled empty string and null case
+        if (!empty($response['api_id'])) {
+            $this->properties['apiId'] = $response['api_id'];
+        }
         if (!empty($response['powerpack_id'])) {
             $this->properties['powerpackID'] = $response['powerpack_id'];
         }

diff --git a/src/Plivo/Resources/Message/MessageInterface.php b/src/Plivo/Resources/Message/MessageInterface.php
@@ -96,7 +96,7 @@ protected function getList($optionalArgs = [])
                 $newMessage = new Message($this->client, $message, $this->pathParams['authId'], $this->uri);
                 array_push($messages, $newMessage);
             }
-            return new MessageList($this->client, $response->getContent()['meta'], $messages);
+            return new MessageList($this->client, $response->getContent()['meta'], $messages, $response->getContent()["api_id"]);
         } else {
             throw new PlivoResponseException(
                 $response->getContent()['error'],

diff --git a/src/Plivo/Resources/Message/MessageList.php b/src/Plivo/Resources/Message/MessageList.php
@@ -13,14 +13,21 @@
 class MessageList extends ResourceList
 {
 
+    /**
+     * @var
+     */
+    public $apiId;
+
     /**
      * MessageList constructor.
      * @param MessageClient $plivoClient
      * @param $meta
      * @param array $resources
+     * @param string $apiId
      */
-    function __construct(MessageClient $plivoClient, $meta, array $resources)
+    function __construct(MessageClient $plivoClient, $meta, array $resources, $apiId=null)
     {
         parent::__construct($plivoClient, $meta, $resources);
+        $this->apiId = $apiId;
     }
 }
diff --git a/src/Plivo/Version.php b/src/Plivo/Version.php
@@ -20,7 +20,8 @@ class Version
     /**
      * @const int PHP helper library minor version number
      */
-    const MINOR = 45;
+    const MINOR = 46;
+
     /**
      * @const int PHP helper library patch number
      */

diff --git a/tests/Mocks/messageGetResponse.json b/tests/Mocks/messageGetResponse.json
@@ -15,5 +15,6 @@
   "powerpack_id": "15c01cc2-4b9f-4d3b-bd15-3c4b38984cc4",
   "requester_ip": "192.168.1.1",
   "is_domestic": false,
-  "destination_country_iso2": "IN"
+  "destination_country_iso2": "IN",
+  "replaced_sender": "INSID"
 }
diff --git a/tests/Mocks/messageListResponse.json b/tests/Mocks/messageListResponse.json
@@ -22,7 +22,8 @@
       "units": 1,
       "requester_ip": "192.168.1.1",
       "is_domestic": false,
-      "destination_country_iso2": "IN"
+      "destination_country_iso2": "IN",
+      "replaced_sender": "INSID"
     },
     {
       "error_code": null,
@@ -39,7 +40,8 @@
       "units": 1,
       "requester_ip": "192.168.1.2",
       "is_domestic": false,
-      "destination_country_iso2": "IN"
+      "destination_country_iso2": "IN",
+      "replaced_sender": "INSID"
     },
     {
       "error_code": null,
@@ -56,7 +58,8 @@
       "units": 1,
       "requester_ip": "192.168.1.3",
       "is_domestic": false,
-      "destination_country_iso2": "IN"
+      "destination_country_iso2": "IN",
+      "replaced_sender": "INSID"
     },
     {
       "error_code": null,
@@ -73,7 +76,8 @@
       "units": 1,
       "requester_ip": "192.168.1.4",
       "is_domestic": false,
-      "destination_country_iso2": "IN"
+      "destination_country_iso2": "IN",
+      "replaced_sender": "INSID"
     },
     {
       "error_code": null,
@@ -90,7 +94,8 @@
       "units": 1,
       "requester_ip": "192.168.1.5",
       "is_domestic": false,
-      "destination_country_iso2": "IN"
+      "destination_country_iso2": "IN",
+      "replaced_sender": "INSID"
     },
     {
       "error_code": null,
@@ -107,7 +112,8 @@
       "units": 1,
       "requester_ip": "192.168.1.6",
       "is_domestic": false,
-      "destination_country_iso2": "IN"
+      "destination_country_iso2": "IN",
+      "replaced_sender": "INSID"
     },
     {
       "error_code": null,
@@ -124,7 +130,8 @@
       "units": 1,
       "requester_ip": "192.168.1.7",
       "is_domestic": false,
-      "destination_country_iso2": "IN"
+      "destination_country_iso2": "IN",
+      "replaced_sender": "INSID"
     },
     {
       "error_code": null,
@@ -141,7 +148,8 @@
       "units": 1,
       "requester_ip": "192.168.1.8",
       "is_domestic": false,
-      "destination_country_iso2": "IN"
+      "destination_country_iso2": "IN",
+      "replaced_sender": "INSID"
     },
     {
       "error_code": "000",
@@ -158,7 +166,8 @@
       "units": 1,
       "requester_ip": "192.168.1.9",
       "is_domestic": false,
-      "destination_country_iso2": "IN"
+      "destination_country_iso2": "IN",
+      "replaced_sender": "INSID"
     },
     {
       "error_code": null,
@@ -175,7 +184,8 @@
       "units": 1,
       "requester_ip": "192.168.1.10",
       "is_domestic": false,
-      "destination_country_iso2": "IN"
+      "destination_country_iso2": "IN",
+      "replaced_sender": "INSID"
     },
     {
       "error_code": "000",
@@ -192,7 +202,8 @@
       "units": 1,
       "requester_ip": "192.168.1.11",
       "is_domestic": false,
-      "destination_country_iso2": "IN"
+      "destination_country_iso2": "IN",
+      "replaced_sender": "INSID"
     },
     {
       "error_code": null,
@@ -209,7 +220,8 @@
       "units": 1,
       "requester_ip": "192.168.1.12",
       "is_domestic": false,
-      "destination_country_iso2": "IN"
+      "destination_country_iso2": "IN",
+      "replaced_sender": "INSID"
     },
     {
       "error_code": "000",
@@ -226,7 +238,8 @@
       "units": 1,
       "requester_ip": "192.168.1.13",
       "is_domestic": false,
-      "destination_country_iso2": "IN"
+      "destination_country_iso2": "IN",
+      "replaced_sender": "INSID"
     },
     {
       "error_code": null,
@@ -243,7 +256,8 @@
       "units": 1,
       "requester_ip": "192.168.1.14",
       "is_domestic": false,
-      "destination_country_iso2": "IN"
+      "destination_country_iso2": "IN",
+      "replaced_sender": "INSID"
     },
     {
       "error_code": "000",
@@ -260,7 +274,8 @@
       "units": 1,
       "requester_ip": "192.168.1.15",
       "is_domestic": false,
-      "destination_country_iso2": "IN"
+      "destination_country_iso2": "IN",
+      "replaced_sender": "INSID"
     },
     {
       "error_code": null,
@@ -277,7 +292,8 @@
       "units": 1,
       "requester_ip": "192.168.1.16",
       "is_domestic": false,
-      "destination_country_iso2": "IN"
+      "destination_country_iso2": "IN",
+      "replaced_sender": "INSID"
     },
     {
       "error_code": "000",
@@ -294,7 +310,8 @@
       "units": 1,
       "requester_ip": "192.168.1.17",
       "is_domestic": false,
-      "destination_country_iso2": "IN"
+      "destination_country_iso2": "IN",
+      "replaced_sender": "INSID"
     },
     {
       "error_code": "000",
@@ -311,7 +328,8 @@
       "units": 1,
       "requester_ip": "192.168.1.18",
       "is_domestic": false,
-      "destination_country_iso2": "IN"
+      "destination_country_iso2": "IN",
+      "replaced_sender": "INSID"
     },
     {
       "error_code": "000",
@@ -328,7 +346,8 @@
       "units": 1,
       "requester_ip": "192.168.1.19",
       "is_domestic": false,
-      "destination_country_iso2": "IN"
+      "destination_country_iso2": "IN",
+      "replaced_sender": "INSID"
     },
     {
       "error_code": "000",
@@ -345,7 +364,8 @@
       "units": 1,
       "requester_ip": "192.168.1.20",
       "is_domestic": false,
-      "destination_country_iso2": "IN"
+      "destination_country_iso2": "IN",
+      "replaced_sender": "INSID"
     }
   ]
 }