connect-sdk-ruby 1.33.0 → 1.34.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: dddcd06bb06ff14b1cb296b5aa57988a655bcf02f32e17956ffed6a600230b77
-  data.tar.gz: 0c6cce4fe93c28fd8fc01d4653d7e5588bfa1f6019fa7a47aae07d5d486e3934
+  metadata.gz: f90ebf9942717f2734929d062449e19c0f52faf864a2ebe5a0217de9344cff6c
+  data.tar.gz: e5f3b1ba31d47befc71fc2da226700e9580d9356e5b9734cdc9da331c7b02537
 SHA512:
-  metadata.gz: 93333fa3b6ce0fdca69b2fc8d43e4eede1410111aeb27e96e540d25f63ef48400881b2162bd9be700cdf6eeea734fa7eef20e6210f3d02079c15c2f2bfc8e88a
-  data.tar.gz: e3042ac20359ba6f508ae97a1e05eb572f5d5e50fdf74a4ceb538bd6c22045d4dd9d3a0e58857f9353af17d4650647810155e7a8fa9b9bb6903f9db454341525
+  metadata.gz: c4b5ec63b26fa654d92bd01d2c1ce58832af52493e2b626f4d9f313a5aad2cba97c59230db0ac4f78a4ff5cd9544031d2652a02a9cea455eec395f2876186022
+  data.tar.gz: 0f94785f73786e5baf709181b18b15a631a2a466218d5616afdcd234692a47f481142fd690fec27b27b612c949d8cad8d1c57609e196b99a0e2ffc64bc7cbb7b

data/connect-sdk-ruby.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |spec|
   spec.name           = 'connect-sdk-ruby'
-  spec.version        = '1.33.0'
+  spec.version        = '1.34.0'
   spec.authors        = ['Ingenico ePayments']
   spec.email          = ['github@epay.ingenico.com']
   spec.summary        = %q{SDK to communicate with the Ingenico ePayments platform using the Ingenico Connect Server API}

data/examples/merchant/payments/create_payment_example.rb

@@ -14,6 +14,8 @@ require 'ingenico/connect/sdk/domain/payment/card_payment_method_specific_input'
 require 'ingenico/connect/sdk/domain/payment/contact_details'
 require 'ingenico/connect/sdk/domain/payment/create_payment_request'
 require 'ingenico/connect/sdk/domain/payment/customer'
+require 'ingenico/connect/sdk/domain/payment/device_render_options'
+require 'ingenico/connect/sdk/domain/payment/external_cardholder_authentication_data'
 require 'ingenico/connect/sdk/domain/payment/line_item'
 require 'ingenico/connect/sdk/domain/payment/line_item_invoice_data'
 require 'ingenico/connect/sdk/domain/payment/order'
@@ -21,7 +23,11 @@ require 'ingenico/connect/sdk/domain/payment/order_invoice_data'
 require 'ingenico/connect/sdk/domain/payment/order_references'
 require 'ingenico/connect/sdk/domain/payment/personal_information'
 require 'ingenico/connect/sdk/domain/payment/personal_name'
+require 'ingenico/connect/sdk/domain/payment/sdk_data_input'
+require 'ingenico/connect/sdk/domain/payment/shipping'
 require 'ingenico/connect/sdk/domain/payment/shopping_cart'
+require 'ingenico/connect/sdk/domain/payment/three_d_secure'
+require 'ingenico/connect/sdk/domain/payment/three_d_secure_data'
 
 Definitions = Ingenico::Connect::SDK::Domain::Definitions
 Payment = Ingenico::Connect::SDK::Domain::Payment
@@ -34,10 +40,47 @@ def example
     card.cvv = '123'
     card.expiry_date = '1220'
 
