adyen-ruby-api-library 7.0.3 → 7.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c3424394aa97925505130c2e86a526725f575d94bb5276bc2212377433430943
-  data.tar.gz: de79dd2ca8be5d5c239e9b3883b9972712cd03227133ab6b66cf8aa88add1f9c
+  metadata.gz: e77636d4dad0702e8816c00de1f5cf37ab3d1c841f73b2b20f5e256275458e53
+  data.tar.gz: fc410bcae06fc7a846e1a72edc39d34f838e2253e59c9e315839c9c299723b55
 SHA512:
-  metadata.gz: 81fb04e71363771981693afda6387d2e00cd22207444282be51de1f4913d0a7477429acd8b2502bb2f5e440fdc4ece3fa40b95134e358e66eab319336f85489c
-  data.tar.gz: 8c76a644b6ccd599b892cb7df34b80c0d978ae91ff8f0a0b417ea496d775d69b9e07901edb7a7cb5f066c700ebf42f35161ed686e2128219a29a5e949e15c87c
+  metadata.gz: 6c79bf2bfd30680ad73ac71f18416436bdfcfeb110260c3f78456aac857acafeb52f915be43fa2f26f9570c1a6846ed02751dd4b147b574ea4ed35d0e6ce7d8f
+  data.tar.gz: 2848c7cba6583e4ed195c71eaf8e736832bf8b55e713d3f9001d71cea4d129471f1da92a3c5d59e88f3c8c592fd8854039c9f7350955f0361bc059422a7289fc

data/README.md

