gocardless_pro 2.18.0 → 2.22.0

data/lib/gocardless_pro/version.rb

@@ -4,5 +4,5 @@ end
 
 module GoCardlessPro
   # Current version of the GC gem
-  VERSION = '2.18.0'.freeze
+  VERSION = '2.22.0'.freeze
 end

data/spec/resources/instalment_schedule_spec.rb

@@ -529,6 +529,41 @@ describe GoCardlessPro::Resources::InstalmentSchedule do
     end
   end
 
+  describe '#update' do
+    subject(:put_update_response) { client.instalment_schedules.update(id, params: update_params) }
+    let(:id) { 'ABC123' }
+
+    context 'with a valid request' do
+      let(:update_params) { { 'hello' => 'world' } }
+
+      let!(:stub) do
+        stub_url = '/instalment_schedules/:identity'.gsub(':identity', id)
+        stub_request(:put, /.*api.gocardless.com#{stub_url}/).to_return(
+          body: {
+            'instalment_schedules' => {
+
+              'created_at' => 'created_at-input',
+              'currency' => 'currency-input',
+              'id' => 'id-input',
+              'links' => 'links-input',
+              'metadata' => 'metadata-input',
+              'name' => 'name-input',
+              'payment_errors' => 'payment_errors-input',
+              'status' => 'status-input',
+              'total_amount' => 'total_amount-input',
+            },
+          }.to_json,
+          headers: response_headers
+        )
+      end
+
+      it 'updates and returns the resource' do
+        expect(put_update_response).to be_a(GoCardlessPro::Resources::InstalmentSchedule)
+        expect(stub).to have_been_requested
+      end
+    end
+  end
+
   describe '#cancel' do
     subject(:post_response) { client.instalment_schedules.cancel(resource_id) }
 

data/spec/resources/payout_spec.rb

@@ -26,6 +26,7 @@ describe GoCardlessPro::Resources::Payout do
               'fx' => 'fx-input',
               'id' => 'id-input',
               'links' => 'links-input',
+              'metadata' => 'metadata-input',
               'payout_type' => 'payout_type-input',
               'reference' => 'reference-input',
               'status' => 'status-input',
@@ -58,6 +59,8 @@ describe GoCardlessPro::Resources::Payout do
 
         expect(get_list_response.records.first.id).to eq('id-input')
 
+        expect(get_list_response.records.first.metadata).to eq('metadata-input')
+
         expect(get_list_response.records.first.payout_type).to eq('payout_type-input')
 
         expect(get_list_response.records.first.reference).to eq('reference-input')
@@ -88,6 +91,7 @@ describe GoCardlessPro::Resources::Payout do
             'fx' => 'fx-input',
             'id' => 'id-input',
             'links' => 'links-input',
+            'metadata' => 'metadata-input',
             'payout_type' => 'payout_type-input',
             'reference' => 'reference-input',
             'status' => 'status-input',
@@ -114,6 +118,7 @@ describe GoCardlessPro::Resources::Payout do
             'fx' => 'fx-input',
             'id' => 'id-input',
             'links' => 'links-input',
+            'metadata' => 'metadata-input',
             'payout_type' => 'payout_type-input',
             'reference' => 'reference-input',
             'status' => 'status-input',
@@ -156,6 +161,7 @@ describe GoCardlessPro::Resources::Payout do
                 'fx' => 'fx-input',
                 'id' => 'id-input',
                 'links' => 'links-input',
+                'metadata' => 'metadata-input',
                 'payout_type' => 'payout_type-input',
                 'reference' => 'reference-input',
                 'status' => 'status-input',
@@ -192,6 +198,7 @@ describe GoCardlessPro::Resources::Payout do
               'fx' => 'fx-input',
               'id' => 'id-input',
               'links' => 'links-input',
+              'metadata' => 'metadata-input',
               'payout_type' => 'payout_type-input',
               'reference' => 'reference-input',
               'status' => 'status-input',
@@ -228,4 +235,42 @@ describe GoCardlessPro::Resources::Payout do
       end
     end
   end