+    external_cardholder_authentication_data = Payment::ExternalCardholderAuthenticationData.new
+    external_cardholder_authentication_data.cavv = 'AgAAAAAABk4DWZ4C28yUQAAAAAA='
+    external_cardholder_authentication_data.cavv_algorithm = '1'
+    external_cardholder_authentication_data.eci = 8
+    external_cardholder_authentication_data.three_d_secure_version = 'v2'
+    external_cardholder_authentication_data.three_d_server_transaction_id = '3DSTID1234'
+    external_cardholder_authentication_data.validation_result = 'Y'
+    external_cardholder_authentication_data.xid = 'n3h2uOQPUgnmqhCkXNfxl8pOZJA='
+
+    prior_three_d_secure_data = Payment::ThreeDSecureData.new
+    prior_three_d_secure_data.acs_transaction_id = 'empty'
+    prior_three_d_secure_data.method = 'challenged'
+    prior_three_d_secure_data.utc_timestamp = '201901311530'
+
+    device_render_options = Payment::DeviceRenderOptions.new
+    device_render_options.sdk_interface = 'native'
+    device_render_options.sdk_ui_type = 'multi-select'
+
+    sdk_data = Payment::SdkDataInput.new
+    sdk_data.device_info = 'abc123'
+    sdk_data.device_render_options = device_render_options
+    sdk_data.sdk_app_id = 'xyz'
+    sdk_data.sdk_encrypted_data = 'abc123'
+    sdk_data.sdk_ephemeral_public_key = '123xyz'
+    sdk_data.sdk_max_timeout = '30'
+    sdk_data.sdk_reference_number = 'zaq123'
+    sdk_data.sdk_transaction_id = 'xsw321'
+
+    three_d_secure = Payment::ThreeDSecure.new
+    three_d_secure.authentication_flow = 'browser'
+    three_d_secure.challenge_canvas_size = '600x400'
+    three_d_secure.challenge_indicator = 'challenge-requested'
+    three_d_secure.external_cardholder_authentication_data = external_cardholder_authentication_data
+    three_d_secure.prior_three_d_secure_data = prior_three_d_secure_data
+    three_d_secure.sdk_data = sdk_data
+    three_d_secure.skip_authentication = false
+
     card_payment_method_specific_input = Payment::CardPaymentMethodSpecificInput.new
     card_payment_method_specific_input.card = card
     card_payment_method_specific_input.payment_product_id = 1
-    card_payment_method_specific_input.skip_authentication = false
+    card_payment_method_specific_input.three_d_secure = three_d_secure
 
     amount_of_money = Definitions::AmountOfMoney.new
     amount_of_money.amount = 2980
@@ -54,6 +97,7 @@ def example
 
     company_information = Definitions::CompanyInformation.new
     company_information.name = 'Acme Labs'
+    company_information.vat_number = '1234AB5678CD'
 
     contact_details = Payment::ContactDetails.new
     contact_details.email_address = 'wile.e.coyote@acmelabs.com'
@@ -72,21 +116,6 @@ def example
     personal_information.gender = 'male'
     personal_information.name = name
 
-    shipping_name = Payment::PersonalName.new
-    shipping_name.first_name = 'Road'
-    shipping_name.surname = 'Runner'
-    shipping_name.title = 'Miss'
-
-    shipping_address = Payment::AddressPersonal.new
-    shipping_address.additional_info = 'Suite II'
-    shipping_address.city = 'Monument Valley'
-    shipping_address.country_code = 'US'
-    shipping_address.house_number = '1'
-    shipping_address.name = shipping_name
-    shipping_address.state = 'Utah'
-    shipping_address.street = 'Desertroad'
-    shipping_address.zip = '84536'
-
     customer = Payment::Customer.new
     customer.billing_address = billing_address
     customer.company_information = company_information
@@ -94,8 +123,6 @@ def example
     customer.locale = 'en_US'
     customer.merchant_customer_id = '1234'
     customer.personal_information = personal_information
-    customer.shipping_address = shipping_address
-    customer.vat_number = '1234AB5678CD'
 
     invoice_data = Payment::OrderInvoiceData.new
     invoice_data.invoice_date = '20140306191500'
@@ -107,6 +134,24 @@ def example
     references.merchant_order_id = 123456
     references.merchant_reference = 'AcmeOrder0001'
 
+    shipping_name = Payment::PersonalName.new
+    shipping_name.first_name = 'Road'
+    shipping_name.surname = 'Runner'
+    shipping_name.title = 'Miss'
+
+    address = Payment::AddressPersonal.new
+    address.additional_info = 'Suite II'
+    address.city = 'Monument Valley'
+    address.country_code = 'US'
+    address.house_number = '1'
+    address.name = shipping_name
+    address.state = 'Utah'
+    address.street = 'Desertroad'
+    address.zip = '84536'
+
+    shipping = Payment::Shipping.new
+    shipping.address = address
+
     items = []
 
     item1_amount_of_money = Definitions::AmountOfMoney.new
