adyen-apimatic-sdk 1.0.0

data/lib/adyen_ap_is/models/payment_completion_details1.rb

@@ -0,0 +1,278 @@
+# adyen_ap_is
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module AdyenApIs
+  # Use this collection to submit the details that were returned as a result of
+  # the `/payments` call.
+  class PaymentCompletionDetails1 < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # A payment session identifier returned by the card issuer.
+    # @return [String]
+    attr_accessor :md
+
+    # (3D) Payment Authentication Request data for the card issuer.
+    # @return [String]
+    attr_accessor :pa_req
+
+    # (3D) Payment Authentication Response data by the card issuer.
+    # @return [String]
+    attr_accessor :pa_res
+
+    # (3D) Payment Authentication Response data by the card issuer.
+    # @return [String]
+    attr_accessor :authorization_token
+
+    # PayPal-generated token for recurring payments.
+    # @return [String]
+    attr_accessor :billing_token
+
+    # The SMS verification code collected from the shopper.
+    # @return [String]
+    attr_accessor :cupsecureplus_smscode
+
+    # PayPal-generated third party access token.
+    # @return [String]
+    attr_accessor :facilitator_access_token
+
+    # A random number sent to the mobile phone number of the shopper to verify
+    # the payment.
+    # @return [String]
+    attr_accessor :one_time_passcode
+
+    # PayPal-assigned ID for the order.
+    # @return [String]
+    attr_accessor :order_id
+
+    # PayPal-assigned ID for the payer (shopper).
+    # @return [String]
+    attr_accessor :payer_id
+
+    # Payload appended to the `returnURL` as a result of the redirect.
+    # @return [String]
+    attr_accessor :payload
+
+    # PayPal-generated ID for the payment.
+    # @return [String]
+    attr_accessor :payment_id
+
+    # Value passed from the WeChat MiniProgram `wx.requestPayment` **complete**
+    # callback. Possible values: any value starting with `requestPayment:`.
+    # @return [String]
+    attr_accessor :payment_status
+
+    # The result of the redirect as appended to the `returnURL`.
+    # @return [String]
+    attr_accessor :redirect_result
+
+    # Value you received from the WeChat Pay SDK.
+    # @return [String]
+    attr_accessor :result_code
+
+    # The query string as appended to the `returnURL` when using direct issuer
+    # links .
+    # @return [String]
+    attr_accessor :return_url_query_string
+
+    # Base64-encoded string returned by the Component after the challenge flow.
+    # It contains the following parameters: `transStatus`, `authorisationToken`.
+    # @return [String]
+    attr_accessor :three_ds_result
+
+    # Base64-encoded string returned by the Component after the challenge flow.
+    # It contains the following parameter: `transStatus`.
+    # @return [String]
+    attr_accessor :threeds2_challenge_result
+
+    # Base64-encoded string returned by the Component after the challenge flow.
+    # It contains the following parameter: `threeDSCompInd`.
+    # @return [String]
+    attr_accessor :threeds2_fingerprint
+
+    # PayPalv2-generated token for recurring payments.
+    # @return [String]
+    attr_accessor :vault_token
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['md'] = 'MD'
+      @_hash['pa_req'] = 'PaReq'
+      @_hash['pa_res'] = 'PaRes'
+      @_hash['authorization_token'] = 'authorization_token'
+      @_hash['billing_token'] = 'billingToken'
+      @_hash['cupsecureplus_smscode'] = 'cupsecureplus.smscode'
+      @_hash['facilitator_access_token'] = 'facilitatorAccessToken'
+      @_hash['one_time_passcode'] = 'oneTimePasscode'
+      @_hash['order_id'] = 'orderID'
+      @_hash['payer_id'] = 'payerID'
+      @_hash['payload'] = 'payload'
+      @_hash['payment_id'] = 'paymentID'
+      @_hash['payment_status'] = 'paymentStatus'
+      @_hash['redirect_result'] = 'redirectResult'
+      @_hash['result_code'] = 'resultCode'
+      @_hash['return_url_query_string'] = 'returnUrlQueryString'
+      @_hash['three_ds_result'] = 'threeDSResult'
+      @_hash['threeds2_challenge_result'] = 'threeds2.challengeResult'
+      @_hash['threeds2_fingerprint'] = 'threeds2.fingerprint'
+      @_hash['vault_token'] = 'vaultToken'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        md
+        pa_req
+        pa_res
+        authorization_token
+        billing_token
+        cupsecureplus_smscode
+        facilitator_access_token
+        one_time_passcode
+        order_id
+        payer_id
+        payload
+        payment_id
+        payment_status
+        redirect_result
+        result_code
+        return_url_query_string
+        three_ds_result
+        threeds2_challenge_result
+        threeds2_fingerprint
+        vault_token
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(md: SKIP, pa_req: SKIP, pa_res: SKIP,
+                   authorization_token: SKIP, billing_token: SKIP,
+                   cupsecureplus_smscode: SKIP, facilitator_access_token: SKIP,
+                   one_time_passcode: SKIP, order_id: SKIP, payer_id: SKIP,
+                   payload: SKIP, payment_id: SKIP, payment_status: SKIP,
+                   redirect_result: SKIP, result_code: SKIP,
+                   return_url_query_string: SKIP, three_ds_result: SKIP,
+                   threeds2_challenge_result: SKIP, threeds2_fingerprint: SKIP,
+                   vault_token: SKIP)
+      @md = md unless md == SKIP
+      @pa_req = pa_req unless pa_req == SKIP
+      @pa_res = pa_res unless pa_res == SKIP
+      @authorization_token = authorization_token unless authorization_token == SKIP
+      @billing_token = billing_token unless billing_token == SKIP
+      @cupsecureplus_smscode = cupsecureplus_smscode unless cupsecureplus_smscode == SKIP
+      @facilitator_access_token = facilitator_access_token unless facilitator_access_token == SKIP
+      @one_time_passcode = one_time_passcode unless one_time_passcode == SKIP
+      @order_id = order_id unless order_id == SKIP
+      @payer_id = payer_id unless payer_id == SKIP
+      @payload = payload unless payload == SKIP
+      @payment_id = payment_id unless payment_id == SKIP
+      @payment_status = payment_status unless payment_status == SKIP
+      @redirect_result = redirect_result unless redirect_result == SKIP
+      @result_code = result_code unless result_code == SKIP
+      @return_url_query_string = return_url_query_string unless return_url_query_string == SKIP
+      @three_ds_result = three_ds_result unless three_ds_result == SKIP
+      unless threeds2_challenge_result == SKIP
+        @threeds2_challenge_result =
+          threeds2_challenge_result
+      end
+      @threeds2_fingerprint = threeds2_fingerprint unless threeds2_fingerprint == SKIP
+      @vault_token = vault_token unless vault_token == SKIP
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      md = hash.key?('MD') ? hash['MD'] : SKIP
+      pa_req = hash.key?('PaReq') ? hash['PaReq'] : SKIP
+      pa_res = hash.key?('PaRes') ? hash['PaRes'] : SKIP
+      authorization_token =
+        hash.key?('authorization_token') ? hash['authorization_token'] : SKIP
+      billing_token = hash.key?('billingToken') ? hash['billingToken'] : SKIP
+      cupsecureplus_smscode =
+        hash.key?('cupsecureplus.smscode') ? hash['cupsecureplus.smscode'] : SKIP
+      facilitator_access_token =
+        hash.key?('facilitatorAccessToken') ? hash['facilitatorAccessToken'] : SKIP
+      one_time_passcode =
+        hash.key?('oneTimePasscode') ? hash['oneTimePasscode'] : SKIP
+      order_id = hash.key?('orderID') ? hash['orderID'] : SKIP
+      payer_id = hash.key?('payerID') ? hash['payerID'] : SKIP
+      payload = hash.key?('payload') ? hash['payload'] : SKIP
+      payment_id = hash.key?('paymentID') ? hash['paymentID'] : SKIP
+      payment_status = hash.key?('paymentStatus') ? hash['paymentStatus'] : SKIP
+      redirect_result =
+        hash.key?('redirectResult') ? hash['redirectResult'] : SKIP
+      result_code = hash.key?('resultCode') ? hash['resultCode'] : SKIP
+      return_url_query_string =
+        hash.key?('returnUrlQueryString') ? hash['returnUrlQueryString'] : SKIP
+      three_ds_result =
+        hash.key?('threeDSResult') ? hash['threeDSResult'] : SKIP
+      threeds2_challenge_result =
+        hash.key?('threeds2.challengeResult') ? hash['threeds2.challengeResult'] : SKIP
+      threeds2_fingerprint =
+        hash.key?('threeds2.fingerprint') ? hash['threeds2.fingerprint'] : SKIP
+      vault_token = hash.key?('vaultToken') ? hash['vaultToken'] : SKIP
+
+      # Create object from extracted values.
+      PaymentCompletionDetails1.new(md: md,
+                                    pa_req: pa_req,
+                                    pa_res: pa_res,
+                                    authorization_token: authorization_token,
+                                    billing_token: billing_token,
+                                    cupsecureplus_smscode: cupsecureplus_smscode,
+                                    facilitator_access_token: facilitator_access_token,
+                                    one_time_passcode: one_time_passcode,
+                                    order_id: order_id,
+                                    payer_id: payer_id,
+                                    payload: payload,
+                                    payment_id: payment_id,
+                                    payment_status: payment_status,
+                                    redirect_result: redirect_result,
+                                    result_code: result_code,
+                                    return_url_query_string: return_url_query_string,
+                                    three_ds_result: three_ds_result,
+                                    threeds2_challenge_result: threeds2_challenge_result,
+                                    threeds2_fingerprint: threeds2_fingerprint,
+                                    vault_token: vault_token)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} md: #{@md}, pa_req: #{@pa_req}, pa_res: #{@pa_res}, authorization_token:"\
+      " #{@authorization_token}, billing_token: #{@billing_token}, cupsecureplus_smscode:"\
+      " #{@cupsecureplus_smscode}, facilitator_access_token: #{@facilitator_access_token},"\
+      " one_time_passcode: #{@one_time_passcode}, order_id: #{@order_id}, payer_id: #{@payer_id},"\
+      " payload: #{@payload}, payment_id: #{@payment_id}, payment_status: #{@payment_status},"\
+      " redirect_result: #{@redirect_result}, result_code: #{@result_code},"\
+      " return_url_query_string: #{@return_url_query_string}, three_ds_result:"\
+      " #{@three_ds_result}, threeds2_challenge_result: #{@threeds2_challenge_result},"\
+      " threeds2_fingerprint: #{@threeds2_fingerprint}, vault_token: #{@vault_token}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} md: #{@md.inspect}, pa_req: #{@pa_req.inspect}, pa_res: #{@pa_res.inspect},"\
+      " authorization_token: #{@authorization_token.inspect}, billing_token:"\
+      " #{@billing_token.inspect}, cupsecureplus_smscode: #{@cupsecureplus_smscode.inspect},"\
+      " facilitator_access_token: #{@facilitator_access_token.inspect}, one_time_passcode:"\
+      " #{@one_time_passcode.inspect}, order_id: #{@order_id.inspect}, payer_id:"\
+      " #{@payer_id.inspect}, payload: #{@payload.inspect}, payment_id: #{@payment_id.inspect},"\
+      " payment_status: #{@payment_status.inspect}, redirect_result: #{@redirect_result.inspect},"\
+      " result_code: #{@result_code.inspect}, return_url_query_string:"\
+      " #{@return_url_query_string.inspect}, three_ds_result: #{@three_ds_result.inspect},"\
+      " threeds2_challenge_result: #{@threeds2_challenge_result.inspect}, threeds2_fingerprint:"\
+      " #{@threeds2_fingerprint.inspect}, vault_token: #{@vault_token.inspect}>"
+    end
+  end
+end

