adyen-ruby-api-library 11.1.0 → 11.3.0

data/sdk-generation-log/dataprotection.json

@@ -0,0 +1,8 @@
+{
+  "service": "dataprotection",
+  "project": "ruby",
+  "generatedAt": "2026-04-20T13:39:47Z",
+  "openapiCommitSha": "3550ecd3f320efaad6bee55ffed5122cb9ba09d5",
+  "automationCommitSha": "4ad0c0c7e87bc0e5994a9a3350a991d0691350bb",
+  "libraryCommitSha": "60ccdbdbbb7069d54600a8a8cd19eea245661134"
+}

data/sdk-generation-log/disputes.json

@@ -0,0 +1,8 @@
+{
+  "service": "disputes",
+  "project": "ruby",
+  "generatedAt": "2026-04-20T13:39:52Z",
+  "openapiCommitSha": "3550ecd3f320efaad6bee55ffed5122cb9ba09d5",
+  "automationCommitSha": "4ad0c0c7e87bc0e5994a9a3350a991d0691350bb",
+  "libraryCommitSha": "60ccdbdbbb7069d54600a8a8cd19eea245661134"
+}

data/sdk-generation-log/legalentitymanagement.json

@@ -0,0 +1,8 @@
+{
+  "service": "legalentitymanagement",
+  "project": "ruby",
+  "generatedAt": "2026-04-20T13:39:46Z",
+  "openapiCommitSha": "3550ecd3f320efaad6bee55ffed5122cb9ba09d5",
+  "automationCommitSha": "4ad0c0c7e87bc0e5994a9a3350a991d0691350bb",
+  "libraryCommitSha": "60ccdbdbbb7069d54600a8a8cd19eea245661134"
+}

data/sdk-generation-log/management.json

@@ -0,0 +1,8 @@
+{
+  "service": "management",
+  "project": "ruby",
+  "generatedAt": "2026-04-20T13:39:49Z",
+  "openapiCommitSha": "3550ecd3f320efaad6bee55ffed5122cb9ba09d5",
+  "automationCommitSha": "4ad0c0c7e87bc0e5994a9a3350a991d0691350bb",
+  "libraryCommitSha": "60ccdbdbbb7069d54600a8a8cd19eea245661134"
+}

data/sdk-generation-log/payment.json

@@ -0,0 +1,8 @@
+{
+  "service": "payment",
+  "project": "ruby",
+  "generatedAt": "2026-04-20T13:39:48Z",
+  "openapiCommitSha": "3550ecd3f320efaad6bee55ffed5122cb9ba09d5",
+  "automationCommitSha": "4ad0c0c7e87bc0e5994a9a3350a991d0691350bb",
+  "libraryCommitSha": "60ccdbdbbb7069d54600a8a8cd19eea245661134"
+}

data/sdk-generation-log/paymentsapp.json

@@ -0,0 +1,8 @@
+{
+  "service": "paymentsapp",
+  "project": "ruby",
+  "generatedAt": "2026-04-20T13:40:00Z",
+  "openapiCommitSha": "3550ecd3f320efaad6bee55ffed5122cb9ba09d5",
+  "automationCommitSha": "4ad0c0c7e87bc0e5994a9a3350a991d0691350bb",
+  "libraryCommitSha": "60ccdbdbbb7069d54600a8a8cd19eea245661134"
+}

data/sdk-generation-log/payout.json

@@ -0,0 +1,8 @@
+{
+  "service": "payout",
+  "project": "ruby",
+  "generatedAt": "2026-04-20T13:39:45Z",
+  "openapiCommitSha": "3550ecd3f320efaad6bee55ffed5122cb9ba09d5",
+  "automationCommitSha": "4ad0c0c7e87bc0e5994a9a3350a991d0691350bb",
+  "libraryCommitSha": "60ccdbdbbb7069d54600a8a8cd19eea245661134"
+}

data/sdk-generation-log/posmobile.json

@@ -0,0 +1,8 @@
+{
+  "service": "posmobile",
+  "project": "ruby",
+  "generatedAt": "2026-04-20T13:39:47Z",
+  "openapiCommitSha": "3550ecd3f320efaad6bee55ffed5122cb9ba09d5",
+  "automationCommitSha": "4ad0c0c7e87bc0e5994a9a3350a991d0691350bb",
+  "libraryCommitSha": "60ccdbdbbb7069d54600a8a8cd19eea245661134"
+}

data/sdk-generation-log/recurring.json