@@ -146,6 +191,7 @@ def example
     order.amount_of_money = amount_of_money
     order.customer = customer
     order.references = references
+    order.shipping = shipping
     order.shopping_cart = shopping_cart
 
     body = Payment::CreatePaymentRequest.new

data/examples/merchant/riskassessments/risk_assessment_cards_example.rb

@@ -62,7 +62,6 @@ def example
     airline_data.flight_legs = flight_legs
     airline_data.invoice_number = '123456'
     airline_data.is_e_ticket = true
-    airline_data.is_registered_customer = true
     airline_data.is_restricted_ticket = true
     airline_data.is_third_party = true
     airline_data.issue_date = '20150101'
@@ -87,6 +86,7 @@ def example
     billing_address.country_code = 'US'
 
     customer = Riskassessments::CustomerRiskAssessment.new
+    customer.account_type = 'existing'
     customer.billing_address = billing_address
     customer.locale = 'en_US'
 

data/lib/ingenico/connect/sdk/domain/definitions/airline_data.rb

@@ -31,6 +31,8 @@ module Ingenico::Connect::SDK
         attr_accessor :is_e_ticket
 
         # true/false
+        #
+        # Deprecated; Use Order.customer.accountType instead
         attr_accessor :is_registered_customer
 
         # true/false

data/lib/ingenico/connect/sdk/domain/definitions/company_information.rb

@@ -13,9 +13,13 @@ module Ingenico::Connect::SDK
         # String
         attr_accessor :name
 
+        # String
+        attr_accessor :vat_number
+
         def to_h
           hash = super
           add_to_hash(hash, 'name', @name)
+          add_to_hash(hash, 'vatNumber', @vat_number)
           hash
         end
 
@@ -24,6 +28,9 @@ module Ingenico::Connect::SDK
           if hash.has_key?('name')
             @name = hash['name']
           end
+          if hash.has_key?('vatNumber')
+            @vat_number = hash['vatNumber']
+          end
         end
       end
     end

data/lib/ingenico/connect/sdk/domain/definitions/customer_base.rb

@@ -18,6 +18,8 @@ module Ingenico::Connect::SDK
         attr_accessor :merchant_customer_id
 
         # String
+        #
+        # Deprecated; Use companyInformation.vatNumber instead
         attr_accessor :vat_number
 
         def to_h

data/lib/ingenico/connect/sdk/domain/definitions/fraud_fields.rb

@@ -13,24 +13,34 @@ module Ingenico::Connect::SDK
       class FraudFields < Ingenico::Connect::SDK::DataObject
 
         # true/false
+        #
+        # Deprecated; For risk assessments there is no replacement. For other calls, use Order.shipping.addressIndicator instead
         attr_accessor :addresses_are_identical
 
         # String
         attr_accessor :black_list_data
 
         # {Ingenico::Connect::SDK::Domain::Definitions::Address}
+        #
+        # Deprecated; This should be the same as Order.customer.billingAddress
         attr_accessor :card_owner_address
 
         # String
         attr_accessor :customer_ip_address
 
         # String
+        #
+        # Deprecated; Use Order.customer.device.defaultFormFill instead
         attr_accessor :default_form_fill
 
         # true/false
+        #
+        # Deprecated; No replacement
         attr_accessor :device_fingerprint_activated
 
         # String
+        #
+        # Deprecated; Use Order.customer.device.deviceFingerprintTransactionId instead
         attr_accessor :device_fingerprint_transaction_id
 
         # String
@@ -40,30 +50,44 @@ module Ingenico::Connect::SDK
         attr_accessor :gift_message
 
         # true/false
+        #
+        # Deprecated; Use Order.customer.account.hasForgottenPassword instead
         attr_accessor :has_forgotten_pwd
 
         # true/false
+        #
+        # Deprecated; Use Order.customer.account.hasPassword instead
         attr_accessor :has_password
 
         # true/false
+        #
+        # Deprecated; Use Order.customer.isPreviousCustomer instead
         attr_accessor :is_previous_customer
 
         # String
         attr_accessor :order_timezone
 
         # String