data/lib/adyen_ap_is/models/payment_details.rb

@@ -0,0 +1,94 @@
+# adyen_ap_is
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module AdyenApIs
+  # PaymentDetails Model.
+  class PaymentDetails < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The checkout attempt identifier.
+    # @return [String]
+    attr_accessor :checkout_attempt_id
+
+    # Base64-encoded JSON object containing SDK related parameters required by
+    # the SDK
+    # @return [String]
+    attr_accessor :sdk_data
+
+    # The payment method type.
+    # @return [Type38]
+    attr_accessor :type
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['checkout_attempt_id'] = 'checkoutAttemptId'
+      @_hash['sdk_data'] = 'sdkData'
+      @_hash['type'] = 'type'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        checkout_attempt_id
+        sdk_data
+        type
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(checkout_attempt_id: SKIP, sdk_data: SKIP, type: SKIP)
+      @checkout_attempt_id = checkout_attempt_id unless checkout_attempt_id == SKIP
+      @sdk_data = sdk_data unless sdk_data == SKIP
+      @type = type unless type == SKIP
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      checkout_attempt_id =
+        hash.key?('checkoutAttemptId') ? hash['checkoutAttemptId'] : SKIP
+      sdk_data = hash.key?('sdkData') ? hash['sdkData'] : SKIP
+      type = hash.key?('type') ? hash['type'] : SKIP
+
+      # Create object from extracted values.
+      PaymentDetails.new(checkout_attempt_id: checkout_attempt_id,
+                         sdk_data: sdk_data,
+                         type: type)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [PaymentDetails | Hash] The value against the validation is performed.
+    def self.validate(value)
+      return true if value.instance_of? self
+
+      return false unless value.instance_of? Hash
+
+      true
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} checkout_attempt_id: #{@checkout_attempt_id}, sdk_data: #{@sdk_data}, type:"\
+      " #{@type}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} checkout_attempt_id: #{@checkout_attempt_id.inspect}, sdk_data:"\
+      " #{@sdk_data.inspect}, type: #{@type.inspect}>"
+    end
+  end
+end