+
+  describe '#update' do
+    subject(:put_update_response) { client.payouts.update(id, params: update_params) }
+    let(:id) { 'ABC123' }
+
+    context 'with a valid request' do
+      let(:update_params) { { 'hello' => 'world' } }
+
+      let!(:stub) do
+        stub_url = '/payouts/:identity'.gsub(':identity', id)
+        stub_request(:put, /.*api.gocardless.com#{stub_url}/).to_return(
+          body: {
+            'payouts' => {
+
+              'amount' => 'amount-input',
+              'arrival_date' => 'arrival_date-input',
+              'created_at' => 'created_at-input',
+              'currency' => 'currency-input',
+              'deducted_fees' => 'deducted_fees-input',
+              'fx' => 'fx-input',
+              'id' => 'id-input',
+              'links' => 'links-input',
+              'metadata' => 'metadata-input',
+              'payout_type' => 'payout_type-input',
+              'reference' => 'reference-input',
+              'status' => 'status-input',
+            },
+          }.to_json,
+          headers: response_headers
+        )
+      end
+
+      it 'updates and returns the resource' do
+        expect(put_update_response).to be_a(GoCardlessPro::Resources::Payout)
+        expect(stub).to have_been_requested
+      end
+    end
+  end
 end

data/spec/resources/redirect_flow_spec.rb

@@ -20,6 +20,7 @@ describe GoCardlessPro::Resources::RedirectFlow do
           'description' => 'description-input',
           'id' => 'id-input',
           'links' => 'links-input',
+          'metadata' => 'metadata-input',
           'redirect_url' => 'redirect_url-input',
           'scheme' => 'scheme-input',
           'session_token' => 'session_token-input',
@@ -38,6 +39,7 @@ describe GoCardlessPro::Resources::RedirectFlow do
                 'description' => 'description-input',
                 'id' => 'id-input',
                 'links' => 'links-input',
+                'metadata' => 'metadata-input',
                 'redirect_url' => 'redirect_url-input',
                 'scheme' => 'scheme-input',
                 'session_token' => 'session_token-input',
@@ -56,6 +58,7 @@ describe GoCardlessPro::Resources::RedirectFlow do
                   'description' => 'description-input',
                   'id' => 'id-input',
                   'links' => 'links-input',
+                  'metadata' => 'metadata-input',
                   'redirect_url' => 'redirect_url-input',
                   'scheme' => 'scheme-input',
                   'session_token' => 'session_token-input',
@@ -107,6 +110,7 @@ describe GoCardlessPro::Resources::RedirectFlow do
           'description' => 'description-input',
           'id' => 'id-input',
           'links' => 'links-input',
+          'metadata' => 'metadata-input',
           'redirect_url' => 'redirect_url-input',
           'scheme' => 'scheme-input',
           'session_token' => 'session_token-input',
@@ -148,6 +152,7 @@ describe GoCardlessPro::Resources::RedirectFlow do
                 'description' => 'description-input',
                 'id' => 'id-input',
                 'links' => 'links-input',
+                'metadata' => 'metadata-input',
                 'redirect_url' => 'redirect_url-input',
                 'scheme' => 'scheme-input',
                 'session_token' => 'session_token-input',
@@ -185,6 +190,7 @@ describe GoCardlessPro::Resources::RedirectFlow do
                 'description' => 'description-input',
                 'id' => 'id-input',
                 'links' => 'links-input',
+                'metadata' => 'metadata-input',
                 'redirect_url' => 'redirect_url-input',
                 'scheme' => 'scheme-input',
                 'session_token' => 'session_token-input',
@@ -219,6 +225,7 @@ describe GoCardlessPro::Resources::RedirectFlow do
               'description' => 'description-input',
               'id' => 'id-input',
               'links' => 'links-input',
+              'metadata' => 'metadata-input',
               'redirect_url' => 'redirect_url-input',
               'scheme' => 'scheme-input',
               'session_token' => 'session_token-input',
@@ -274,6 +281,7 @@ describe GoCardlessPro::Resources::RedirectFlow do
             'description' => 'description-input',
             'id' => 'id-input',
             'links' => 'links-input',
+            'metadata' => 'metadata-input',
             'redirect_url' => 'redirect_url-input',
             'scheme' => 'scheme-input',
             'session_token' => 'session_token-input',
@@ -313,6 +321,7 @@ describe GoCardlessPro::Resources::RedirectFlow do
                 'description' => 'description-input',
                 'id' => 'id-input',
                 'links' => 'links-input',
+                'metadata' => 'metadata-input',
                 'redirect_url' => 'redirect_url-input',
                 'scheme' => 'scheme-input',
                 'session_token' => 'session_token-input',

