Merge pull request #196 from plivo/SMS-4914-sdk-for-delete-campaign-brand-api

Delete Campaign - Brand Request - Ruby SDK

Author: renoldthomas-plivo

Diff for: CHANGELOG.md

@@ -1,4 +1,8 @@
 # Change Log
+## [4.33.0](https://github.com/plivo/plivo-ruby/tree/v4.33.0) (2022-12-06)
+**10DLC: Delete Campaign and Brand API**
+- Added Delete campaign and brand API
+
 ## [4.32.0](https://github.com/plivo/plivo-ruby/tree/v4.32.0) (2022-11-03)
 **10DLC: Brand Usecase API**
 - Added Brand Usecase API

Diff for: README.md

@@ -9,7 +9,7 @@ The Plivo Ruby SDK makes it simpler to integrate communications into your Ruby a
 Add this line to your application's Gemfile:
 
 ```ruby
-gem 'plivo', '>= 4.32.0'
+gem 'plivo', '>= 4.33.0'
 ```
 
 And then execute:

Diff for: lib/plivo/base/resource_interface.rb

@@ -59,6 +59,14 @@ def perform_create(params, use_multipart_conn=false)
         )
       end
 
+      def perform_delete(identifier, params = nil)
+        valid_param?(:identifier, identifier, [String, Symbol], true)
+        Response.new(
+          @_client.send_request(@_resource_uri + identifier.to_s + '/', 'DELETE', params, nil, false, is_voice_request: @_is_voice_request),
+          @_identifier_string
+        )
+      end
+
       def perform_submit(identifier, params = nil)
         valid_param?(:identifier, identifier, [String, Symbol], true)
         response_json = @_client.send_request(@_resource_uri + identifier.to_s + '/Submit/', 'POST', params, nil, false, is_voice_request: @_is_voice_request)

Diff for: lib/plivo/resources/brand.rb

@@ -85,6 +85,14 @@ def get_usecases(brand_id)
         identifier = brand_id + '/usecases'
         perform_action_with_identifier(identifier, 'GET', nil)
       end
+
+      ##
+        # Delete Brand
+        # @param [String] brand_id
+        def delete(brand_id)
+          valid_param?(:brand_id, brand_id, [String, Symbol], true)
+          perform_delete(brand_id)
+        end
     end
   end
 end

Diff for: lib/plivo/resources/campaign.rb

@@ -131,6 +131,13 @@ def number_unlink(campaign_id, number, options = nil)
         action = campaign_id + '/Number/' + number
         perform_action_with_identifier(action, 'DELETE', nil)
       end
+        ##
+        # Delete Campaign
+        # @param [String] campaign_id
+        def delete(campaign_id)
+          valid_param?(:campaign_id, campaign_id, [String, Symbol], true)
+          perform_delete(campaign_id)
+        end
     end
   end
 end

Diff for: lib/plivo/version.rb

@@ -1,3 +1,3 @@
 module Plivo
-  VERSION = "4.32.0".freeze
+  VERSION = "4.33.0".freeze
 end

Diff for: spec/mocks/brandDeleteResponse.json

@@ -0,0 +1,4 @@
+{
+    "message": "Brand Deactivated",
+    "brand_id": "BPL3KN9"
+}

Diff for: spec/mocks/campaignDeleteResponse.json

@@ -0,0 +1,4 @@
+{
+    "message": "Campaign Deactivated",
+    "campaign_id": "CY5NVUA"
+}

Diff for: spec/resource_brand_spec.rb

@@ -54,6 +54,14 @@ def to_json_brand_usecase(obj)
         use_cases: obj.use_cases
       }.reject { |_, v| v.nil? }.to_json
     end
+    def to_json_delete(obj)
+      puts obj
+      {
+        api_id: obj.api_id,
+        brand_id: obj.brand_id,
+        message: obj.message
+      }.reject { |_, v| v.nil? }.to_json
+    end
     it 'get brand' do
         contents = File.read(Dir.pwd + '/spec/mocks/brandGetResponse.json')
         mock(200, JSON.parse(contents))
@@ -162,4 +170,19 @@ def to_json_brand_usecase(obj)
                          method: 'GET',
                          data: nil)
     end
+    it 'delete brand' do
+      contents = File.read(Dir.pwd + '/spec/mocks/brandDeleteResponse.json')
+      mock(200, JSON.parse(contents))
+      response = @api.brand
+                     .delete(
+                       'BPL3KN9'
+                     )
+      expect(JSON.parse(to_json_delete(response)))
+        .to eql(JSON.parse(contents))
+      compare_requests(uri: '/v1/Account/MAXXXXXXXXXXXXXXXXXX/10dlc/Brand/'\
+                       'BPL3KN9/',
+                       method: 'DELETE',
+                       data: nil)
+    end
+    
 end

Diff for: spec/resource_campaign_spec.rb

@@ -72,6 +72,14 @@ def to_json_get_numbers(obj)
       campaign_id: obj.campaign_id,
       usecase: obj.usecase
     }.reject { |_, v| v.nil? }.to_json
+  end
+  def to_json_delete(obj)
+    puts obj
+    {
+      api_id: obj.api_id,
+      campaign_id: obj.campaign_id,
+      message: obj.message
+    }.reject { |_, v| v.nil? }.to_json
   end
     it 'get campaign' do
         contents = File.read(Dir.pwd + '/spec/mocks/campaignGetResponse.json')
@@ -253,4 +261,18 @@ def to_json_get_numbers(obj)
                      method: 'DELETE',
                      data: nil)
 end
+it 'delete campaign' do
+  contents = File.read(Dir.pwd + '/spec/mocks/campaignDeleteResponse.json')
+  mock(200, JSON.parse(contents))
+  response = @api.campaign
+                 .delete(
+                   'CY5NVUA'
+                 )
+  expect(JSON.parse(to_json_delete(response)))
+    .to eql(JSON.parse(contents))
+  compare_requests(uri: '/v1/Account/MAXXXXXXXXXXXXXXXXXX/10dlc/Campaign/'\
+                   'CY5NVUA/',
+                   method: 'DELETE',
+                   data: nil)
+end
 end