pcp-server-ruby-sdk 1.0.0 → 1.1.0

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

@@ -1,4 +1,3 @@
-
 require 'date'
 require 'time'
 
@@ -6,17 +5,18 @@ require 'time'
 module PCPServerSDK
   module Models
     class PayoutResponse
+      # Payout output details
       attr_accessor :payout_output
 
+      # Status of the payout
       attr_accessor :status
 
+      # Status category of the payout
       attr_accessor :status_category
 
       # Unique payment transaction identifier of the payment gateway.
       attr_accessor :id
 
-
-
       class EnumAttributeValidator
         attr_reader :datatype
         attr_reader :allowable_values
@@ -39,7 +39,7 @@ module PCPServerSDK
         end
       end
 
-      # Attribute mapping from ruby-style variable name to JSON key.
+      # Attribute mapping from Ruby-style variable name to JSON key.
       def self.attribute_map
         {
           :'payout_output' => :'payoutOutput',
@@ -66,8 +66,7 @@ module PCPServerSDK
 
       # List of attributes with nullable: true
       def self.openapi_nullable
-        Set.new([
-        ])
+        Set.new([])
       end
 
       # Initializes the object
@@ -77,7 +76,6 @@ module PCPServerSDK
           fail ArgumentError, "The input argument (attributes) must be a hash in `PayoutResponse` 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 `PayoutResponse`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
@@ -103,7 +101,6 @@ module PCPServerSDK
       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 &&
@@ -114,13 +111,11 @@ module PCPServerSDK
       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
         [payout_output, status, status_category, id].hash
       end
@@ -136,8 +131,6 @@ module PCPServerSDK
           if attributes.key?(attribute_map[key]) && attributes[attribute_map[key]].nil?
             transformed_hash["#{key}"] = nil
           elsif type =~ /\AArray<(.*)>/i
-            # check to ensure the input is an array given that the attribute
-            # is documented as an array but the input is not
             if attributes[attribute_map[key]].is_a?(Array)
               transformed_hash["#{key}"] = attributes[attribute_map[key]].map { |v| _deserialize($1, v) }
             end
@@ -149,9 +142,6 @@ module PCPServerSDK
       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
@@ -171,7 +161,6 @@ module PCPServerSDK
             false
           end
         when :Object
-          # generic object (usually a Hash), return directly
           value
         when /\AArray<(?<inner_type>.+)>\z/
           inner_type = Regexp.last_match[:inner_type]
@@ -184,27 +173,23 @@ module PCPServerSDK
               hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
             end
           end
-        else # model
-          # models (e.g. Pet) or oneOf
+        else
           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|
@@ -213,16 +198,12 @@ module PCPServerSDK
             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) }

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

@@ -0,0 +1,192 @@
+require 'date'
+require 'time'
+
+# Request to refresh the payment status of a specific payment.
+module PCPServerSDK
+  module Models
+    class RefreshPaymentRequest
+      # Type of refresh request
+      attr_accessor :refresh_type
+
+      class EnumAttributeValidator
+        attr_reader :datatype
+        attr_reader :allowable_values
+
+        def initialize(datatype, allowable_values)
+          @allowable_values = allowable_values.map do |value|
+            case datatype.to_s
+            when /Integer/i
+              value.to_i
+            when /Float/i
+              value.to_f
+            else
+              value
+            end
+          end
+        end
+
+        def valid?(value)
+          !value || allowable_values.include?(value)
+        end
+      end
+
+      # Attribute mapping from Ruby-style variable name to JSON key.
+      def self.attribute_map
+        {
+          :'refresh_type' => :'refreshType'
+        }
+      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
+        {
+          :'refresh_type' => :'RefreshType'
+        }
+      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 `RefreshPaymentRequest` initialize method"
+        end
+
+        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 `RefreshPaymentRequest`. 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?(:'refresh_type')
+          self.refresh_type = attributes[:'refresh_type']
+        end
+      end
+
+      # Checks equality by comparing each attribute.
+      def ==(o)
+        return true if self.equal?(o)
+        self.class == o.class &&
+            refresh_type == o.refresh_type
+      end
+
+      # @see the `==` method
+      def eql?(o)
+        self == o
+      end
+
+      # Calculates hash code according to all attributes.
+      def hash
+        [refresh_type].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
+      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
+          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
+      def to_s
+        to_hash.to_s
+      end
+
+      # to_body is an alias to to_hash (backward compatibility)
+      def to_body
+        to_hash
+      end
+
+      # 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
+      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/refresh_type.rb