@@ -0,0 +1,8 @@
+{
+  "service": "recurring",
+  "project": "ruby",
+  "generatedAt": "2026-04-20T13:39:48Z",
+  "openapiCommitSha": "3550ecd3f320efaad6bee55ffed5122cb9ba09d5",
+  "automationCommitSha": "4ad0c0c7e87bc0e5994a9a3350a991d0691350bb",
+  "libraryCommitSha": "60ccdbdbbb7069d54600a8a8cd19eea245661134"
+}

data/sdk-generation-log/sessionauthentication.json

@@ -0,0 +1,8 @@
+{
+  "service": "sessionauthentication",
+  "project": "ruby",
+  "generatedAt": "2026-04-20T13:39:49Z",
+  "openapiCommitSha": "3550ecd3f320efaad6bee55ffed5122cb9ba09d5",
+  "automationCommitSha": "4ad0c0c7e87bc0e5994a9a3350a991d0691350bb",
+  "libraryCommitSha": "60ccdbdbbb7069d54600a8a8cd19eea245661134"
+}

data/sdk-generation-log/storedvalue.json

@@ -0,0 +1,8 @@
+{
+  "service": "storedvalue",
+  "project": "ruby",
+  "generatedAt": "2026-04-20T13:39:48Z",
+  "openapiCommitSha": "3550ecd3f320efaad6bee55ffed5122cb9ba09d5",
+  "automationCommitSha": "4ad0c0c7e87bc0e5994a9a3350a991d0691350bb",
+  "libraryCommitSha": "60ccdbdbbb7069d54600a8a8cd19eea245661134"
+}

data/sdk-generation-log/transfers.json

@@ -0,0 +1,8 @@
+{
+  "service": "transfers",
+  "project": "ruby",
+  "generatedAt": "2026-04-20T13:39:51Z",
+  "openapiCommitSha": "3550ecd3f320efaad6bee55ffed5122cb9ba09d5",
+  "automationCommitSha": "4ad0c0c7e87bc0e5994a9a3350a991d0691350bb",
+  "libraryCommitSha": "60ccdbdbbb7069d54600a8a8cd19eea245661134"
+}

data/spec/balance_platform_spec.rb

@@ -384,6 +384,117 @@ RSpec.describe Adyen::BalancePlatform, service: 'balancePlatform' do
     expect(response_hash).to be_a_kind_of Hash
   end
 