+        #
+        # Deprecated; Use Order.shipping.comments instead
         attr_accessor :ship_comments
 
         # String
+        #
+        # Deprecated; Use Order.shipping.trackingNumber instead
         attr_accessor :shipment_tracking_number
 
         # {Ingenico::Connect::SDK::Domain::Definitions::FraudFieldsShippingDetails}
+        #
+        # Deprecated; No replacement
         attr_accessor :shipping_details
 
         # Array of String
         attr_accessor :user_data
 
         # String
+        #
+        # Deprecated; Use Merchant.websiteUrl instead
         attr_accessor :website
 
         def to_h

data/lib/ingenico/connect/sdk/domain/definitions/fraud_fields_shipping_details.rb

@@ -8,15 +8,22 @@ module Ingenico::Connect::SDK
   module Domain
     module Definitions
 
+      # Deprecated; No replacement
       class FraudFieldsShippingDetails < Ingenico::Connect::SDK::DataObject
 
         # String
+        #
+        # Deprecated; No replacement
         attr_accessor :method_details
 
         # Integer
+        #
+        # Deprecated; No replacement
         attr_accessor :method_speed
 
         # Integer
+        #
+        # Deprecated; No replacement
         attr_accessor :method_type
 
         def to_h

data/lib/ingenico/connect/sdk/domain/hostedcheckout/create_hosted_checkout_request.rb

@@ -10,6 +10,7 @@ require 'ingenico/connect/sdk/domain/payment/bank_transfer_payment_method_specif
 require 'ingenico/connect/sdk/domain/payment/card_payment_method_specific_input_base'
 require 'ingenico/connect/sdk/domain/payment/cash_payment_method_specific_input_base'
 require 'ingenico/connect/sdk/domain/payment/e_invoice_payment_method_specific_input_base'
+require 'ingenico/connect/sdk/domain/payment/merchant'
 require 'ingenico/connect/sdk/domain/payment/order'
 require 'ingenico/connect/sdk/domain/payment/redirect_payment_method_specific_input_base'
 require 'ingenico/connect/sdk/domain/payment/sepa_direct_debit_payment_method_specific_input_base'
@@ -38,6 +39,9 @@ module Ingenico::Connect::SDK
         # {Ingenico::Connect::SDK::Domain::Hostedcheckout::HostedCheckoutSpecificInput}
         attr_accessor :hosted_checkout_specific_input
 
+        # {Ingenico::Connect::SDK::Domain::Payment::Merchant}
+        attr_accessor :merchant
+
         # {Ingenico::Connect::SDK::Domain::Hostedcheckout::MobilePaymentMethodSpecificInputHostedCheckout}
         attr_accessor :mobile_payment_method_specific_input
 
@@ -58,6 +62,7 @@ module Ingenico::Connect::SDK
           add_to_hash(hash, 'eInvoicePaymentMethodSpecificInput', @e_invoice_payment_method_specific_input)
           add_to_hash(hash, 'fraudFields', @fraud_fields)
           add_to_hash(hash, 'hostedCheckoutSpecificInput', @hosted_checkout_specific_input)
+          add_to_hash(hash, 'merchant', @merchant)
           add_to_hash(hash, 'mobilePaymentMethodSpecificInput', @mobile_payment_method_specific_input)
           add_to_hash(hash, 'order', @order)
           add_to_hash(hash, 'redirectPaymentMethodSpecificInput', @redirect_payment_method_specific_input)
@@ -103,6 +108,12 @@ module Ingenico::Connect::SDK
             end
             @hosted_checkout_specific_input = Ingenico::Connect::SDK::Domain::Hostedcheckout::HostedCheckoutSpecificInput.new_from_hash(hash['hostedCheckoutSpecificInput'])
           end
+          if hash.has_key?('merchant')
+            if !(hash['merchant'].is_a? Hash)
+              raise TypeError, "value '%s' is not a Hash" % [hash['merchant']]
+            end
+            @merchant = Ingenico::Connect::SDK::Domain::Payment::Merchant.new_from_hash(hash['merchant'])
+          end
           if hash.has_key?('mobilePaymentMethodSpecificInput')
             if !(hash['mobilePaymentMethodSpecificInput'].is_a? Hash)
               raise TypeError, "value '%s' is not a Hash" % [hash['mobilePaymentMethodSpecificInput']]

