first_data_gateway 1.0.3 → 1.1.0

data/lib/simple/gateway.rb

@@ -11,11 +11,19 @@ module SimpleClient
 
 		def initialize(context)
 			@context = context
-			@authentication_api = SwaggerClient::AuthenticationApi.new(@context.client)
-			@order_api = SwaggerClient::OrderApi.new(@context.client)
-			@payment_api = SwaggerClient::PaymentApi.new(@context.client)
+			@authentication_api = OpenapiClient::AuthenticationApi.new(@context.client)
+			@card_info_api = OpenapiClient::CardInfoLookupApi.new(@context.client)
+			@card_verification_api = OpenapiClient::CardVerificationApi.new(@context.client)
+			@currency_conversion_api = OpenapiClient::CurrencyConversionApi.new(@context.client)
+			@fraud_detect_api = OpenapiClient::FraudDetectApi.new(@context.client)
+			@order_api = OpenapiClient::OrderApi.new(@context.client)
+			@payment_api = OpenapiClient::PaymentApi.new(@context.client)
+			@payment_schedules_api = OpenapiClient::PaymentSchedulesApi.new(@context.client)
+			@payment_token_api = OpenapiClient::PaymentTokenApi.new(@context.client)
+			@payment_url_api = OpenapiClient::PaymentURLApi.new(@context.client)
 		end
 
+		# Authentication API
 		def request_access_token
 			signature_service = get_signature_service
 			message_signature = signature_service.sign
@@ -24,117 +32,346 @@ module SimpleClient
 				signature_service.client_request_id, 
 				get_api_key, 
 				signature_service.timestamp, 
-				message_signature
+				{message_signature: message_signature}
 			)
 		end
 
-		def primary_payment_transaction(payload)
+		# Payment API
+		def primary_payment_transaction(payload:, region: nil)
+			opts = {}
+			opts[:region] = region if region
 			signature_service = get_signature_service
-			message_signature = signature_service.sign(payload)
+			opts[:message_signature] = signature_service.sign(payload)
 			return @payment_api.primary_payment_transaction(
 				CONTENT_TYPE, 
 				signature_service.client_request_id, 
 				get_api_key, 
 				signature_service.timestamp, 
-				message_signature,
-				payload
+				payload,
+				opts
 			)
 		end
 
-		def return_transaction(transaction_id, payload, store_id=nil)
-			opts = {store_id: store_id}
+		def perform_payment_authorization_by_transaction(transaction_id:, payload:, store_id: nil, region: nil)
+			opts = {}
+			opts[:store_id] = store_id if store_id
+			opts[:region] = region if region
 			signature_service = get_signature_service
-			message_signature = signature_service.sign(payload)
+			opts[:message_signature] = signature_service.sign(payload)
+			return @payment_api.perform_payment_post_authorisation(
+				CONTENT_TYPE, 
+				signature_service.client_request_id, 
+				get_api_key, 
+				signature_service.timestamp, 
+				transaction_id,
+				payload,
+				opts
+			)
+		end
+
+		def return_transaction(transaction_id:, payload:, store_id: nil, region: nil)
+			opts = {}
+			opts[:store_id] = store_id if store_id
+			opts[:region] = region if region
+			signature_service = get_signature_service
+			opts[:message_signature] = signature_service.sign(payload)
 			return @payment_api.return_transaction(
 				CONTENT_TYPE, 
 				signature_service.client_request_id, 
 				get_api_key, 
 				signature_service.timestamp, 
-				message_signature,
 				transaction_id,
 				payload,
 				opts
 			)
 		end
 
-		def transaction_inquiry(transaction_id, store_id=nil)
-			opts = {store_id: store_id}
+		def transaction_inquiry(transaction_id:, store_id: nil, region: nil)
+			opts = {}
+			opts[:store_id] = store_id if store_id
+			opts[:region] = region if region
 			signature_service = get_signature_service
