pcp-server-ruby-sdk 1.0.0 → 1.2.0

data/lib/PCP-server-Ruby-SDK/endpoints/checkout_api_client.rb

@@ -124,6 +124,30 @@ module PCPServerSDK
         make_api_call(url.to_s, request_init)
         nil
       end
+
+      # Complete a checkout
+      # @param merchant_id [String] The merchant identifier
+      # @param commerce_case_id [String] The commerce case identifier
+      # @param checkout_id [String] The checkout identifier
+      # @param payload [PCPServerSDK::Models::CompleteOrderRequest] The complete order request
+      # @return [PCPServerSDK::Models::CompletePaymentResponse] The complete payment response
+      def complete_checkout_request(merchant_id, commerce_case_id, checkout_id, payload)
+        raise TypeError, MERCHANT_ID_REQUIRED_ERROR if merchant_id.nil? || merchant_id.empty?
+        raise TypeError, COMMERCE_CASE_ID_REQUIRED_ERROR if commerce_case_id.nil? || commerce_case_id.empty?
+        raise TypeError, CHECKOUT_ID_REQUIRED_ERROR if checkout_id.nil? || checkout_id.empty?
+        raise TypeError, PAYLOAD_REQUIRED_ERROR if payload.nil?
+
+        url = URI.join(get_config.host, "/v1/#{merchant_id}/commerce-cases/#{commerce_case_id}/checkouts/#{checkout_id}/complete-order")
+
+        request_init = {
+          method: 'POST',
+          headers: { 'Content-Type' => 'application/json' },
+          body: JSON.generate(payload)
+        }
+
+        response = make_api_call(url.to_s, request_init)
+        deserialize_json(response, PCPServerSDK::Models::CompletePaymentResponse)
+      end
     end
   end
 end

data/lib/PCP-server-Ruby-SDK/endpoints/payment_execution_api_client.rb

@@ -130,6 +130,53 @@ module PCPServerSDK
         deserialize_json(response, PCPServerSDK::Models::CompletePaymentResponse)
       end
 
+      # Pause a payment
+      # @param merchant_id [String] The merchant identifier
+      # @param commerce_case_id [String] The commerce case identifier
+      # @param checkout_id [String] The checkout identifier
+      # @param payment_execution_id [String] The payment execution identifier
+      # @param payload [PCPServerSDK::Models::PausePaymentRequest] The pause payment request
+      # @return [PCPServerSDK::Models::PausePaymentResponse] The pause payment response
+      def pause_payment(merchant_id, commerce_case_id, checkout_id, payment_execution_id, payload)
+        validate_ids(merchant_id, commerce_case_id, checkout_id)
+        raise TypeError, PAYMENT_EXECUTION_ID_REQUIRED_ERROR if payment_execution_id.nil? || payment_execution_id.empty?
+
+        url = URI.join(get_config.host, "/v1/#{merchant_id}/commerce-cases/#{commerce_case_id}/checkouts/#{checkout_id}/payment-executions/#{payment_execution_id}/pause")
+
+        request_init = {
+          method: 'POST',
+          headers: { 'Content-Type' => 'application/json' },
+          body: JSON.generate(payload)
+        }
+
+        response = make_api_call(url.to_s, request_init)
+        deserialize_json(response, PCPServerSDK::Models::PausePaymentResponse)
+      end
+
+      # Refresh a payment
+      # @param merchant_id [String] The merchant identifier
+      # @param commerce_case_id [String] The commerce case identifier
+      # @param checkout_id [String] The checkout identifier
+      # @param payment_execution_id [String] The payment execution identifier
+      # @param payload [PCPServerSDK::Models::RefreshPaymentRequest] The refresh payment request
+      # @return [PCPServerSDK::Models::PaymentExecution] The refreshed payment execution
+      def refresh_payment(merchant_id, commerce_case_id, checkout_id, payment_execution_id, payload)
+        validate_ids(merchant_id, commerce_case_id, checkout_id)
+        raise TypeError, PAYMENT_EXECUTION_ID_REQUIRED_ERROR if payment_execution_id.nil? || payment_execution_id.empty?
+
+        url = URI.join(get_config.host, "/v1/#{merchant_id}/commerce-cases/#{commerce_case_id}/checkouts/#{checkout_id}/payment-executions/#{payment_execution_id}/refresh")
+
+        request_init = {
+          method: 'POST',
+          headers: { 'Content-Type' => 'application/json' },
+          body: JSON.generate(payload)
+        }
+
+        response = make_api_call(url.to_s, request_init)
+        deserialize_json(response, PCPServerSDK::Models::PaymentExecution)
+      end
+
+
     private
 
       def validate_ids(merchant_id, commerce_case_id, checkout_id)