data/lib/ingenico/connect/sdk/domain/hostedcheckout/created_payment_output.rb

@@ -24,7 +24,7 @@ module Ingenico::Connect::SDK
 
         # String
         #
-        # Deprecated; Use payment.statusOutput.statusCategory instead
+        # Deprecated; Use Payment.statusOutput.statusCategory instead
         attr_accessor :payment_status_category
 
         # true/false

data/lib/ingenico/connect/sdk/domain/payment/abstract_card_payment_method_specific_input.rb

@@ -3,6 +3,7 @@
 # https://epayments-api.developer-ingenico.com/s2sapi/v1/
 #
 require 'ingenico/connect/sdk/domain/definitions/abstract_payment_method_specific_input'
+require 'ingenico/connect/sdk/domain/payment/card_recurrence_details'
 
 module Ingenico::Connect::SDK
   module Domain
@@ -16,13 +17,20 @@ module Ingenico::Connect::SDK
         # String
         attr_accessor :customer_reference
 
+        # {Ingenico::Connect::SDK::Domain::Payment::CardRecurrenceDetails}
+        attr_accessor :recurring
+
         # String
+        #
+        # Deprecated; Use recurring.recurringPaymentSequenceIndicator instead
         attr_accessor :recurring_payment_sequence_indicator
 
         # true/false
         attr_accessor :requires_approval
 
         # true/false
+        #
+        # Deprecated; Use threeDSecure.skipAuthentication instead
         attr_accessor :skip_authentication
 
         # true/false
@@ -38,15 +46,21 @@ module Ingenico::Connect::SDK
         attr_accessor :transaction_channel
 
         # String
+        #
+        # Deprecated; Use unscheduledCardOnFileSequenceIndicator instead
         attr_accessor :unscheduled_card_on_file_indicator
 
         # String
         attr_accessor :unscheduled_card_on_file_requestor
 
+        # String
+        attr_accessor :unscheduled_card_on_file_sequence_indicator
+
         def to_h
           hash = super
           add_to_hash(hash, 'authorizationMode', @authorization_mode)
           add_to_hash(hash, 'customerReference', @customer_reference)
+          add_to_hash(hash, 'recurring', @recurring)
           add_to_hash(hash, 'recurringPaymentSequenceIndicator', @recurring_payment_sequence_indicator)
           add_to_hash(hash, 'requiresApproval', @requires_approval)
           add_to_hash(hash, 'skipAuthentication', @skip_authentication)
@@ -56,6 +70,7 @@ module Ingenico::Connect::SDK
           add_to_hash(hash, 'transactionChannel', @transaction_channel)
           add_to_hash(hash, 'unscheduledCardOnFileIndicator', @unscheduled_card_on_file_indicator)
           add_to_hash(hash, 'unscheduledCardOnFileRequestor', @unscheduled_card_on_file_requestor)
+          add_to_hash(hash, 'unscheduledCardOnFileSequenceIndicator', @unscheduled_card_on_file_sequence_indicator)
           hash
         end
 
@@ -67,6 +82,12 @@ module Ingenico::Connect::SDK
           if hash.has_key?('customerReference')
             @customer_reference = hash['customerReference']
           end
+          if hash.has_key?('recurring')
+            if !(hash['recurring'].is_a? Hash)
+              raise TypeError, "value '%s' is not a Hash" % [hash['recurring']]
+            end
+            @recurring = Ingenico::Connect::SDK::Domain::Payment::CardRecurrenceDetails.new_from_hash(hash['recurring'])
+          end
           if hash.has_key?('recurringPaymentSequenceIndicator')
             @recurring_payment_sequence_indicator = hash['recurringPaymentSequenceIndicator']
           end
@@ -94,6 +115,9 @@ module Ingenico::Connect::SDK
           if hash.has_key?('unscheduledCardOnFileRequestor')
             @unscheduled_card_on_file_requestor = hash['unscheduledCardOnFileRequestor']
           end
+          if hash.has_key?('unscheduledCardOnFileSequenceIndicator')
+            @unscheduled_card_on_file_sequence_indicator = hash['unscheduledCardOnFileSequenceIndicator']
+          end
         end
       end
     end