-			message_signature = signature_service.sign
+			opts[:message_signature] = signature_service.sign
 			return @payment_api.transaction_inquiry(
 				CONTENT_TYPE, 
 				signature_service.client_request_id, 
 				get_api_key, 
 				signature_service.timestamp, 
-				message_signature,
 				transaction_id,
 				opts
 			)
 		end
 
-		def void_transaction(transaction_id, store_id=nil)
-			opts = {store_id: store_id}
+		def void_transaction(transaction_id:, store_id: nil, region: nil)
+			opts = {}
+			opts[:store_id] = store_id if store_id
+			opts[:region] = region if region
 			signature_service = get_signature_service
-			message_signature = signature_service.sign
+			opts[:message_signature] = signature_service.sign
 			return @payment_api.void_transaction(
 				CONTENT_TYPE, 
 				signature_service.client_request_id, 
 				get_api_key, 
 				signature_service.timestamp, 
-				message_signature,
 				transaction_id,
 				opts
 			)
 		end
 
-		def perform_payment_post_authorization_by_order(order_id, payload, store_id=nil)
-			opts = {store_id: store_id}
+		def update_transaction(transaction_id:, payload:, region: nil)
+			opts = {}
+			opts[:region] = region if region
 			signature_service = get_signature_service
-			message_signature = signature_service.sign(payload)
-			return @order_api.perform_payment_post_authorisation(
+			opts[:message_signature] = signature_service.sign(payload)
+			return @payment_api.finalize_secure_transaction(
 				CONTENT_TYPE, 
 				signature_service.client_request_id, 
 				get_api_key, 
 				signature_service.timestamp, 
-				message_signature, 
-				order_id,
+				transaction_id,
 				payload,
 				opts
+				)
+		end
+
+		# Order API
+		def order_inquiry(order_id:, store_id: nil, region: nil)
+			opts = {}
+			opts[:store_id] = store_id if store_id
+			opts[:region] = region if region
+			signature_service = get_signature_service
+			message_signature = signature_service.sign 
+			opts[:message_signature] = message_signature
+			return @order_api.order_inquiry(
+				CONTENT_TYPE, 
+				signature_service.client_request_id, 
+				get_api_key, 
+				signature_service.timestamp, 
+				order_id,
+				opts
 			)
 		end
 
-		def perform_payment_authorization_by_transaction(transaction_id, payload, store_id=nil)
-			opts = {store_id: store_id}
+		def perform_payment_post_authorization_by_order(order_id:, payload:, store_id: nil, region: nil)
+			opts = {}
+			opts[:store_id] = store_id if store_id
+			opts[:region] = region if region
 			signature_service = get_signature_service
-			message_signature = signature_service.sign(payload)
-			return @payment_api.perform_payment_post_authorisation(
+			opts[:message_signature] = signature_service.sign(payload)
+			return @order_api.order_post_auth(
 				CONTENT_TYPE, 
 				signature_service.client_request_id, 
 				get_api_key, 
 				signature_service.timestamp, 
-				message_signature,
-				transaction_id,
+				order_id,
 				payload,
 				opts
 			)
 		end
 
-		def return_transaction_by_order(order_id, payload, store_id=nil)
-			opts = {store_id: store_id}
+		def return_transaction_by_order(order_id:, payload:, store_id: nil, region: nil)
+			opts = {}
+			opts[:store_id] = store_id if store_id
+			opts[:region] = region if region
 			signature_service = get_signature_service
-			message_signature = signature_service.sign(payload)
-			return @order_api.return_transaction(
+			opts[:message_signature] = signature_service.sign(payload)
+			return @order_api.order_return_transaction(
 				CONTENT_TYPE, 
 				signature_service.client_request_id, 
 				get_api_key, 
 				signature_service.timestamp, 
-				message_signature,
 				order_id,
 				payload,
 				opts
 			)
 		end
 
+		# Card Verification API
+		def verify_card(payload:, region: nil)
+			opts = {}
+			opts[:region] = region if region
+			signature_service = get_signature_service
+			opts[:message_signature] = signature_service.sign(payload) 
+			return @card_verification_api.verify_card(
+				CONTENT_TYPE, 
+				signature_service.client_request_id, 
+				get_api_key, 
+				signature_service.timestamp, 
+				payload,
+				opts
+			)			
+		end
+
+		# Currency Conversaion API
+		def get_exchange_rate(payload:, region: nil)
+			opts = {}
+			opts[:region] = region if region
+			signature_service = get_signature_service
+			opts[:message_signature] = signature_service.sign(payload) 
+			return @currency_conversion_api.get_exchange_rate(
+				CONTENT_TYPE, 
+				signature_service.client_request_id, 
+				get_api_key, 
+				signature_service.timestamp, 
+				payload,
+				opts
+			)	
+		end
+
+		# Fraud Detect API
+		def get_transaction_fraud_score(payload:, region: nil)
+			opts = {}
+			opts[:region] = region if region
+			signature_service = get_signature_service
+			opts[:message_signature] = signature_service.sign(payload) 
+			return @fraud_detect_api.score_only(
+				CONTENT_TYPE, 
+				signature_service.client_request_id, 
+				get_api_key, 
+				signature_service.timestamp, 
+				payload,
+				opts
+			)	
+		end
+
+		# Payment Schedules API
+		def cancel_payment_schedule(order_id:, store_id: nil, region: nil)
+			opts = {}
+			opts[:store_id] = store_id if store_id
+			opts[:region] = region if region
+			signature_service = get_signature_service
+			opts[:message_signature] = signature_service.sign 
+			return @payment_schedules_api.cancel_payment_schedule(
+				CONTENT_TYPE,
+				signature_service.client_request_id,
+				get_api_key,
+				signature_service.timestamp,
+				order_id,
+				opts
+			)
+		end
+		
+		def create_payment_schedule(payload:, region: nil)
+			opts = {}
+			opts[:region] = region if region
+			signature_service = get_signature_service
+			opts[:message_signature] = signature_service.sign(payload) 
+			return @payment_schedules_api.create_payment_schedule(
+				CONTENT_TYPE, 
+				signature_service.client_request_id, 
+				get_api_key, 
+				signature_service.timestamp, 
+				payload,
+				opts
+			)	
+		end		
+
+		def payment_schedule_inquiry(order_id:, store_id: nil, region: nil)
+			opts = {}
+			opts[:store_id] = store_id if store_id
+			opts[:region] = region if region
+			signature_service = get_signature_service
+			opts[:message_signature] = signature_service.sign
+			return @payment_schedules_api.inquiry_payment_schedule(
+				CONTENT_TYPE, 
+				signature_service.client_request_id, 
+				get_api_key, 
+				signature_service.timestamp, 
+				order_id,
+				opts
+			)	
+		end		
+
+		def update_payment_schedule(payload:, order_id:, store_id: nil, region: nil)
+			opts = {}
+			opts[:store_id] = store_id if store_id
+			opts[:region] = region if region
+			signature_service = get_signature_service
+			opts[:message_signature] = signature_service.sign(payload)
+			return @payment_schedules_api.update_payment_schedule(
+				CONTENT_TYPE, 
+				signature_service.client_request_id, 
+				get_api_key, 
+				signature_service.timestamp, 
+				order_id,
+				payload,
+				opts
+			)	
+		end		
+		
+
+		# Payment Token API
+		def create_payment_token(payload:, authorization: nil, region: nil)
+			opts = {}
+			opts[:region] = region if region
+			opts[:authorization] = authorization if authorization
+			signature_service = get_signature_service
+			message_signature = signature_service.sign(payload)
+			opts [:message_signature] = message_signature
+			return @payment_token_api.create_payment_token(
+				CONTENT_TYPE, 
+				signature_service.client_request_id, 
+				get_api_key, 
+				signature_service.timestamp, 
+				payload,
+				opts
+			)	
+		end
+
+		def delete_payment_token(token_id:, authorization: nil, store_id: nil, region: nil)
+			opts = {}
+			opts[:region] = region if region
+			opts[:store_id] = store_id if store_id
+			opts[:authorization] = authorization if authorization
+			signature_service = get_signature_service
+			message_signature = signature_service.sign
+			opts [:message_signature] = message_signature
+			return @payment_token_api.delete_payment_token(
+				CONTENT_TYPE, 
+				signature_service.client_request_id, 
+				get_api_key, 
+				signature_service.timestamp, 
+				token_id,
+				opts
+			)	
+		end
+
+
+		# Payment URL API
+		def create_payment_url(payload:, region: nil)
+			opts = {}
+			opts[:region] = region if region
+			signature_service = get_signature_service
+			message_signature = signature_service.sign(payload)
+			opts[:message_signature] = message_signature
+			return @payment_url_api.create_payment_url(
+				CONTENT_TYPE, 
+				signature_service.client_request_id, 
+				get_api_key, 
+				signature_service.timestamp, 
+				payload,
+				opts
+			)	
+		end
+
+
+		# Card Info API
+		def card_info_lookup(payload:, region: nil)
+			opts = {}
+			opts[:region] = region if region
+			signature_service = get_signature_service
+			message_signature = signature_service.sign(payload)
+			opts[:message_signature] = message_signature
+			return @card_info_api.card_info_lookup(
+				CONTENT_TYPE, 
+				signature_service.client_request_id, 
+				get_api_key, 
+				signature_service.timestamp, 
+				payload,
+				opts
+			)	
+		end
+
 		private
 
 		def get_signature_service

data/spec/api/authentication_api_spec.rb

@@ -1,25 +1,25 @@
 =begin
-#Payment Gateway API Specification
+#Payment Gateway API Specification.
 
-#Payment Gateway API for payment processing. 
+#Payment Gateway API for payment processing. Version 6.4.0.20181018.001 
 
-OpenAPI spec version: 0.0.1
+OpenAPI spec version: 6.4.0.20181018.001
 
-Generated by: https://github.com/swagger-api/swagger-codegen.git
-Swagger Codegen version: unset
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: unset
 
 =end
 
 require 'spec_helper'
 require 'json'
 
-# Unit tests for SwaggerClient::AuthenticationApi
-# Automatically generated by swagger-codegen (github.com/swagger-api/swagger-codegen)
+# Unit tests for OpenapiClient::AuthenticationApi
+# Automatically generated by openapi-generator (https://openapi-generator.tech)
 # Please update as you see appropriate
 describe 'AuthenticationApi' do
   before do
     # run before each test
-    @instance = SwaggerClient::AuthenticationApi.new
+    @instance = OpenapiClient::AuthenticationApi.new
   end
 
   after do
@@ -28,13 +28,13 @@ describe 'AuthenticationApi' do
 
   describe 'test an instance of AuthenticationApi' do
     it 'should create an instance of AuthenticationApi' do
-      expect(@instance).to be_instance_of(SwaggerClient::AuthenticationApi)
+      expect(@instance).to be_instance_of(OpenapiClient::AuthenticationApi)
     end
   end
 
   # unit tests for v1_authentication_access_tokens_post
-  # Generate an access token for user authentication
-  # This is the access token generation call for authorizing subsequent financial transactions. A valid access token is required for web client requests. 
+  # Generate an access token for user authentication.
+  # This is the access token generation call for authorizing subsequent financial transactions. A valid access token is required for web client requests.
   # @param content_type content type
   # @param client_request_id A client-generated ID for request tracking and signature creation, unique per request.  This is also used for idempotency control. We recommend 128-bit UUID format.
   # @param api_key 
@@ -43,7 +43,7 @@ describe 'AuthenticationApi' do
   # @option opts [String] :message_signature Used to ensure the request has not been tampered with during transmission. The Message-Signature is the Base64 encoded HMAC hash (SHA256  algorithm with the API Secret as the key.) For more information, refer to the supporting documentation on the Developer Portal.
   # @return [AccessTokenResponse]
   describe 'v1_authentication_access_tokens_post test' do
-    it "should work" do
+    it 'should work' do
       # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
     end
   end

data/spec/api/card_info_lookup_api_spec.rb

@@ -0,0 +1,53 @@
+=begin
+#Payment Gateway API Specification.
+
+#Payment Gateway API for payment processing. Version 6.4.0.20181018.001 
+
+OpenAPI spec version: 6.4.0.20181018.001
+
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: unset
+
+=end
+
+require 'spec_helper'
+require 'json'
+
+# Unit tests for OpenapiClient::CardInfoLookupApi
+# Automatically generated by openapi-generator (https://openapi-generator.tech)
+# Please update as you see appropriate
+describe 'CardInfoLookupApi' do
+  before do
+    # run before each test
+    @instance = OpenapiClient::CardInfoLookupApi.new
+  end
+
+  after do
+    # run after each test
+  end
+
+  describe 'test an instance of CardInfoLookupApi' do
+    it 'should create an instance of CardInfoLookupApi' do
+      expect(@instance).to be_instance_of(OpenapiClient::CardInfoLookupApi)
+    end
+  end
+
+  # unit tests for card_info_lookup
+  # Card information lookUp
+  # Use this to look up card related information such as issuer country, card function and card brand.
+  # @param content_type content type
+  # @param client_request_id A client-generated ID for request tracking and signature creation, unique per request.  This is also used for idempotency control. We recommend 128-bit UUID format.
+  # @param api_key 
+  # @param timestamp Epoch timestamp in milliseconds in the request from a client system. Used for Message Signature generation and time limit (5 mins).
+  # @param card_info_lookup_request Card information lookup payload.
+  # @param [Hash] opts the optional parameters
+  # @option opts [String] :message_signature Used to ensure the request has not been tampered with during transmission. The Message-Signature is the Base64 encoded HMAC hash (SHA256  algorithm with the API Secret as the key.) For more information, refer to the supporting documentation on the Developer Portal.
+  # @option opts [String] :region The region where client wants to process the transaction
+  # @return [CardInfoLookupResponse]
+  describe 'card_info_lookup test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+end

data/spec/api/card_verification_api_spec.rb

@@ -0,0 +1,53 @@
+=begin
+#Payment Gateway API Specification.
+
+#Payment Gateway API for payment processing. Version 6.4.0.20181018.001 
+
+OpenAPI spec version: 6.4.0.20181018.001
+
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: unset
+
+=end
+
+require 'spec_helper'
+require 'json'
+
+# Unit tests for OpenapiClient::CardVerificationApi
+# Automatically generated by openapi-generator (https://openapi-generator.tech)
+# Please update as you see appropriate
+describe 'CardVerificationApi' do
+  before do
+    # run before each test
+    @instance = OpenapiClient::CardVerificationApi.new
+  end
+
+  after do
+    # run after each test
+  end
+
+  describe 'test an instance of CardVerificationApi' do
+    it 'should create an instance of CardVerificationApi' do
+      expect(@instance).to be_instance_of(OpenapiClient::CardVerificationApi)
+    end
+  end
+
+  # unit tests for verify_card
+  # Verify a payment card.
+  # Use this to perform card verification for a payment card.
+  # @param content_type content type
+  # @param client_request_id A client-generated ID for request tracking and signature creation, unique per request.  This is also used for idempotency control. We recommend 128-bit UUID format.
+  # @param api_key 
+  # @param timestamp Epoch timestamp in milliseconds in the request from a client system. Used for Message Signature generation and time limit (5 mins).
+  # @param card_verification_request 
+  # @param [Hash] opts the optional parameters
+  # @option opts [String] :message_signature Used to ensure the request has not been tampered with during transmission. The Message-Signature is the Base64 encoded HMAC hash (SHA256  algorithm with the API Secret as the key.) For more information, refer to the supporting documentation on the Developer Portal.
+  # @option opts [String] :region The region where client wants to process the transaction
+  # @return [TransactionResponse]
+  describe 'verify_card test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+end

data/spec/api/currency_conversion_api_spec.rb

@@ -0,0 +1,53 @@
+=begin
+#Payment Gateway API Specification.
+
+#Payment Gateway API for payment processing. Version 6.4.0.20181018.001 
+
+OpenAPI spec version: 6.4.0.20181018.001
+
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: unset
+
+=end
+
+require 'spec_helper'
+require 'json'
+
+# Unit tests for OpenapiClient::CurrencyConversionApi
+# Automatically generated by openapi-generator (https://openapi-generator.tech)
+# Please update as you see appropriate
+describe 'CurrencyConversionApi' do
+  before do
+    # run before each test
+    @instance = OpenapiClient::CurrencyConversionApi.new
+  end
+
+  after do
+    # run after each test
+  end
+
+  describe 'test an instance of CurrencyConversionApi' do
+    it 'should create an instance of CurrencyConversionApi' do
+      expect(@instance).to be_instance_of(OpenapiClient::CurrencyConversionApi)
+    end
+  end
+
+  # unit tests for get_exchange_rate
+  # Generate dynamic currency conversion transactions
+  # Sale, return and lookup exchange rate with dynamic currency conversion option
+  # @param content_type content type
+  # @param client_request_id A client-generated ID for request tracking and signature creation, unique per request.  This is also used for idempotency control. We recommend 128-bit UUID format.
+  # @param api_key 
+  # @param timestamp Epoch timestamp in milliseconds in the request from a client system. Used for Message Signature generation and time limit (5 mins).
+  # @param exchange_rate_request 
+  # @param [Hash] opts the optional parameters
+  # @option opts [String] :message_signature Used to ensure the request has not been tampered with during transmission. The Message-Signature is the Base64 encoded HMAC hash (SHA256  algorithm with the API Secret as the key.) For more information, refer to the supporting documentation on the Developer Portal.
+  # @option opts [String] :region The region where client wants to process the transaction
+  # @return [ExchangeRateResponse]
+  describe 'get_exchange_rate test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+end

data/spec/api/fraud_detect_api_spec.rb

@@ -0,0 +1,53 @@
+=begin
+#Payment Gateway API Specification.
+
+#Payment Gateway API for payment processing. Version 6.4.0.20181018.001 
+
+OpenAPI spec version: 6.4.0.20181018.001
+
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: unset
+
+=end
+
+require 'spec_helper'
+require 'json'
+
+# Unit tests for OpenapiClient::FraudDetectApi
+# Automatically generated by openapi-generator (https://openapi-generator.tech)
+# Please update as you see appropriate
+describe 'FraudDetectApi' do
+  before do
+    # run before each test
+    @instance = OpenapiClient::FraudDetectApi.new
+  end
+
+  after do
+    # run after each test
+  end
+
+  describe 'test an instance of FraudDetectApi' do
+    it 'should create an instance of FraudDetectApi' do
+      expect(@instance).to be_instance_of(OpenapiClient::FraudDetectApi)
+    end
+  end
+
+  # unit tests for score_only
+  # Score a transaction for fraud.
+  # Use this to obtain a fraud score for a transaction.
+  # @param content_type content type
+  # @param client_request_id A client-generated ID for request tracking and signature creation, unique per request.  This is also used for idempotency control. We recommend 128-bit UUID format.
+  # @param api_key 
+  # @param timestamp Epoch timestamp in milliseconds in the request from a client system. Used for Message Signature generation and time limit (5 mins).
+  # @param score_only_request 
+  # @param [Hash] opts the optional parameters
+  # @option opts [String] :message_signature Used to ensure the request has not been tampered with during transmission. The Message-Signature is the Base64 encoded HMAC hash (SHA256  algorithm with the API Secret as the key.) For more information, refer to the supporting documentation on the Developer Portal.
+  # @option opts [String] :region The region where client wants to process the transaction
+  # @return [ScoreOnlyResponse]
+  describe 'score_only test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+end