+  it 'makes a get_tax_form_summary GET call' do
+    response_body = json_from_file('mocks/responses/BalancePlatform/get_tax_form_summary.json')
+    account_holder_id = 'AH3227C223222C5GKR23686TF'
+
+    url = @shared_values[:client].service_url(
+      @shared_values[:service],
+      "accountHolders/#{account_holder_id}/taxFormSummary",
+      @shared_values[:client].balance_platform.version
+    )
+    WebMock.stub_request(:get, url)
+           .with(headers: { 'x-api-key' => @shared_values[:client].api_key })
+           .to_return(body: response_body)
+
+    result = @shared_values[:client].balance_platform.account_holders_api
+                                    .get_tax_form_summary(account_holder_id)
+    response_hash = result.response
+
+    expect(result.status).to eq(200)
+    expect(response_hash).to eq(JSON.parse(response_body))
+    expect(response_hash).to be_a Adyen::HashWithAccessors
+    expect(response_hash).to be_a_kind_of Hash
+  end
+
+  ## directDebitMandates
+  it 'makes a get_list_of_mandates GET call' do
+    response_body = json_from_file('mocks/responses/BalancePlatform/get_list_of_mandates.json')
+
+    url = @shared_values[:client].service_url(
+      @shared_values[:service],
+      'mandates',
+      @shared_values[:client].balance_platform.version
+    )
+    WebMock.stub_request(:get, url)
+           .with(headers: { 'x-api-key' => @shared_values[:client].api_key })
+           .to_return(body: response_body)
+
+    result = @shared_values[:client].balance_platform.direct_debit_mandates_api.get_list_of_mandates
+    response_hash = result.response
+
+    expect(result.status).to eq(200)
+    expect(response_hash).to eq(JSON.parse(response_body))
+    expect(response_hash).to be_a Adyen::HashWithAccessors
+    expect(response_hash).to be_a_kind_of Hash
+  end
+
+  it 'makes a get_mandate_by_id GET call' do
+    response_body = json_from_file('mocks/responses/BalancePlatform/get_mandate_by_id.json')
+    mandate_id = 'MNDT7QXPLKT9R333640TX334709E'
+
+    url = @shared_values[:client].service_url(
+      @shared_values[:service],
+      "mandates/#{mandate_id}",
+      @shared_values[:client].balance_platform.version
+    )
+    WebMock.stub_request(:get, url)
+           .with(headers: { 'x-api-key' => @shared_values[:client].api_key })
+           .to_return(body: response_body)
+
+    result = @shared_values[:client].balance_platform.direct_debit_mandates_api.get_mandate_by_id(mandate_id)
+    response_hash = result.response
+
+    expect(result.status).to eq(200)
+    expect(response_hash).to eq(JSON.parse(response_body))
+    expect(response_hash).to be_a Adyen::HashWithAccessors
+    expect(response_hash).to be_a_kind_of Hash
+  end
+
+  it 'makes a cancel_mandate POST call' do
+    mandate_id = 'MNDT7QXPLKT9R333640TX334709E'
+
+    url = @shared_values[:client].service_url(
+      @shared_values[:service],
+      "mandates/#{mandate_id}/cancel",
+      @shared_values[:client].balance_platform.version
+    )
+    WebMock.stub_request(:post, url)
+           .with(headers: { 'x-api-key' => @shared_values[:client].api_key })
+           .to_return(status: 202, body: '')
+
+    result = @shared_values[:client].balance_platform.direct_debit_mandates_api.cancel_mandate(mandate_id)
+
+    expect(result.status).to eq(202)
+  end
+
+  it 'makes an update_mandate PATCH call' do
+    request_body = JSON.parse(json_from_file('mocks/requests/BalancePlatform/update_mandate.json'))
+    response_body = json_from_file('mocks/responses/BalancePlatform/get_mandate_by_id.json')
+    mandate_id = 'MNDT7QXPLKT9R333640TX334709E'
+
+    url = @shared_values[:client].service_url(
+      @shared_values[:service],
+      "mandates/#{mandate_id}",
+      @shared_values[:client].balance_platform.version
+    )
+    WebMock.stub_request(:patch, url)
+           .with(
+             body: request_body,
+             headers: { 'x-api-key' => @shared_values[:client].api_key }
+           )
+           .to_return(body: response_body)
+
+    result = @shared_values[:client].balance_platform.direct_debit_mandates_api
+                                    .update_mandate(request_body, mandate_id)
+    response_hash = result.response
+
+    expect(result.status).to eq(200)
+    expect(response_hash).to eq(JSON.parse(response_body))
+    expect(response_hash).to be_a Adyen::HashWithAccessors
+    expect(response_hash).to be_a_kind_of Hash
+  end
+
   ## authorisedCardUsers
   it 'makes a get_all_authorised_card_users GET call' do
     response_body = json_from_file('mocks/responses/BalancePlatform/get_all_authorised_card_users.json')

data/spec/capital_spec.rb

