Merge pull request #290 from plivo/SMS-4914-sdk-for-delete-campaign-b…

…rand-api

Delete Campaign - Brand Request - PHP SDK

CHANGELOG.md

@@ -1,4 +1,7 @@
 # Change Log
+## [v4.38.0](https://github.com/plivo/plivo-php/tree/v4.38.0) (2022-12-06)
+-  Added Delete campaign and brand API
+
 ## [v4.37.1](https://github.com/plivo/plivo-php/tree/v4.37.1) (2022-11-15)
 -  Support for PHP 8.1 version
 

src/Plivo/Resources/Brand/BrandInterface.php

@@ -127,4 +127,25 @@ public function get_brand_usecases($brandId)
             $this->pathParams['authId'], $this->uri);
     }
 
+    /**
+     * @param $brand_id
+     * @return Message
+     * @throws PlivoValidationException
+     */
+    public function delete($brandId)
+    {
+        if (ArrayOperations::checkNull([$brandId])) {
+            throw
+            new PlivoValidationException(
+                'brand id is mandatory');
+        }
+
+        $response = $this->client->delete(
+            $this->uri . '10dlc/Brand/'. $brandId .'/',
+            []
+        );
+
+        return $response->getContent();
+    }
+
 }

src/Plivo/Resources/Campaign/CampaignInterface.php

@@ -168,4 +168,24 @@ public function deleteNumber($campaignId, $number, $optionalArgs = [])
         );
         return $response->getContent();
     }
+
+    /**
+     * @param $campaign_id
+     * @return Message
+     * @throws PlivoValidationException
+     */
+    public function delete($campaignId)
+    {
+        if (ArrayOperations::checkNull([$campaignId])) {
+            throw
+            new PlivoValidationException(
+                'campaign id is mandatory');
+        }
+
+        $response = $this->client->delete(
+            $this->uri . '10dlc/Campaign/'. $campaignId .'/',
+            []
+        );
+        return $response->getContent();   
+    }
 }

src/Plivo/Version.php

@@ -20,12 +20,12 @@ class Version
     /**
      * @const int PHP helper library minor version number
      */
-    const MINOR = 37;
+    const MINOR = 38;
 
     /**
      * @const int PHP helper library patch number
      */
-    const PATCH = 1;
+    const PATCH = 0;
     /**
      * @return string
      */

tests/Mocks/brandDeleteResponse.json

@@ -0,0 +1,5 @@
+{
+    "message": "Brand Deactivated",
+    "brand_id": "BRPXS6E",
+    "api_id": "4bac497c-b963-11ec-b7ca-0242ac110002"
+}

tests/Mocks/campaignDeleteResponse.json

@@ -0,0 +1,5 @@
+{
+    "message": "Campaign Deactivated",
+    "campaign_id": "CMPT4EP",
+    "api_id": "4bac497c-b963-11ec-b7ca-0242ac110002"
+}

tests/Resources/BrandTest.php

@@ -88,4 +88,21 @@ public function testGetBrandUsecase()
 
     }
 
+    public function testDeleteBrandUsecase()
+    {
+        $brandID = "BRPXS6E";
+        $request = new PlivoRequest(
+            'DELETE',
+            'Account/MAXXXXXXXXXXXXXXXXXX/10dlc/Brand/'.$brandID.'/',
+            []);
+        $body = file_get_contents(__DIR__ . '/../Mocks/brandDeleteResponse.json');
+
+        $this->mock(new PlivoResponse($request,200, $body));
+
+        $actual = $this->client->brand->delete($brandID);
+        self::assertNotNull($actual);
+        $this->assertRequest($request);
+
+    }
+
 }

tests/Resources/CampaignTest.php

@@ -131,5 +131,22 @@ function testCampaignListNumber()
 
     }
 
+    public function testDeleteCampaign()
+    {
+        $campaignID = "CMPT4EP";
+        $request = new PlivoRequest(
+            'DELETE',
+            'Account/MAXXXXXXXXXXXXXXXXXX/10dlc/Campaign/'.$campaignID.'/',
+            []);
+        $body = file_get_contents(__DIR__ . '/../Mocks/campaignDeleteResponse.json');
+
+        $this->mock(new PlivoResponse($request,200, $body));
+
+        $actual = $this->client->campaign->delete($campaignID);
+        self::assertNotNull($actual);
+        $this->assertRequest($request);
+
+    }
+
 
-}
+}