data/lib/PCP-server-Ruby-SDK/endpoints/payment_information_api_client.rb

@@ -24,7 +24,7 @@ module PCPServerSDK
       def create_payment_information(merchant_id, commerce_case_id, checkout_id, payload)
         validate_ids(merchant_id, commerce_case_id, checkout_id)
 
-        url = URI.join(get_config.host, "/v1/#{merchant_id}/commerce-cases/#{commerce_case_id}/checkouts/#{checkout_id}/payment-informations")
+        url = URI.join(get_config.host, "/v1/#{merchant_id}/commerce-cases/#{commerce_case_id}/checkouts/#{checkout_id}/payment-information")
 
         request_init = {
           method: 'POST',
@@ -46,7 +46,7 @@ module PCPServerSDK
         validate_ids(merchant_id, commerce_case_id, checkout_id)
         raise TypeError, PAYMENT_INFORMATION_ID_REQUIRED_ERROR if payment_information_id.nil? || payment_information_id.empty?
 
-        url = URI.join(get_config.host, "/v1/#{merchant_id}/commerce-cases/#{commerce_case_id}/checkouts/#{checkout_id}/payment-informations/#{payment_information_id}")
+        url = URI.join(get_config.host, "/v1/#{merchant_id}/commerce-cases/#{commerce_case_id}/checkouts/#{checkout_id}/payment-information/#{payment_information_id}")
 
         request_init = {
           method: 'GET',
@@ -57,6 +57,31 @@ module PCPServerSDK
         deserialize_json(response, PCPServerSDK::Models::PaymentInformationResponse)
       end
 
+      # Refund a payment information
+      # @param merchant_id [String] The merchant identifier
+      # @param commerce_case_id [String] The commerce case identifier
+      # @param checkout_id [String] The checkout identifier
+      # @param payment_information_id [String] The payment information identifier
+      # @param payload [PCPServerSDK::Models::PaymentInformationRefundRequest] The refund request
+      # @return [PCPServerSDK::Models::PaymentInformationRefundResponse] The refund response
+      def refund_payment_information(merchant_id, commerce_case_id, checkout_id, payment_information_id, payload)
+        validate_ids(merchant_id, commerce_case_id, checkout_id)
+        raise TypeError, PAYMENT_INFORMATION_ID_REQUIRED_ERROR if payment_information_id.nil? || payment_information_id.empty?
+        raise TypeError, PAYLOAD_REQUIRED_ERROR if payload.nil?
+
+        url = URI.join(get_config.host, "/v1/#{merchant_id}/commerce-cases/#{commerce_case_id}/checkouts/#{checkout_id}/payment-information/#{payment_information_id}/refund")
+
+        request_init = {
+          method: 'POST',
+          headers: { 'Content-Type' => 'application/json' },
+          body: JSON.generate(payload)
+        }
+
+        response = make_api_call(url.to_s, request_init)
+        deserialize_json(response, PCPServerSDK::Models::PaymentInformationRefundResponse)
+      end
+
+
     private
 
       def validate_ids(merchant_id, commerce_case_id, checkout_id)

data/lib/PCP-server-Ruby-SDK/models/action_type.rb

@@ -0,0 +1,34 @@
+require 'date'
+require 'time'
+
+module PCPServerSDK
+  module Models
+    class ActionType
+      REDIRECT = "REDIRECT".freeze                           # The customer needs to be redirected using the details found in redirectData
+      SHOW_FORM = "SHOW_FORM".freeze                        # The customer needs to be shown a form with the fields found in formFields
+      SHOW_INSTRUCTIONS = "SHOW_INSTRUCTIONS".freeze         # The customer needs to be shown payment instruction using the details found in showData
+      SHOW_TRANSACTION_RESULTS = "SHOW_TRANSACTION_RESULTS".freeze  # The customer needs to be shown the transaction results using the details found in showData
+      MOBILE_THREEDS_CHALLENGE = "MOBILE_THREEDS_CHALLENGE".freeze  # The customer needs to complete a challenge as part of the 3D Secure authentication inside your mobile app
+      CALL_THIRD_PARTY = "CALL_THIRD_PARTY".freeze          # The merchant needs to call a third party using the data found in thirdPartyData
+
+      def self.all_vars
+        @all_vars ||= [REDIRECT, SHOW_FORM, SHOW_INSTRUCTIONS, SHOW_TRANSACTION_RESULTS, MOBILE_THREEDS_CHALLENGE, CALL_THIRD_PARTY].freeze
+      end
+
+      # Builds the enum from string
+      # @param [String] The enum value in the form of the string
+      # @return [String] The enum value
+      def self.build_from_hash(value)
+        new.build_from_hash(value)
+      end
+
+      # Builds the enum from string
+      # @param [String] The enum value in the form of the string
+      # @return [String] The enum value
+      def build_from_hash(value)
+        return value if ActionType.all_vars.include?(value)
+        raise "Invalid ENUM value #{value} for class #ActionType"
+      end
+    end
+  end
+end

data/lib/PCP-server-Ruby-SDK/models/api_error.rb

@@ -8,7 +8,7 @@ module PCPServerSDK
       # Error code
       attr_accessor :error_code
 
-      # Category the error belongs to. The category should give an indication of the type of error you are dealing with. Possible values: * DIRECT_PLATFORM_ERROR - indicating that a functional error has occurred in the platform. * PAYMENT_PLATFORM_ERROR - indicating that a functional error has occurred in the payment platform. * IO_ERROR - indicating that a technical error has occurred within the payment platform or between the payment platform and third party systems. * COMMERCE_PLATFORM_ERROR - indicating an error originating from the Commerce Platform. * COMMERCE_PORTAL_BACKEND_ERROR - indicating an error originating from the Commerce Portal Backend.
+      # Category the error belongs to. The category should give an indication of the type of error you are dealing with. Do not expect a finite set of possible categories, as they are subject to change. Common values are: * DIRECT_PLATFORM_ERROR - indicating that a functional error has occurred in the platform. * PAYMENT_PLATFORM_ERROR - indicating that a functional error has occurred in the payment platform. * IO_ERROR - indicating that a technical error has occurred within the payment platform or between the payment platform and third party systems. * COMMERCE_PLATFORM_ERROR - indicating an error originating from the Commerce Platform. * COMMERCE_PORTAL_BACKEND_ERROR - indicating an error originating from the Commerce Portal Backend.
       attr_accessor :category
 
       # HTTP status code for this error that can be used to determine the type of error

data/lib/PCP-server-Ruby-SDK/models/avs_result.rb

@@ -0,0 +1,52 @@
+require 'date'
+require 'time'
+
+module PCPServerSDK
+  module Models
+    class AvsResult
+      A = "A".freeze  # Address (Street) matches, Zip does not
+      B = "B".freeze  # Street address match for international transactions—Postal code not verified due to incompatible formats
+      C = "C".freeze  # Street address and postal code not verified for international transaction due to incompatible formats
+      D = "D".freeze  # Street address and postal code match for international transaction, cardholder name is incorrect
+      E = "E".freeze  # AVS error
+      F = "F".freeze  # Address does match and five digit ZIP code does match (UK only)
+      G = "G".freeze  # Address information is unavailable; international transaction; non-AVS participant
+      H = "H".freeze  # Billing address and postal code match, cardholder name is incorrect (Amex)
+      I = "I".freeze  # Address information not verified for international transaction
+      K = "K".freeze  # Cardholder name matches (Amex)
+      L = "L".freeze  # Cardholder name and postal code match (Amex)
+      M = "M".freeze  # Cardholder name, street address, and postal code match for international transaction
+      N = "N".freeze  # No Match on Address (Street) or Zip
+      O = "O".freeze  # Cardholder name and address match (Amex)
+      P = "P".freeze  # Postal codes match for international transaction—Street address not verified due to incompatible formats
+      Q = "Q".freeze  # Billing address matches, cardholder is incorrect (Amex)
+      R = "R".freeze  # Retry, System unavailable or Timed out
+      S = "S".freeze  # Service not supported by issuer
+      U = "U".freeze  # Address information is unavailable
+      W = "W".freeze  # 9 digit Zip matches, Address (Street) does not
+      X = "X".freeze  # Exact AVS Match
+      Y = "Y".freeze  # Address (Street) and 5 digit Zip match
+      Z = "Z".freeze  # 5 digit Zip matches, Address (Street) does not
+      ZERO = "0".freeze  # No service available
+
+      def self.all_vars
+        @all_vars ||= [A, B, C, D, E, F, G, H, I, K, L, M, N, O, P, Q, R, S, U, W, X, Y, Z, ZERO].freeze
+      end
+
+      # Builds the enum from string
+      # @param [String] The enum value in the form of the string
+      # @return [String] The enum value
+      def self.build_from_hash(value)
+        new.build_from_hash(value)
+      end
+
+      # Builds the enum from string
+      # @param [String] The enum value in the form of the string
+      # @return [String] The enum value
+      def build_from_hash(value)
+        return value if AvsResult.all_vars.include?(value)
+        raise "Invalid ENUM value #{value} for class #AvsResult"
+      end
+    end
+  end
+end

data/lib/PCP-server-Ruby-SDK/models/bank_account_information.rb

@@ -1,6 +1,6 @@
-
 require 'date'
 require 'time'
+
 module PCPServerSDK
   module Models
     # Object containing information about the end customer's bank account.
@@ -11,11 +11,15 @@ module PCPServerSDK
       # Account holder of the bank account with the given IBAN. Does not necessarily have to be the end customer (e.g. joint accounts).
       attr_accessor :account_holder
 
+      # BIC (Bank Identification Code)
+      attr_accessor :bic
+
       # Attribute mapping from ruby-style variable name to JSON key.
       def self.attribute_map
         {
           :'iban' => :'iban',
-          :'account_holder' => :'accountHolder'
+          :'account_holder' => :'accountHolder',
+          :'bic' => :'bic'
         }
       end
 
@@ -28,7 +32,8 @@ module PCPServerSDK
       def self.openapi_types
         {
           :'iban' => :'String',
-          :'account_holder' => :'String'
+          :'account_holder' => :'String',
+          :'bic' => :'String'
         }
       end
 
@@ -64,6 +69,12 @@ module PCPServerSDK
         else
           self.account_holder = nil
         end
+
+        if attributes.key?(:'bic')
+          self.bic = attributes[:'bic']
+        else
+          self.bic = nil
+        end
       end
 
       # Checks equality by comparing each attribute.
@@ -72,7 +83,8 @@ module PCPServerSDK
         return true if self.equal?(o)
         self.class == o.class &&
             iban == o.iban &&
-            account_holder == o.account_holder
+            account_holder == o.account_holder &&
+            bic == o.bic
       end
 
       # @see the `==` method
@@ -84,7 +96,7 @@ module PCPServerSDK
       # Calculates hash code according to all attributes.
       # @return [Integer] Hash code
       def hash
-        [iban, account_holder].hash
+        [iban, account_holder, bic].hash
       end
 
       # Builds the object from hash

data/lib/PCP-server-Ruby-SDK/models/bank_payout_method_specific_input.rb

@@ -0,0 +1,198 @@
+require 'date'
+require 'time'
+
+module PCPServerSDK
+  module Models
+    # Object containing the specific input details for SEPA transfers.
+    class BankPayoutMethodSpecificInput
+      # Payment product identifier - please check product documentation for a full overview of possible values.
+      attr_accessor :payment_product_id
+
+      # SEPA Transfer Payment Product 772 Specific Input
+      attr_accessor :payment_product772_specific_input
+
+      # Attribute mapping from ruby-style variable name to JSON key.
+      def self.attribute_map
+        {
+          :'payment_product_id' => :'paymentProductId',
+          :'payment_product772_specific_input' => :'paymentProduct772SpecificInput'
+        }
+      end
+
+      # Returns all the JSON keys this model knows about.
+      def self.acceptable_attributes
+        attribute_map.values
+      end
+
+      # Attribute type mapping.
+      def self.openapi_types
+        {
+          :'payment_product_id' => :'Integer',
+          :'payment_product772_specific_input' => :'SepaTransferPaymentProduct772SpecificInput'
+        }
+      end
+
+      # List of attributes with nullable: true.
+      def self.openapi_nullable
+        Set.new([])
+      end
+
+      # Initializes the object.
+      # @param [Hash] attributes Model attributes in the form of hash.
+      def initialize(attributes = {})
+        if (!attributes.is_a?(Hash))
+          fail ArgumentError, "The input argument (attributes) must be a hash in `BankPayoutMethodSpecificInput` initialize method"
+        end
+
+        # Check to see if the attribute exists and convert string to symbol for hash key.
+        attributes = attributes.each_with_object({}) { |(k, v), h|
+          if (!self.class.attribute_map.key?(k.to_sym))
+            fail ArgumentError, "`#{k}` is not a valid attribute in `BankPayoutMethodSpecificInput`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
+          end
+          h[k.to_sym] = v
+        }
+
+        if attributes.key?(:'payment_product_id')
+          self.payment_product_id = attributes[:'payment_product_id']
+        else
+          self.payment_product_id = nil
+        end
+
+        if attributes.key?(:'payment_product772_specific_input')
+          self.payment_product772_specific_input = attributes[:'payment_product772_specific_input']
+        else
+          self.payment_product772_specific_input = nil
+        end
+      end
+
+      # Checks equality by comparing each attribute.
+      # @param [Object] Object to be compared.
+      def ==(o)
+        return true if self.equal?(o)
+        self.class == o.class &&
+          payment_product_id == o.payment_product_id &&
+          payment_product772_specific_input == o.payment_product772_specific_input
+      end
+
+      # @see the `==` method.
+      # @param [Object] Object to be compared.
+      def eql?(o)
+        self == o
+      end
+
+      # Calculates hash code according to all attributes.
+      # @return [Integer] Hash code.
+      def hash
+        [payment_product_id, payment_product772_specific_input].hash
+      end
+
+      # Builds the object from hash.
+      # @param [Hash] attributes Model attributes in the form of hash.
+      # @return [Object] Returns the model itself.
+      def self.build_from_hash(attributes)
+        return nil unless attributes.is_a?(Hash)
+        attributes = attributes.transform_keys(&:to_sym)
+        transformed_hash = {}
+        openapi_types.each_pair do |key, type|
+          if attributes.key?(attribute_map[key]) && attributes[attribute_map[key]].nil?
+            transformed_hash["#{key}"] = nil
+          elsif type =~ /\AArray<(.*)>/i
+            if attributes[attribute_map[key]].is_a?(Array)
+              transformed_hash["#{key}"] = attributes[attribute_map[key]].map { |v| _deserialize($1, v) }
+            end
+          elsif !attributes[attribute_map[key]].nil?
+            transformed_hash["#{key}"] = _deserialize(type, attributes[attribute_map[key]])
+          end
+        end
+        new(transformed_hash)
+      end
+
+      # Deserializes the data based on type.
+      # @param string type Data type.
+      # @param string value Value to be deserialized.
+      # @return [Object] Deserialized data.
+      def self._deserialize(type, value)
+        case type.to_sym
+        when :Time
+          Time.parse(value)
+        when :Date
+          Date.parse(value)
+        when :String
+          value.to_s
+        when :Integer
+          value.to_i
+        when :Float
+          value.to_f
+        when :Boolean
+          if value.to_s =~ /\A(true|t|yes|y|1)\z/i
+            true
+          else
+            false
+          end
+        when :Object
+          value
+        when /\AArray<(?<inner_type>.+)>\z/
+          inner_type = Regexp.last_match[:inner_type]
+          value.map { |v| _deserialize(inner_type, v) }
+        when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
+          k_type = Regexp.last_match[:k_type]
+          v_type = Regexp.last_match[:v_type]
+          {}.tap do |hash|
+            value.each do |k, v|
+              hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
+            end
+          end
+        else # model
+          klass = PCPServerSDK::Models.const_get(type)
+          klass.respond_to?(:openapi_any_of) || klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
+        end
+      end
+
+      # Returns the string representation of the object.
+      # @return [String] String presentation of the object.
+      def to_s
+        to_hash.to_s
+      end
+
+      # to_body is an alias to to_hash (backward compatibility).
+      # @return [Hash] Returns the object in the form of hash.
+      def to_body
+        to_hash
+      end
+
+      # Returns the object in the form of hash.
+      # @return [Hash] Returns the object in the form of hash.
+      def to_hash
+        hash = {}
+        self.class.attribute_map.each_pair do |attr, param|
+          value = self.send(attr)
+          if value.nil?
+            is_nullable = self.class.openapi_nullable.include?(attr)
+            next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
+          end
+
+          hash[param] = _to_hash(value)
+        end
+        hash
+      end
+
+      # Outputs non-array value in the form of hash.
+      # For object, use to_hash. Otherwise, just return the value.
+      # @param [Object] value Any valid value.
+      # @return [Hash] Returns the value in the form of hash.
+      def _to_hash(value)
+        if value.is_a?(Array)
+          value.compact.map { |v| _to_hash(v) }
+        elsif value.is_a?(Hash)
+          {}.tap do |hash|
+            value.each { |k, v| hash[k] = _to_hash(v) }
+          end
+        elsif value.respond_to? :to_hash
+          value.to_hash
+        else
+          value
+        end
+      end
+    end
+  end
+end

data/lib/PCP-server-Ruby-SDK/models/business_relation.rb

@@ -0,0 +1,30 @@
+require 'date'
+require 'time'
+
+module PCPServerSDK
+  module Models
+    class BusinessRelation
+      B2C = "B2C".freeze  # Indicates business to consumer
+      B2B = "B2B".freeze  # Indicates business to business
+
+      def self.all_vars
+        @all_vars ||= [B2C, B2B].freeze
+      end
+
+      # Builds the enum from string
+      # @param [String] The enum value in the form of the string
+      # @return [String] The enum value
+      def self.build_from_hash(value)
+        new.build_from_hash(value)
+      end
+
+      # Builds the enum from string
+      # @param [String] The enum value in the form of the string
+      # @return [String] The enum value
+      def build_from_hash(value)
+        return value if BusinessRelation.all_vars.include?(value)
+        raise "Invalid ENUM value #{value} for class #BusinessRelation"
+      end
+    end
+  end
+end