data/spec/resources/subscription_spec.rb

@@ -21,6 +21,7 @@ describe GoCardlessPro::Resources::Subscription do
           'created_at' => 'created_at-input',
           'currency' => 'currency-input',
           'day_of_month' => 'day_of_month-input',
+          'earliest_charge_date_after_resume' => 'earliest_charge_date_after_resume-input',
           'end_date' => 'end_date-input',
           'id' => 'id-input',
           'interval' => 'interval-input',
@@ -49,6 +50,7 @@ describe GoCardlessPro::Resources::Subscription do
                 'created_at' => 'created_at-input',
                 'currency' => 'currency-input',
                 'day_of_month' => 'day_of_month-input',
+                'earliest_charge_date_after_resume' => 'earliest_charge_date_after_resume-input',
                 'end_date' => 'end_date-input',
                 'id' => 'id-input',
                 'interval' => 'interval-input',
@@ -77,6 +79,7 @@ describe GoCardlessPro::Resources::Subscription do
                   'created_at' => 'created_at-input',
                   'currency' => 'currency-input',
                   'day_of_month' => 'day_of_month-input',
+                  'earliest_charge_date_after_resume' => 'earliest_charge_date_after_resume-input',
                   'end_date' => 'end_date-input',
                   'id' => 'id-input',
                   'interval' => 'interval-input',
@@ -138,6 +141,7 @@ describe GoCardlessPro::Resources::Subscription do
           'created_at' => 'created_at-input',
           'currency' => 'currency-input',
           'day_of_month' => 'day_of_month-input',
+          'earliest_charge_date_after_resume' => 'earliest_charge_date_after_resume-input',
           'end_date' => 'end_date-input',
           'id' => 'id-input',
           'interval' => 'interval-input',
@@ -189,6 +193,7 @@ describe GoCardlessPro::Resources::Subscription do
                 'created_at' => 'created_at-input',
                 'currency' => 'currency-input',
                 'day_of_month' => 'day_of_month-input',
+                'earliest_charge_date_after_resume' => 'earliest_charge_date_after_resume-input',
                 'end_date' => 'end_date-input',
                 'id' => 'id-input',
                 'interval' => 'interval-input',
@@ -231,6 +236,7 @@ describe GoCardlessPro::Resources::Subscription do
               'created_at' => 'created_at-input',
               'currency' => 'currency-input',
               'day_of_month' => 'day_of_month-input',
+              'earliest_charge_date_after_resume' => 'earliest_charge_date_after_resume-input',
               'end_date' => 'end_date-input',
               'id' => 'id-input',
               'interval' => 'interval-input',
@@ -271,6 +277,8 @@ describe GoCardlessPro::Resources::Subscription do
 
         expect(get_list_response.records.first.day_of_month).to eq('day_of_month-input')
 
+        expect(get_list_response.records.first.earliest_charge_date_after_resume).to eq('earliest_charge_date_after_resume-input')
+
         expect(get_list_response.records.first.end_date).to eq('end_date-input')
 
         expect(get_list_response.records.first.id).to eq('id-input')
@@ -317,6 +325,7 @@ describe GoCardlessPro::Resources::Subscription do
             'created_at' => 'created_at-input',
             'currency' => 'currency-input',
             'day_of_month' => 'day_of_month-input',
+            'earliest_charge_date_after_resume' => 'earliest_charge_date_after_resume-input',
             'end_date' => 'end_date-input',
             'id' => 'id-input',
             'interval' => 'interval-input',
@@ -351,6 +360,7 @@ describe GoCardlessPro::Resources::Subscription do
             'created_at' => 'created_at-input',
             'currency' => 'currency-input',
             'day_of_month' => 'day_of_month-input',
+            'earliest_charge_date_after_resume' => 'earliest_charge_date_after_resume-input',
             'end_date' => 'end_date-input',
             'id' => 'id-input',
             'interval' => 'interval-input',
@@ -401,6 +411,7 @@ describe GoCardlessPro::Resources::Subscription do
                 'created_at' => 'created_at-input',
                 'currency' => 'currency-input',
                 'day_of_month' => 'day_of_month-input',
+                'earliest_charge_date_after_resume' => 'earliest_charge_date_after_resume-input',
                 'end_date' => 'end_date-input',
                 'id' => 'id-input',
                 'interval' => 'interval-input',