@@ -0,0 +1,30 @@
+require 'date'
+require 'time'
+
+# The refreshType refers to the type of the payment status refresh.
+# - PAYMENT_EVENTS = Refresh the payment status of the payment and return the events.
+#   This is a synchronization of the payment status with the payment platform.
+#   This can be used in case of any possible inconsistencies between the commerce platform and the payment platform.
+# - PAYMENT_PROVIDER_DETAILS = Refresh the payment status of the payment and return the payment provider details.
+#   This is a synchronization of the payment with the external payment provider.
+#   The current use case is to update the customer status of a transaction using PAYONE Buy Now, Pay Later (BNPL) with the external provider Payla.
+module PCPServerSDK
+  module Models
+    class RefreshType
+      PAYMENT_EVENTS = "PAYMENT_EVENTS".freeze
+      PAYMENT_PROVIDER_DETAILS = "PAYMENT_PROVIDER_DETAILS".freeze
+
+      def self.all_vars
+        @all_vars ||= [PAYMENT_EVENTS, PAYMENT_PROVIDER_DETAILS].freeze
+      end
+
+      # Builds the enum from string
+      # @param [String] value The enum value in the form of the string
+      # @return [String] The enum value
+      def self.build_from_hash(value)
+        return value if RefreshType.all_vars.include?(value)
+        raise "Invalid ENUM value #{value} for class #StatusValue"
+      end
+    end
+  end
+end

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

@@ -0,0 +1,192 @@
+require 'date'
+require 'time'
+
+# Object containing the specific input details for SEPA credit transfers excluding cross-border ones
+module PCPServerSDK
+  module Models
+    class SepaTransferPaymentProduct772SpecificInput
+      # Bank account information
+      attr_accessor :bank_account_information
+
+      class EnumAttributeValidator
+        attr_reader :datatype
+        attr_reader :allowable_values
+
+        def initialize(datatype, allowable_values)
+          @allowable_values = allowable_values.map do |value|
+            case datatype.to_s
+            when /Integer/i
+              value.to_i
+            when /Float/i
+              value.to_f
+            else
+              value
+            end
+          end
+        end
+
+        def valid?(value)
+          !value || allowable_values.include?(value)
+        end
+      end
+
+      # Attribute mapping from Ruby-style variable name to JSON key.
+      def self.attribute_map
+        {
+          :'bank_account_information' => :'bankAccountInformation'
+        }
+      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
+        {
+          :'bank_account_information' => :'BankAccountInformation'
+        }
+      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 `SepaTransferPaymentProduct772SpecificInput` initialize method"
+        end
+
+        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 `SepaTransferPaymentProduct772SpecificInput`. 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?(:'bank_account_information')
+          self.bank_account_information = attributes[:'bank_account_information']
+        end
+      end
+
+      # Checks equality by comparing each attribute.
+      def ==(o)
+        return true if self.equal?(o)
+        self.class == o.class &&
+            bank_account_information == o.bank_account_information
+      end
+
+      # @see the `==` method
+      def eql?(o)
+        self == o
+      end
+
+      # Calculates hash code according to all attributes.
+      def hash
+        [bank_account_information].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
+      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
+          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
+      def to_s
+        to_hash.to_s
+      end
+
+      # to_body is an alias to to_hash (backward compatibility)
+      def to_body
+        to_hash
+      end
+
+      # 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
+      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/status_value.rb

@@ -1,7 +1,7 @@
-
 require 'date'
 require 'time'
 
+# Current high-level status of the payment in a human-readable form.
 module PCPServerSDK
   module Models
     class StatusValue
@@ -9,6 +9,8 @@ module PCPServerSDK
       CANCELLED = "CANCELLED".freeze
       REJECTED = "REJECTED".freeze
       REJECTED_CAPTURE = "REJECTED_CAPTURE".freeze
+      REJECTED_PAUSE = "REJECTED_PAUSE".freeze
+      REJECTED_UPDATE = "REJECTED_UPDATE".freeze
       REDIRECTED = "REDIRECTED".freeze
       PENDING_PAYMENT = "PENDING_PAYMENT".freeze
       PENDING_COMPLETION = "PENDING_COMPLETION".freeze