data/lib/adyen_ap_is/models/payment_details_request.rb

@@ -0,0 +1,108 @@
+# adyen_ap_is
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module AdyenApIs
+  # PaymentDetailsRequest Model.
+  class PaymentDetailsRequest < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Data for 3DS authentication.
+    # @return [DetailsRequestAuthenticationData1]
+    attr_accessor :authentication_data
+
+    # Use this collection to submit the details that were returned as a result
+    # of the `/payments` call.
+    # @return [PaymentCompletionDetails1]
+    attr_accessor :details
+
+    # Encoded payment data. For [authorizing a payment after using 3D Secure 2
+    # Authentication-only](https://docs.adyen.com/online-payments/3d-secure/othe
+    # r-3ds-flows/authentication-only/#authorise-the-payment-with-adyen):
+    # If you received `resultCode`: **AuthenticationNotRequired** in the
+    # `/payments` response, use the `threeDSPaymentData` from the same response.
+    # If you received `resultCode`: **AuthenticationFinished** in the
+    # `/payments` response, use the `action.paymentData` from the same response.
+    # @return [String]
+    attr_accessor :payment_data
+
+    # Change the `authenticationOnly` indicator originally set in the
+    # `/payments` request. Only needs to be set if you want to modify the value
+    # set previously.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :three_ds_authentication_only
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['authentication_data'] = 'authenticationData'
+      @_hash['details'] = 'details'
+      @_hash['payment_data'] = 'paymentData'
+      @_hash['three_ds_authentication_only'] = 'threeDSAuthenticationOnly'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        authentication_data
+        payment_data
+        three_ds_authentication_only
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(details:, authentication_data: SKIP, payment_data: SKIP,
+                   three_ds_authentication_only: SKIP)
+      @authentication_data = authentication_data unless authentication_data == SKIP
+      @details = details
+      @payment_data = payment_data unless payment_data == SKIP
+      unless three_ds_authentication_only == SKIP
+        @three_ds_authentication_only =
+          three_ds_authentication_only
+      end
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      details = PaymentCompletionDetails1.from_hash(hash['details']) if hash['details']
+      if hash['authenticationData']
+        authentication_data = DetailsRequestAuthenticationData1.from_hash(hash['authenticationData'])
+      end
+      payment_data = hash.key?('paymentData') ? hash['paymentData'] : SKIP
+      three_ds_authentication_only =
+        hash.key?('threeDSAuthenticationOnly') ? hash['threeDSAuthenticationOnly'] : SKIP
+
+      # Create object from extracted values.
+      PaymentDetailsRequest.new(details: details,
+                                authentication_data: authentication_data,
+                                payment_data: payment_data,
+                                three_ds_authentication_only: three_ds_authentication_only)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} authentication_data: #{@authentication_data}, details: #{@details},"\
+      " payment_data: #{@payment_data}, three_ds_authentication_only:"\
+      " #{@three_ds_authentication_only}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} authentication_data: #{@authentication_data.inspect}, details:"\
+      " #{@details.inspect}, payment_data: #{@payment_data.inspect}, three_ds_authentication_only:"\
+      " #{@three_ds_authentication_only.inspect}>"
+    end
+  end
+end