@@ -445,6 +456,7 @@ describe GoCardlessPro::Resources::Subscription do
               'created_at' => 'created_at-input',
               'currency' => 'currency-input',
               'day_of_month' => 'day_of_month-input',
+              'earliest_charge_date_after_resume' => 'earliest_charge_date_after_resume-input',
               'end_date' => 'end_date-input',
               'id' => 'id-input',
               'interval' => 'interval-input',
@@ -511,6 +523,7 @@ describe GoCardlessPro::Resources::Subscription do
               'created_at' => 'created_at-input',
               'currency' => 'currency-input',
               'day_of_month' => 'day_of_month-input',
+              'earliest_charge_date_after_resume' => 'earliest_charge_date_after_resume-input',
               'end_date' => 'end_date-input',
               'id' => 'id-input',
               'interval' => 'interval-input',
@@ -537,6 +550,186 @@ describe GoCardlessPro::Resources::Subscription do
     end
   end
 
+  describe '#pause' do
+    subject(:post_response) { client.subscriptions.pause(resource_id) }
+
+    let(:resource_id) { 'ABC123' }
+
+    let!(:stub) do
+      # /subscriptions/%v/actions/pause
+      stub_url = '/subscriptions/:identity/actions/pause'.gsub(':identity', resource_id)
+      stub_request(:post, /.*api.gocardless.com#{stub_url}/).to_return(
+        body: {
+          'subscriptions' => {
+
+            'amount' => 'amount-input',
+            'app_fee' => 'app_fee-input',
+            'count' => 'count-input',
+            'created_at' => 'created_at-input',
+            'currency' => 'currency-input',
+            'day_of_month' => 'day_of_month-input',
+            'earliest_charge_date_after_resume' => 'earliest_charge_date_after_resume-input',
+            'end_date' => 'end_date-input',
+            'id' => 'id-input',
+            'interval' => 'interval-input',
+            'interval_unit' => 'interval_unit-input',
+            'links' => 'links-input',
+            'metadata' => 'metadata-input',
+            'month' => 'month-input',
+            'name' => 'name-input',
+            'payment_reference' => 'payment_reference-input',
+            'retry_if_possible' => 'retry_if_possible-input',
+            'start_date' => 'start_date-input',
+            'status' => 'status-input',
+            'upcoming_payments' => 'upcoming_payments-input',
+          },
+        }.to_json,
+        headers: response_headers
+      )
+    end
+
+    it 'wraps the response and calls the right endpoint' do
+      expect(post_response).to be_a(GoCardlessPro::Resources::Subscription)
+
+      expect(stub).to have_been_requested
+    end
+
+    context 'when the request needs a body and custom header' do
+      let(:body) { { foo: 'bar' } }
+      let(:headers) { { 'Foo' => 'Bar' } }
+      subject(:post_response) { client.subscriptions.pause(resource_id, body, headers) }
+
+      let(:resource_id) { 'ABC123' }
+
+      let!(:stub) do
+        # /subscriptions/%v/actions/pause
+        stub_url = '/subscriptions/:identity/actions/pause'.gsub(':identity', resource_id)
+        stub_request(:post, /.*api.gocardless.com#{stub_url}/).
+          with(
+            body: { foo: 'bar' },
+            headers: { 'Foo' => 'Bar' }
+          ).to_return(
+            body: {
+              'subscriptions' => {
+
+                'amount' => 'amount-input',
+                'app_fee' => 'app_fee-input',
+                'count' => 'count-input',
+                'created_at' => 'created_at-input',
+                'currency' => 'currency-input',
+                'day_of_month' => 'day_of_month-input',
+                'earliest_charge_date_after_resume' => 'earliest_charge_date_after_resume-input',
+                'end_date' => 'end_date-input',
+                'id' => 'id-input',
+                'interval' => 'interval-input',
+                'interval_unit' => 'interval_unit-input',
+                'links' => 'links-input',
+                'metadata' => 'metadata-input',
+                'month' => 'month-input',
+                'name' => 'name-input',
+                'payment_reference' => 'payment_reference-input',
+                'retry_if_possible' => 'retry_if_possible-input',
+                'start_date' => 'start_date-input',
+                'status' => 'status-input',
+                'upcoming_payments' => 'upcoming_payments-input',
+              },
+            }.to_json,
+            headers: response_headers
+          )
+      end
+    end
+  end
+
+  describe '#resume' do
+    subject(:post_response) { client.subscriptions.resume(resource_id) }
+
+    let(:resource_id) { 'ABC123' }
+
+    let!(:stub) do
+      # /subscriptions/%v/actions/resume
+      stub_url = '/subscriptions/:identity/actions/resume'.gsub(':identity', resource_id)
+      stub_request(:post, /.*api.gocardless.com#{stub_url}/).to_return(
+        body: {
+          'subscriptions' => {
+
+            'amount' => 'amount-input',
+            'app_fee' => 'app_fee-input',
+            'count' => 'count-input',
+            'created_at' => 'created_at-input',
+            'currency' => 'currency-input',
+            'day_of_month' => 'day_of_month-input',
+            'earliest_charge_date_after_resume' => 'earliest_charge_date_after_resume-input',
+            'end_date' => 'end_date-input',
+            'id' => 'id-input',
+            'interval' => 'interval-input',
+            'interval_unit' => 'interval_unit-input',
+            'links' => 'links-input',
+            'metadata' => 'metadata-input',
+            'month' => 'month-input',
+            'name' => 'name-input',
+            'payment_reference' => 'payment_reference-input',
+            'retry_if_possible' => 'retry_if_possible-input',
+            'start_date' => 'start_date-input',
+            'status' => 'status-input',
+            'upcoming_payments' => 'upcoming_payments-input',
+          },
+        }.to_json,
+        headers: response_headers
+      )
+    end
+
+    it 'wraps the response and calls the right endpoint' do
+      expect(post_response).to be_a(GoCardlessPro::Resources::Subscription)
+
+      expect(stub).to have_been_requested
+    end
+
+    context 'when the request needs a body and custom header' do
+      let(:body) { { foo: 'bar' } }
+      let(:headers) { { 'Foo' => 'Bar' } }
+      subject(:post_response) { client.subscriptions.resume(resource_id, body, headers) }
+
+      let(:resource_id) { 'ABC123' }
+
+      let!(:stub) do
+        # /subscriptions/%v/actions/resume
+        stub_url = '/subscriptions/:identity/actions/resume'.gsub(':identity', resource_id)
+        stub_request(:post, /.*api.gocardless.com#{stub_url}/).
+          with(
+            body: { foo: 'bar' },
+            headers: { 'Foo' => 'Bar' }
+          ).to_return(
+            body: {
+              'subscriptions' => {
+
+                'amount' => 'amount-input',
+                'app_fee' => 'app_fee-input',
+                'count' => 'count-input',
+                'created_at' => 'created_at-input',
+                'currency' => 'currency-input',
+                'day_of_month' => 'day_of_month-input',
+                'earliest_charge_date_after_resume' => 'earliest_charge_date_after_resume-input',
+                'end_date' => 'end_date-input',
+                'id' => 'id-input',
+                'interval' => 'interval-input',
+                'interval_unit' => 'interval_unit-input',
+                'links' => 'links-input',
+                'metadata' => 'metadata-input',
+                'month' => 'month-input',
+                'name' => 'name-input',
+                'payment_reference' => 'payment_reference-input',
+                'retry_if_possible' => 'retry_if_possible-input',
+                'start_date' => 'start_date-input',
+                'status' => 'status-input',
+                'upcoming_payments' => 'upcoming_payments-input',
+              },
+            }.to_json,
+            headers: response_headers
+          )
+      end
+    end
+  end
+
   describe '#cancel' do
     subject(:post_response) { client.subscriptions.cancel(resource_id) }
 
@@ -555,6 +748,7 @@ describe GoCardlessPro::Resources::Subscription do
             'created_at' => 'created_at-input',
             'currency' => 'currency-input',
             'day_of_month' => 'day_of_month-input',
+            'earliest_charge_date_after_resume' => 'earliest_charge_date_after_resume-input',
             'end_date' => 'end_date-input',
             'id' => 'id-input',
             'interval' => 'interval-input',
@@ -604,6 +798,7 @@ describe GoCardlessPro::Resources::Subscription do
                 'created_at' => 'created_at-input',
                 'currency' => 'currency-input',
                 'day_of_month' => 'day_of_month-input',
+                'earliest_charge_date_after_resume' => 'earliest_charge_date_after_resume-input',
                 'end_date' => 'end_date-input',
                 'id' => 'id-input',
                 'interval' => 'interval-input',