@@ -0,0 +1,268 @@
+require 'spec_helper'
+require 'json'
+
+RSpec.describe Adyen::Capital do
+  let(:client) { create_client(:api_key) }
+  let(:service) { 'Capital' }
+  let(:version) { client.capital.version }
+
+  describe 'DynamicOffersApi' do
+    let(:dynamic_offer_id) { 'DO00000000000000000000001' }
+
+    it 'calculates a preliminary offer from a dynamic offer' do
+      response_body = json_from_file('mocks/responses/Capital/calculate-preliminary-offer-from-dynamic-offer.json')
+      request_payload = { "amount" => { "currency" => "EUR", "value" => 10000 } }
+
+      url = client.service_url(service, "dynamicOffers/#{dynamic_offer_id}/calculate", version)
+
+      WebMock.stub_request(:post, url)
+             .with(
+               body: request_payload,
+               headers: { 'x-api-key' => client.api_key }
+             )
+             .to_return(body: response_body)
+
+      result = client.capital.dynamic_offers_api.calculate_preliminary_offer_from_dynamic_offer(request_payload, dynamic_offer_id)
+
+      expect(result.status).to eq(200)
+      expect(result.response).to eq(JSON.parse(response_body))
+      expect(result.response).to be_a(Adyen::HashWithAccessors)
+      expect(result.response['id']).to eq(dynamic_offer_id)
+    end
+
+    it 'creates a static offer from a dynamic offer' do
+      response_body = json_from_file('mocks/responses/Capital/create-static-offer-from-dynamic-offer.json')
+      request_payload = { "amount" => { "currency" => "EUR", "value" => 10000 } }
+
+      url = client.service_url(service, "dynamicOffers/#{dynamic_offer_id}/grantOffer", version)
+
+      WebMock.stub_request(:post, url)
+             .with(
+               body: request_payload,
+               headers: { 'x-api-key' => client.api_key }
+             )
+             .to_return(body: response_body)
+
+      result = client.capital.dynamic_offers_api.create_static_offer_from_dynamic_offer(request_payload, dynamic_offer_id)
+
+      expect(result.status).to eq(200)
+      expect(result.response).to eq(JSON.parse(response_body))
+      expect(result.response).to be_a(Adyen::HashWithAccessors)
+      expect(result.response['id']).to eq('GO00000000000000000000002')
+    end
+
+    it 'gets all dynamic offers' do
+      response_body = json_from_file('mocks/responses/Capital/get-all-dynamic-offers.json')
+
+      url = client.service_url(service, 'dynamicOffers', version)
+
+      WebMock.stub_request(:get, url)
+             .with(headers: { 'x-api-key' => client.api_key })
+             .to_return(body: response_body)
+
+      result = client.capital.dynamic_offers_api.get_all_dynamic_offers
+
+      expect(result.status).to eq(200)
+      expect(result.response).to eq(JSON.parse(response_body))
+      expect(result.response).to be_a(Adyen::HashWithAccessors)
+      expect(result.response['dynamicOffers'].first['id']).to eq(dynamic_offer_id)
+    end
+
+    it 'gets all dynamic offers with query params' do
+      response_body = json_from_file('mocks/responses/Capital/get-all-dynamic-offers.json')
+      account_holder_id = 'AH00000000000000000000001'
+
+      url = client.service_url(service, 'dynamicOffers', version)
+
+      WebMock.stub_request(:get, url)
+             .with(
+               query: { 'accountHolderId' => account_holder_id },
+               headers: { 'x-api-key' => client.api_key }
+             )
+             .to_return(body: response_body)
+
+      result = client.capital.dynamic_offers_api.get_all_dynamic_offers(query_params: { 'accountHolderId' => account_holder_id })
+
+      expect(result.status).to eq(200)
+      expect(result.response).to eq(JSON.parse(response_body))
+    end
+  end
+
+  describe 'GrantAccountsApi' do
+    it 'gets grant account information' do
+      response_body = json_from_file('mocks/responses/Capital/get-grant-account-success.json')
+      grant_account_id = 'CG00000000000000000000001'
+
+      url = client.service_url(service, "grantAccounts/#{grant_account_id}", version)
+
+      WebMock.stub_request(:get, url)
+             .with(headers: { 'x-api-key' => client.api_key })
+             .to_return(body: response_body)
+
+      result = client.capital.grant_accounts_api.get_grant_account_information(grant_account_id)
+
+      expect(result.status).to eq(200)
+      expect(result.response).to eq(JSON.parse(response_body))
+      expect(result.response).to be_a(Adyen::HashWithAccessors)
+      expect(result.response).to be_a(Hash)
+    end
+  end
+
+  describe 'GrantOffersApi' do
+    it 'gets all grant offers with query params' do
+      response_body = json_from_file('mocks/responses/Capital/grant-offers-success.json')
+      account_holder_id = 'AH00000000000000000000001'
+
+      url = client.service_url(service, 'grantOffers', version)
+
+      WebMock.stub_request(:get, url)
+             .with(
+               query: { 'accountHolderId' => account_holder_id },
+               headers: { 'x-api-key' => client.api_key }
+             )
+             .to_return(body: response_body)
+
+      result = client.capital.grant_offers_api.get_all_grant_offers(query_params: { 'accountHolderId' => account_holder_id })
+
+      expect(result.status).to eq(200)
+      expect(result.response).to eq(JSON.parse(response_body))
+    end
+
+    it 'gets all grant offers without query params' do
+      response_body = json_from_file('mocks/responses/Capital/grant-offers-success.json')
+
+      url = client.service_url(service, 'grantOffers', version)
+
+      WebMock.stub_request(:get, url)
+             .with(headers: { 'x-api-key' => client.api_key })
+             .to_return(body: response_body)
+
+      result = client.capital.grant_offers_api.get_all_grant_offers
+
+      expect(result.status).to eq(200)
+      expect(result.response).to eq(JSON.parse(response_body))
+    end
+
+    it 'gets a specific grant offer' do
+      response_body = json_from_file('mocks/responses/Capital/get-grant-offer-success.json')
+      id = 'GO00000000000000000000001'
+
+      url = client.service_url(service, "grantOffers/#{id}", version)
+
+      WebMock.stub_request(:get, url)
+             .with(headers: { 'x-api-key' => client.api_key })
+             .to_return(body: response_body)
+
+      result = client.capital.grant_offers_api.get_grant_offer(id)
+
+      expect(result.status).to eq(200)
+      expect(result.response).to eq(JSON.parse(response_body))
+    end
+  end
+
+  describe 'GrantsApi' do
+    it 'gets a specific grant' do
+      response_body = json_from_file('mocks/responses/Capital/get-grant-success.json')
+      id = 'GR00000000000000000000001'
+
+      url = client.service_url(service, "grants/#{id}", version)
+
+      WebMock.stub_request(:get, url)
+             .with(headers: { 'x-api-key' => client.api_key })
+             .to_return(body: response_body)
+
+      result = client.capital.grants_api.get_grant(id)
+
+      expect(result.status).to eq(200)
+      expect(result.response).to eq(JSON.parse(response_body))
+    end
+
+    it 'gets all grants' do
+      response_body = json_from_file('mocks/responses/Capital/grants-success.json')
+
+      url = client.service_url(service, 'grants', version)
+
+      WebMock.stub_request(:get, url)
+             .with(headers: { 'x-api-key' => client.api_key })
+             .to_return(body: response_body)
+
+      result = client.capital.grants_api.get_all_grants
+
+      expect(result.status).to eq(200)
+      expect(result.response).to eq(JSON.parse(response_body))
+    end
+
+    it 'requests a grant' do
+      request_payload = { "grantAccountId" => "GR00000000000000000000001" }
+      response_body = json_from_file('mocks/responses/Capital/request-grant.json')
+
+      url = client.service_url(service, 'grants', version)
+
+      WebMock.stub_request(:post, url)
+             .with(
+               body: request_payload,
+               headers: { 'x-api-key' => client.api_key }
+             )
+             .to_return(body: response_body)
+
+      result = client.capital.grants_api.request_grant(request_payload)
+
+      expect(result.status).to eq(200)
+      expect(result.response).to eq(JSON.parse(response_body))
+    end
+
+    it 'gets a grant disbursement' do
+      response_body = json_from_file('mocks/responses/Capital/get-grant-disbursement-success.json')
+      grant_id = 'GR00000000000000000000001'
+      disbursement_id = 'DI00000000000000000000001'
+
+      url = client.service_url(service, "grants/#{grant_id}/disbursements/#{disbursement_id}", version)
+
+      WebMock.stub_request(:get, url)
+             .with(headers: { 'x-api-key' => client.api_key })
+             .to_return(body: response_body)
+
+      result = client.capital.grants_api.get_grant_disbursement(grant_id, disbursement_id)
+
+      expect(result.status).to eq(200)
+      expect(result.response).to eq(JSON.parse(response_body))
+    end
+
+    it 'gets all grant disbursements' do
+      response_body = json_from_file('mocks/responses/Capital/get-grant-disbursements-success.json')
+      grant_id = 'GR00000000000000000000001'
+
+      url = client.service_url(service, "grants/#{grant_id}/disbursements", version)
+
+      WebMock.stub_request(:get, url)
+             .with(headers: { 'x-api-key' => client.api_key })
+             .to_return(body: response_body)
+
+      result = client.capital.grants_api.get_all_grant_disbursements(grant_id)
+
+      expect(result.status).to eq(200)
+      expect(result.response).to eq(JSON.parse(response_body))
+    end
+
+    it 'updates a grant disbursement' do
+      response_body = json_from_file('mocks/responses/Capital/update-grant-disbursement-success.json')
+      grant_id = 'GR00000000000000000000001'
+      disbursement_id = 'DI00000000000000000000001'
+      request_payload = {}
+
+      url = client.service_url(service, "grants/#{grant_id}/disbursements/#{disbursement_id}", version)
+
+      WebMock.stub_request(:patch, url)
+             .with(
+               body: request_payload,
+               headers: { 'x-api-key' => client.api_key }
+             )
+             .to_return(body: response_body)
+
+      result = client.capital.grants_api.update_grant_disbursement(request_payload, grant_id, disbursement_id)
+
+      expect(result.status).to eq(200)
+      expect(result.response).to eq(JSON.parse(response_body))
+    end
+  end
+end