@@ -28,22 +30,22 @@ module PCPServerSDK
       ACCOUNT_DEBITED = "ACCOUNT_DEBITED".freeze
       PAYOUT_REQUESTED = "PAYOUT_REQUESTED".freeze
       REJECTED_CREDIT = "REJECTED_CREDIT".freeze
+      UPDATED = "UPDATED".freeze
 
       def self.all_vars
-        @all_vars ||= [CREATED, CANCELLED, REJECTED, REJECTED_CAPTURE, REDIRECTED, PENDING_PAYMENT, PENDING_COMPLETION, PENDING_CAPTURE, AUTHORIZATION_REQUESTED, CAPTURE_REQUESTED, CAPTURED, REVERSED, REFUND_REQUESTED, REFUNDED, REJECTED_REFUND, CANCELLATION_REQUESTED, PAUSED, CHARGEBACKED, CHARGEBACK_REVERSED, ACCOUNT_CREDITED, ACCOUNT_DEBITED, PAYOUT_REQUESTED, REJECTED_CREDIT].freeze
+        @all_vars ||= [
+          CREATED, CANCELLED, REJECTED, REJECTED_CAPTURE, REJECTED_PAUSE, REJECTED_UPDATE,
+          REDIRECTED, PENDING_PAYMENT, PENDING_COMPLETION, PENDING_CAPTURE, AUTHORIZATION_REQUESTED,
+          CAPTURE_REQUESTED, CAPTURED, REVERSED, REFUND_REQUESTED, REFUNDED, REJECTED_REFUND,
+          CANCELLATION_REQUESTED, PAUSED, CHARGEBACKED, CHARGEBACK_REVERSED, ACCOUNT_CREDITED,
+          ACCOUNT_DEBITED, PAYOUT_REQUESTED, REJECTED_CREDIT, UPDATED
+        ].freeze
       end
 
       # Builds the enum from string
-      # @param [String] The enum value in the form of the string
+      # @param [String] value 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 StatusValue.all_vars.include?(value)
         raise "Invalid ENUM value #{value} for class #StatusValue"
       end

data/lib/PCP-server-Ruby-SDK/queries/get_checkouts_query.rb

@@ -15,7 +15,7 @@ module PCPServerSDK
                     :include_payment_product_id, :include_checkout_status,
                     :include_extended_checkout_status, :include_payment_channel,
                     :payment_reference, :payment_id, :first_name, :surname,
-                    :email, :phone_number, :date_of_birth, :company_information
+                    :email, :phone_number, :date_of_birth, :company_information, :terminal_id, :reporting_token
     
       def initialize
         @include_payment_product_id = []
@@ -58,6 +58,8 @@ module PCPServerSDK
         query['phoneNumber'] = @phone_number if @phone_number
         query['dateOfBirth'] = @date_of_birth if @date_of_birth
         query['companyInformation'] = @company_information if @company_information
+        query['terminalId'] = @terminal_id if @terminal_id
+        query['reportingToken'] = @reporting_token if @reporting_token
     
         query
       end

data/lib/PCP-server-Ruby-SDK/transformer/apple_pay_transformer.rb

@@ -8,7 +8,7 @@ require_relative '../models/applepay/apple_pay_payment_data_header'
 require_relative '../models/applepay/apple_pay_payment_method'
 require_relative '../models/mobile_payment_method_specific_input'
 require_relative '../models/network'
-require_relative '../models/payment_product320_specific_input'
+require_relative '../models/payment_product302_specific_input'
 
 module PCPServerSDK
   module Transformer
@@ -25,7 +25,7 @@ module PCPServerSDK
         payment_product_id: 302,
         public_key_hash: header.public_key_hash,
         ephemeral_key: header.ephemeral_public_key,
-        payment_product302_specific_input: PCPServerSDK::Models::PaymentProduct320SpecificInput.new(
+        payment_product302_specific_input: PCPServerSDK::Models::PaymentProduct302SpecificInput.new(
           network: PCPServerSDK::Models::Network.from_string(payment_method.network.to_s),
           token: PCPServerSDK::Models::ApplePaymentDataTokenInformation.new(
             version: PCPServerSDK::Models::ApplePaymentTokenVersion.from_string(payment_data.version.to_s),

data/lib/PCP-server-Ruby-SDK/version.rb

@@ -1,4 +1,4 @@
 
 module PCPServerSDK
-  VERSION = '1.0.0'
+  VERSION = '1.1.0'
 end