@@ -21,6 +21,7 @@ This library supports the following:
 | [Recurring API](https://docs.adyen.com/api-explorer/Recurring/68/overview) | v68 | Endpoints for managing saved payment details. | [Recurring](lib/adyen/services/recurring.rb) |
 | [Stored Value API](https://docs.adyen.com/payment-methods/gift-cards/stored-value-api) | v46 | Manage both online and point-of-sale gift cards and other stored-value cards. | [StoredValue](lib/adyen/services/storedValue.rb) |
 | [Transfers API](https://docs.adyen.com/api-explorer/transfers/3/overview) | v3 | The Transfers API provides endpoints that can be used to get information about all your transactions, move funds within your balance platform or send funds from your balance platform to a transfer instrument. | [Transfers](lib/adyen/services/transfers.rb) |
+| [Cloud-based Terminal API](https://docs.adyen.com/point-of-sale/design-your-integration/terminal-api/terminal-api-reference/) | - | Our point-of-sale integration. | [TerminalCloudAPI](lib/adyen/services/terminalCloudAPI.rb) |
 
 For more information, refer to our [documentation](https://docs.adyen.com/) or the [API Explorer](https://docs.adyen.com/api-explorer/).
 
@@ -99,6 +100,121 @@ To run the tests use :
 bundle install --with development 
 ~~~~
 
+## Using the Cloud Terminal API Integration
+In order to submit In-Person requests with [Terminal API over Cloud](https://docs.adyen.com/point-of-sale/design-your-integration/choose-your-architecture/cloud/) you need to initialize the client in the same way as explained above for Ecommerce transactions:
+``` ruby
+# Step 1: Require the parts of the module you want to use
+require 'adyen-ruby-api-library'
+
+# Step 2: Initialize the client object
+adyen = Adyen::Client.new(api_key: 'YOUR_API_KEY', env: :test)
+
+# Step 3: Create the request
+serviceID = "123456789"
+saleID = "POS-SystemID12345"
+POIID = "Your Device Name(eg V400m-123456789)"
+
+# Use a unique transaction for every transaction you perform
+transactionID = "TransactionID"
+
+request = 
+{
+  "SaleToPOIRequest": {
+    "MessageHeader": {
+      "MessageClass": "Service",
+      "MessageCategory": "Payment",
+      "MessageType": "Request",
+      "ServiceID": serviceID,
+      "SaleID": saleID,
+      "POIID": POIID,
+      "ProtocolVersion": "3.0"
+    },
+    "PaymentRequest": {
+      "SaleData": {
+        "SaleTransactionID": {
+          "TransactionID": transactionID,
+          "TimeStamp": "2023-08-23T09:48:55"
+        },
+        "SaleToAcquirerData": "eyJhcHBsaWNhdGlvbkluZm8iOnsiYWR5ZW5MaWJyYXJ5Ijp7Im5hbWUiOiJhZ....",
+        "TokenRequestedType": "Transaction"
+      },
+      "PaymentTransaction": {
+        "AmountsReq": {
+          "Currency": "EUR",
+          "RequestedAmount": 10
+        }
+      }
+    }
+  }
+}
+
+# Step 4: Make the request
+response = adyen.terminal_cloud_api.sync(request)
+```
+
+### Optional: perform an abort request
+
+To perform an [abort request](https://docs.adyen.com/point-of-sale/basic-tapi-integration/cancel-a-transaction/) you can use the following example:
+``` ruby
+abortRequest = 
+{
+  "MessageHeader": {
+    "MessageClass": "Service",
+    "MessageCategory": "Abort",
+    "MessageType": "Request",
+    "ServiceID": serviceID,
+    "SaleID": saleID,
+    "POIID": POIID,
+    "ProtocolVersion": "3.0"
+  },
+  "AbortRequest": {
+    "AbortReason": "MerchantAbort",
+    "MessageReference": {
+      "MessageCategory": "Payment",
+      "SaleID": saleID,
+      # Service ID of the payment you're aborting
+      "ServiceID": serviceID,
+      "POIID": POIID
+    }
+  }
+}
+
+response = adyen.terminal_cloud_api.sync(abortRequest)
+```
+
+### Optional: perform a status request
+
+To perform a [status request](https://docs.adyen.com/point-of-sale/basic-tapi-integration/verify-transaction-status/) you can use the following example:
+``` ruby
+statusRequest =
+{
+  "MessageHeader": {
+    "MessageClass": "Service",
+    "MessageCategory": "TransactionStatus",
+    "MessageType": "Request",
+    "ServiceID": serviceID,
+    "SaleID": saleID,
+    "POIID": POIID,
+    "ProtocolVersion": "3.0"
+  },
+  "TransactionStatusRequest": {
+    "ReceiptReprintFlag": true,
+    "DocumentQualifier": [
+      "CashierReceipt",
+      "CustomerReceipt"
+    ],
+    "MessageReference": {
+      "SaleID": saleID,
+      # serviceID of the transaction you want the status update for
+      "ServiceID": serviceID,
+      "MessageCategory": "Payment"
+    }
+  }
+}
+
+response = adyen.terminal_cloud_api.sync(statusRequest)
+```
+
 ## Feedback
 We value your input! Help us enhance our API Libraries and improve the integration experience by providing your feedback. Please take a moment to fill out [our feedback form](https://forms.gle/A4EERrR6CWgKWe5r9) to share your thoughts, suggestions or ideas.
 

data/lib/adyen/client.rb

@@ -75,6 +75,9 @@ module Adyen
         when 'Management'
           url = "https://management-#{@env}.adyen.com"
           supports_live_url_prefix = false
+        when 'TerminalCloudAPI'
+          url = "https://terminal-api-#{@env}.adyen.com"
+          supports_live_url_prefix = false
         else
           raise ArgumentError, 'Invalid service specified'
         end
@@ -98,6 +101,8 @@ module Adyen
     def service_url(service, action, version)
       if service == "Checkout" && @env == :live
         return "#{service_url_base(service)}/checkout/v#{version}/#{action}"
+      elsif version == nil
+        return "#{service_url_base(service)}/#{action}"
       else
         return "#{service_url_base(service)}/v#{version}/#{action}"
       end
@@ -221,6 +226,9 @@ module Adyen
       # delete has no response.body (unless it throws an error)
       if response.body.nil? || response.body === ''
         AdyenResult.new('{}', response.headers, response.status)
+      # terminal API async call returns always 'ok'
+      elsif response.body === 'ok'
+        AdyenResult.new('{}', response.headers, response.status)
       else
         AdyenResult.new(response.body, response.headers, response.status)
       end
@@ -286,6 +294,10 @@ module Adyen
     def balance_control_service
       @balance_control_service ||= Adyen::BalanceControlService.new(self)
     end
+
+    def terminal_cloud_api
+      @terminal_cloud_api ||= Adyen::TerminalCloudAPI.new(self)
+    end
   end
 end
 # rubocop:enable all

data/lib/adyen/services/balancePlatform/network_tokens_api.rb

@@ -0,0 +1,29 @@
+require_relative '../service'
+module Adyen
+  class NetworkTokensApi < Service
+    attr_accessor :service, :version
+
+    def initialize(client, version = DEFAULT_VERSION)
+      super(client, version, 'BalancePlatform')
+    end
+
+    def get_network_token(network_token_id, headers: {})
+      endpoint = '/networkTokens/{networkTokenId}'.gsub(/{.+?}/, '%s')
+      endpoint = endpoint.gsub(%r{^/}, '')
+      endpoint = format(endpoint, network_token_id)
+      
+      action = { method: 'get', url: endpoint }
+      @client.call_adyen_api(@service, action, {}, headers, @version)
+    end
+
+    def update_network_token(request, network_token_id, headers: {})
+      endpoint = '/networkTokens/{networkTokenId}'.gsub(/{.+?}/, '%s')
+      endpoint = endpoint.gsub(%r{^/}, '')
+      endpoint = format(endpoint, network_token_id)
+      
+      action = { method: 'patch', url: endpoint }
+      @client.call_adyen_api(@service, action, request, headers, @version)
+    end
+
+  end
+end

data/lib/adyen/services/balancePlatform/payment_instruments_api.rb

@@ -16,6 +16,15 @@ module Adyen
       @client.call_adyen_api(@service, action, {}, headers, @version)
     end
 
+    def list_network_tokens(id, headers: {})
+      endpoint = '/paymentInstruments/{id}/networkTokens'.gsub(/{.+?}/, '%s')
+      endpoint = endpoint.gsub(%r{^/}, '')
+      endpoint = format(endpoint, id)
+      
+      action = { method: 'get', url: endpoint }
+      @client.call_adyen_api(@service, action, {}, headers, @version)
+    end
+
     def get_pan_of_payment_instrument(id, headers: {})
       endpoint = '/paymentInstruments/{id}/reveal'.gsub(/{.+?}/, '%s')
       endpoint = endpoint.gsub(%r{^/}, '')

data/lib/adyen/services/balancePlatform.rb

@@ -3,6 +3,7 @@ require_relative 'balancePlatform/balance_accounts_api'
 require_relative 'balancePlatform/bank_account_validation_api'
 require_relative 'balancePlatform/grant_accounts_api'
 require_relative 'balancePlatform/grant_offers_api'
+require_relative 'balancePlatform/network_tokens_api'
 require_relative 'balancePlatform/payment_instrument_groups_api'
 require_relative 'balancePlatform/payment_instruments_api'
 require_relative 'balancePlatform/platform_api'
@@ -39,6 +40,10 @@ module Adyen
       @grant_offers_api ||= Adyen::GrantOffersApi.new(@client, @version)
     end
 
+    def network_tokens_api
+      @network_tokens_api ||= Adyen::NetworkTokensApi.new(@client, @version)
+    end
+
     def payment_instrument_groups_api
       @payment_instrument_groups_api ||= Adyen::PaymentInstrumentGroupsApi.new(@client, @version)
     end

data/lib/adyen/services/checkout/recurring_api.rb

@@ -7,10 +7,10 @@ module Adyen
       super(client, version, 'Checkout')
     end
 
-    def delete_token_for_stored_payment_details(recurring_id, headers: {}, query_params: {})
-      endpoint = '/storedPaymentMethods/{recurringId}'.gsub(/{.+?}/, '%s')
+    def delete_token_for_stored_payment_details(stored_payment_method_id, headers: {}, query_params: {})
+      endpoint = '/storedPaymentMethods/{storedPaymentMethodId}'.gsub(/{.+?}/, '%s')
       endpoint = endpoint.gsub(%r{^/}, '')
-      endpoint = format(endpoint, recurring_id)
+      endpoint = format(endpoint, stored_payment_method_id)
       endpoint += create_query_string(query_params)
       action = { method: 'delete', url: endpoint }
       @client.call_adyen_api(@service, action, {}, headers, @version)

data/lib/adyen/services/terminalCloudAPI.rb

@@ -0,0 +1,38 @@
+require_relative './service'
+module Adyen
+  class TerminalCloudAPI < Service
+    attr_accessor :service
+
+    def initialize(client)
+      super(client, nil ,'TerminalCloudAPI')
+    end
+
+    def connected_terminals(request, headers: {})
+      endpoint = '/connectedTerminals'.gsub(/{.+?}/, '%s')
+      endpoint = endpoint.gsub(%r{^/}, '')
+      endpoint = format(endpoint)
+      
+      action = { method: 'post', url: endpoint }
+      @client.call_adyen_api(@service, action, request, headers, @version)
+    end
+
+    def sync(request, headers: {})
+      endpoint = '/sync'.gsub(/{.+?}/, '%s')
+      endpoint = endpoint.gsub(%r{^/}, '')
+      endpoint = format(endpoint)
+      
+      action = { method: 'post', url: endpoint }
+      @client.call_adyen_api(@service, action, request, headers, @version)
+    end
+
+    def async(request, headers: {})
+      endpoint = '/async'.gsub(/{.+?}/, '%s')
+      endpoint = endpoint.gsub(%r{^/}, '')
+      endpoint = format(endpoint)
+
+      action = { method: 'post', url: endpoint }
+      @client.call_adyen_api(@service, action, request, headers, @version)
+    end
+
+  end
+end

data/lib/adyen/version.rb

@@ -1,4 +1,4 @@
 module Adyen
   NAME = 'adyen-ruby-api-library'.freeze
-  VERSION = '7.0.3'.freeze
+  VERSION = '7.1.0'.freeze
 end

data/lib/adyen-ruby-api-library.rb

@@ -19,3 +19,4 @@ require_relative 'adyen/services/transfers'
 require_relative 'adyen/services/management'
 require_relative 'adyen/services/storedValue'
 require_relative 'adyen/services/balanceControlService'
+require_relative 'adyen/services/terminalCloudAPI'

data/spec/client_spec.rb

@@ -236,4 +236,23 @@ RSpec.describe Adyen do
     expect(client.service_url('PosTerminalManagement', 'assignTerminals', '1'))
       .to eq('https://postfmapi-test.adyen.com/postfmapi/terminal/v1/assignTerminals')
   end
+
+  it 'checks the creation of TerminalCloudAPI sync url' do
+    client = Adyen::Client.new(api_key: 'api_key', env: :test)
+    expect(client.service_url('TerminalCloudAPI', 'sync', nil))
+      .to eq('https://terminal-api-test.adyen.com/sync')
+  end
+
+  it 'checks the creation of TerminalCloudAPI async url' do
+    client = Adyen::Client.new(api_key: 'api_key', env: :test)
+    expect(client.service_url('TerminalCloudAPI', 'async', nil))
+      .to eq('https://terminal-api-test.adyen.com/async')
+  end
+
+  it 'checks the creation of TerminalCloudAPI connectedTerminals url' do
+    client = Adyen::Client.new(api_key: 'api_key', env: :test)
+    expect(client.service_url('TerminalCloudAPI', 'connectedTerminals', nil))
+      .to eq('https://terminal-api-test.adyen.com/connectedTerminals')
+      
+  end
 end

data/spec/mocks/requests/TerminalCloudAPI/connected_terminals.json

@@ -0,0 +1,3 @@
+{
+    "merchantAccount": "YourMerchantAccount"
+}

data/spec/mocks/requests/TerminalCloudAPI/sync_payment.json

@@ -0,0 +1,29 @@
+{
+    "SaleToPOIRequest": {
+        "MessageHeader": {
+            "MessageClass": "Service",
+            "MessageCategory": "Payment",
+            "MessageType": "Request",
+            "ServiceID": "1233094855",
+            "SaleID": "POSSystemID12345",
+            "POIID": "V400m-1234123412",
+            "ProtocolVersion": "3.0"
+        },
+        "PaymentRequest": {
+            "SaleData": {
+                "SaleTransactionID": {
+                    "TransactionID": "123456764",
+                    "TimeStamp": "2023-08-23T09:48:55"
+                },
+                "SaleToAcquirerData": "eyJhcHBsaWNhdGlvbkluZm8iOnsiYWR5ZW5MaWJyYXJ5Ijp7Im5hbWUiOiJhZ....",
+                "TokenRequestedType": "Transaction"
+            },
+            "PaymentTransaction": {
+                "AmountsReq": {
+                    "Currency": "EUR",
+                    "RequestedAmount": 10
+                }
+            }
+        }
+    }
+}

data/spec/mocks/responses/TerminalCloudAPI/connected_terminals.json

@@ -0,0 +1,5 @@
+{
+    "uniqueTerminalIds": [
+        "V400m-1234123412"
+    ]
+}

data/spec/mocks/responses/TerminalCloudAPI/sync_payment.json

@@ -0,0 +1,18 @@
+{
+    "SaleToPOIResponse":{
+      "MessageHeader":{},
+      "PaymentResponse":{
+        "POIData":{
+          "POITransactionID":{
+            "TransactionID": "oLkO0012498220087000.KHQC5N7G84BLNK43"
+          }
+        },
+        "Response":{
+          "Result":"Success",
+          "AdditionalResponse":"...shopperEmail=shoppersemail%40address.com..."
+        }
+      },
+      "PaymentReceipt":{}
+    }
+  }
+  

data/spec/terminal_cloud_api_spec.rb

@@ -0,0 +1,91 @@
+require 'spec_helper'
+require 'json'
+
+RSpec.describe Adyen::TerminalCloudAPI, service: 'TerminalCloudAPI' do
+  before(:all) do
+    @shared_values = {
+      client: create_client(:api_key),
+      service: 'TerminalCloudAPI'
+    }
+  end
+  
+  it 'makes a connectedTerminals POST call' do
+    request_body = JSON.parse(json_from_file('mocks/requests/TerminalCloudAPI/connected_terminals.json'))
+
+    response_body = json_from_file('mocks/responses/TerminalCloudAPI/connected_terminals.json')
+
+    url = @shared_values[:client].service_url(@shared_values[:service], 'connectedTerminals', nil)
+    WebMock.stub_request(:post, url)
+           .with(
+             headers: {
+               'x-api-key' => @shared_values[:client].api_key
+             }
+           )
+           .to_return(
+             body: response_body
+           )
+
+    result = @shared_values[:client].terminal_cloud_api.connected_terminals(request_body)
+    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 sync payment POST call' do
+    request_body = JSON.parse(json_from_file('mocks/requests/TerminalCloudAPI/sync_payment.json'))
+
+    response_body = json_from_file('mocks/responses/TerminalCloudAPI/sync_payment.json')
+
+    url = @shared_values[:client].service_url(@shared_values[:service], 'sync', nil)
+    WebMock.stub_request(:post, url)
+           .with(
+             headers: {
+               'x-api-key' => @shared_values[:client].api_key
+             }
+           )
+           .to_return(
+             body: response_body
+           )
+
+    result = @shared_values[:client].terminal_cloud_api.sync(request_body)
+    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 an async payment POST call' do
+    request_body = JSON.parse(json_from_file('mocks/requests/TerminalCloudAPI/sync_payment.json'))
+
+    url = @shared_values[:client].service_url(@shared_values[:service], 'async', nil)
+    WebMock.stub_request(:post, url)
+           .with(
+             headers: {
+               'x-api-key' => @shared_values[:client].api_key
+             }
+           )
+           .to_return(
+             body: 'ok'
+           )
+
+    result = @shared_values[:client].terminal_cloud_api.async(request_body)
+    response_hash = result.response
+
+    expect(result.status)
+      .to eq(200)
+  end
+end
+# rubocop:enable Metrics/BlockLength

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: adyen-ruby-api-library
 version: !ruby/object:Gem::Version
-  version: 7.0.3
+  version: 7.1.0
 platform: ruby
 authors:
 - Adyen
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-08-23 00:00:00.000000000 Z
+date: 2023-08-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -126,6 +126,7 @@ files:
 - lib/adyen/services/balancePlatform/bank_account_validation_api.rb
 - lib/adyen/services/balancePlatform/grant_accounts_api.rb
 - lib/adyen/services/balancePlatform/grant_offers_api.rb
+- lib/adyen/services/balancePlatform/network_tokens_api.rb
 - lib/adyen/services/balancePlatform/payment_instrument_groups_api.rb
 - lib/adyen/services/balancePlatform/payment_instruments_api.rb
 - lib/adyen/services/balancePlatform/platform_api.rb
@@ -188,6 +189,7 @@ files:
 - lib/adyen/services/recurring.rb
 - lib/adyen/services/service.rb
 - lib/adyen/services/storedValue.rb
+- lib/adyen/services/terminalCloudAPI.rb
 - lib/adyen/services/transfers.rb
 - lib/adyen/services/transfers/capital_api.rb
 - lib/adyen/services/transfers/transactions_api.rb
@@ -298,6 +300,8 @@ files:
 - spec/mocks/requests/Terminal/assign_terminals.json
 - spec/mocks/requests/Terminal/find_terminal.json
 - spec/mocks/requests/Terminal/get_terminals_under_account.json
+- spec/mocks/requests/TerminalCloudAPI/connected_terminals.json
+- spec/mocks/requests/TerminalCloudAPI/sync_payment.json
 - spec/mocks/requests/Transfers/get_transactions.json
 - spec/mocks/requests/Transfers/make_transfer.json
 - spec/mocks/responses/Account/check_account_holder.json
@@ -394,6 +398,8 @@ files:
 - spec/mocks/responses/Terminal/assign_terminals.json
 - spec/mocks/responses/Terminal/find_terminal.json
 - spec/mocks/responses/Terminal/get_terminals_under_account.json
+- spec/mocks/responses/TerminalCloudAPI/connected_terminals.json
+- spec/mocks/responses/TerminalCloudAPI/sync_payment.json
 - spec/mocks/responses/Transfers/get_transactions.json
 - spec/mocks/responses/Transfers/make_transfer.json
 - spec/mocks/responses/Webhooks/backslash_webhook.json
@@ -408,6 +414,7 @@ files:
 - spec/service_spec.rb
 - spec/spec_helper.rb
 - spec/stored_value_spec.rb
+- spec/terminal_cloud_api_spec.rb
 - spec/transfers_spec.rb
 - spec/utils/hmac_validator_spec.rb
 - templates/api-single.mustache