pcp-server-ruby-sdk 1.6.0 → 1.8.0

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

@@ -0,0 +1,211 @@
+
+require 'date'
+require 'time'
+
+module PCPServerSDK
+  module Models
+    # Object containing details on the fund split for a payment.
+    class FundSplit
+      # Unique ID of the fund split (read-only).
+      attr_accessor :id
+
+      # Unique ID of the payment event associated with this fund split (read-only).
+      attr_accessor :payment_event_id
+
+      attr_accessor :fund_distributions
+
+      # Attribute mapping from ruby-style variable name to JSON key.
+      def self.attribute_map
+        {
+          :'id' => :'id',
+          :'payment_event_id' => :'paymentEventId',
+          :'fund_distributions' => :'fundDistributions'
+        }
+      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
+        {
+          :'id' => :'String',
+          :'payment_event_id' => :'String',
+          :'fund_distributions' => :'Array<FundDistribution>'
+        }
+      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 `FundSplit` 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 `FundSplit`. 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?(:'id')
+          self.id = attributes[:'id']
+        end
+
+        if attributes.key?(:'payment_event_id')
+          self.payment_event_id = attributes[:'payment_event_id']
+        end
+
+        if attributes.key?(:'fund_distributions')
+          if (value = attributes[:'fund_distributions']).is_a?(Array)
+            self.fund_distributions = value
+          end
+        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 &&
+            id == o.id &&
+            payment_event_id == o.payment_event_id &&
+            fund_distributions == o.fund_distributions
+      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
+        [id, payment_event_id, fund_distributions].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
+            # 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
+          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
+          # generic object (usually a Hash), return directly
+          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
+          # models (e.g. Pet) or oneOf
+          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/mobile_payment_method_specific_input.rb

@@ -26,6 +26,8 @@ module PCPServerSDK
 
       attr_accessor :payment_product302_specific_input
 
+      attr_accessor :payment_product5002_specific_input
+
       class EnumAttributeValidator
         attr_reader :datatype
         attr_reader :allowable_values
@@ -57,7 +59,8 @@ module PCPServerSDK
           :'public_key_hash' => :'publicKeyHash',
           :'ephemeral_key' => :'ephemeralKey',
           :'three_d_secure' => :'threeDSecure',
-          :'payment_product302_specific_input' => :'paymentProduct302SpecificInput'
+          :'payment_product302_specific_input' => :'paymentProduct302SpecificInput',
+          :'payment_product5002_specific_input' => :'paymentProduct5002SpecificInput'
         }
       end
 
@@ -75,7 +78,8 @@ module PCPServerSDK
           :'public_key_hash' => :'String',
           :'ephemeral_key' => :'String',
           :'three_d_secure' => :'MobilePaymentThreeDSecure',
-          :'payment_product302_specific_input' => :'PaymentProduct302SpecificInput'
+          :'payment_product302_specific_input' => :'PaymentProduct302SpecificInput',
+          :'payment_product5002_specific_input' => :'PaymentProduct5002SpecificInput'
         }
       end
 
@@ -126,6 +130,10 @@ module PCPServerSDK
         if attributes.key?(:'payment_product302_specific_input')
           self.payment_product302_specific_input = attributes[:'payment_product302_specific_input']
         end
+
+        if attributes.key?(:'payment_product5002_specific_input')
+          self.payment_product5002_specific_input = attributes[:'payment_product5002_specific_input']
+        end
       end
 
       # Checks equality by comparing each attribute.
@@ -139,7 +147,8 @@ module PCPServerSDK
             public_key_hash == o.public_key_hash &&
             ephemeral_key == o.ephemeral_key &&
             three_d_secure == o.three_d_secure &&
-            payment_product302_specific_input == o.payment_product302_specific_input
+            payment_product302_specific_input == o.payment_product302_specific_input &&
+            payment_product5002_specific_input == o.payment_product5002_specific_input
       end
 
       def eql?(o)
@@ -147,7 +156,7 @@ module PCPServerSDK
       end
 
       def hash
-        [payment_product_id, authorization_mode, encrypted_payment_data, public_key_hash, ephemeral_key, three_d_secure, payment_product302_specific_input].hash
+        [payment_product_id, authorization_mode, encrypted_payment_data, public_key_hash, ephemeral_key, three_d_secure, payment_product302_specific_input, payment_product5002_specific_input].hash
       end
 
       def self.build_from_hash(attributes)

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

@@ -42,7 +42,7 @@ module PCPServerSDK
           :'authorisation_code' => :'String',
           :'fraud_results' => :'CardFraudResults',
           :'three_d_secure_results' => :'ThreeDSecureResults',
-          :'network' => :'String'
+          :'network' => :'MobilePaymentNetwork'
         }
       end
 

data/lib/PCP-server-Ruby-SDK/models/{network.rb → mobile_payment_network.rb}

@@ -1,21 +1,21 @@
 
 module PCPServerSDK
   module Models
-    class Network
-      VISA = 'VISA'.freeze
+    class MobilePaymentNetwork
       MASTERCARD = 'MASTERCARD'.freeze
+      VISA = 'VISA'.freeze
       AMEX = 'AMEX'.freeze
       GIROCARD = 'GIROCARD'.freeze
       DISCOVER = 'DISCOVER'.freeze
       JCB = 'JCB'.freeze
 
       def self.all_networks
-        [VISA, MASTERCARD, AMEX, GIROCARD, DISCOVER, JCB]
+        [MASTERCARD, VISA, AMEX, GIROCARD, DISCOVER, JCB]
       end
 
       def self.from_string(value)
         network = all_networks.find { |net| net.casecmp(value).zero? }
-        raise TypeError, "'#{value}' can't represent a Network" unless network
+        raise TypeError, "'#{value}' can't represent a MobilePaymentNetwork" unless network
 
         network
       end

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

@@ -169,6 +169,7 @@ module PCPServerSDK
             product_type == o.product_type &&
             quantity == o.quantity &&
             tax_amount == o.tax_amount &&
+            tax_amount_per_unit == o.tax_amount_per_unit &&
             product_url == o.product_url &&
             product_image_url == o.product_image_url &&
             product_category_path == o.product_category_path &&
@@ -184,7 +185,7 @@ module PCPServerSDK
       # Calculates hash code according to all attributes.
       # @return [Integer] Hash code
       def hash
-        [product_code, product_price, product_type, quantity, tax_amount, product_url, product_image_url, product_category_path, merchant_shop_delivery_reference].hash
+        [product_code, product_price, product_type, quantity, tax_amount, tax_amount_per_unit, product_url, product_image_url, product_category_path, merchant_shop_delivery_reference].hash
       end
 
       # Builds the object from hash

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

@@ -25,6 +25,9 @@ module PCPServerSDK
       # Tax on the line item, with the last two digits implied as decimal places
       attr_accessor :tax_amount
 
+      # Indicates if the taxAmount is to be interpreted as the tax amount per unit rather than for the entire line item.
+      attr_accessor :tax_amount_per_unit
+
       # URL of the product in shop.   Used for PAYONE Buy Now, Pay Later (BNPL).
       attr_accessor :product_url
 
@@ -71,6 +74,7 @@ module PCPServerSDK
           :'product_type' => :'productType',
           :'quantity' => :'quantity',
           :'tax_amount' => :'taxAmount',
+          :'tax_amount_per_unit' => :'taxAmountPerUnit',
           :'product_url' => :'productUrl',
           :'product_image_url' => :'productImageUrl',
           :'product_category_path' => :'productCategoryPath',
@@ -93,6 +97,7 @@ module PCPServerSDK
           :'product_type' => :'ProductType',
           :'quantity' => :'Integer',
           :'tax_amount' => :'Integer',
+          :'tax_amount_per_unit' => :'Boolean',
           :'product_url' => :'String',
           :'product_image_url' => :'String',
           :'product_category_path' => :'String',
@@ -163,6 +168,10 @@ module PCPServerSDK
           self.tax_amount = attributes[:'tax_amount']
         end
 
+        if attributes.key?(:'tax_amount_per_unit')
+          self.tax_amount_per_unit = attributes[:'tax_amount_per_unit']
+        end
+
         if attributes.key?(:'product_url')
           self.product_url = attributes[:'product_url']
         end
@@ -192,6 +201,7 @@ module PCPServerSDK
             product_type == o.product_type &&
             quantity == o.quantity &&
             tax_amount == o.tax_amount &&
+            tax_amount_per_unit == o.tax_amount_per_unit &&
             product_url == o.product_url &&
             product_image_url == o.product_image_url &&
             product_category_path == o.product_category_path &&
@@ -207,7 +217,7 @@ module PCPServerSDK
       # Calculates hash code according to all attributes.
       # @return [Integer] Hash code
       def hash
-        [id, status, product_code, product_price, product_type, quantity, tax_amount, product_url, product_image_url, product_category_path, merchant_shop_delivery_reference].hash
+        [id, status, product_code, product_price, product_type, quantity, tax_amount, tax_amount_per_unit, product_url, product_image_url, product_category_path, merchant_shop_delivery_reference].hash
       end
 
       # Builds the object from hash

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

@@ -25,6 +25,9 @@ module PCPServerSDK
       # Tax on the line item, with the last two digits implied as decimal places
       attr_accessor :tax_amount
 
+      # Indicates if the taxAmount is to be interpreted as the tax amount per unit rather than for the entire line item.
+      attr_accessor :tax_amount_per_unit
+
       # URL of the product in shop.   Used for PAYONE Buy Now, Pay Later (BNPL).
       attr_accessor :product_url
 
@@ -71,6 +74,7 @@ module PCPServerSDK
           :'product_type' => :'productType',
           :'quantity' => :'quantity',
           :'tax_amount' => :'taxAmount',
+          :'tax_amount_per_unit' => :'taxAmountPerUnit',
           :'product_url' => :'productUrl',
           :'product_image_url' => :'productImageUrl',
           :'product_category_path' => :'productCategoryPath',
@@ -93,6 +97,7 @@ module PCPServerSDK
           :'product_type' => :'ProductType',
           :'quantity' => :'Integer',
           :'tax_amount' => :'Integer',
+          :'tax_amount_per_unit' => :'Boolean',
           :'product_url' => :'String',
           :'product_image_url' => :'String',
           :'product_category_path' => :'String',
@@ -163,6 +168,10 @@ module PCPServerSDK
           self.tax_amount = attributes[:'tax_amount']
         end
 
+        if attributes.key?(:'tax_amount_per_unit')
+          self.tax_amount_per_unit = attributes[:'tax_amount_per_unit']
+        end
+
         if attributes.key?(:'product_url')
           self.product_url = attributes[:'product_url']
         end
@@ -192,6 +201,7 @@ module PCPServerSDK
             product_type == o.product_type &&
             quantity == o.quantity &&
             tax_amount == o.tax_amount &&
+            tax_amount_per_unit == o.tax_amount_per_unit &&
             product_url == o.product_url &&
             product_image_url == o.product_image_url &&
             product_category_path == o.product_category_path &&
@@ -207,7 +217,7 @@ module PCPServerSDK
       # Calculates hash code according to all attributes.
       # @return [Integer] Hash code
       def hash
-        [id, status, product_code, product_price, product_type, quantity, tax_amount, product_url, product_image_url, product_category_path, merchant_shop_delivery_reference].hash
+        [id, status, product_code, product_price, product_type, quantity, tax_amount, tax_amount_per_unit, product_url, product_image_url, product_category_path, merchant_shop_delivery_reference].hash
       end
 
       # Builds the object from hash

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

@@ -14,6 +14,7 @@ module PCPServerSDK
 
       attr_accessor :payment_method_specific_input
 
+      attr_accessor :fund_split
 
 
       class EnumAttributeValidator
@@ -44,7 +45,8 @@ module PCPServerSDK
           :'order_type' => :'orderType',
           :'order_references' => :'orderReferences',
           :'items' => :'items',
-          :'payment_method_specific_input' => :'paymentMethodSpecificInput'
+          :'payment_method_specific_input' => :'paymentMethodSpecificInput',
+          :'fund_split' => :'fundSplit'
         }
       end
 
@@ -59,7 +61,8 @@ module PCPServerSDK
           :'order_type' => :'OrderType',
           :'order_references' => :'References',
           :'items' => :'Array<OrderItem>',
-          :'payment_method_specific_input' => :'PaymentMethodSpecificInput'
+          :'payment_method_specific_input' => :'PaymentMethodSpecificInput',
+          :'fund_split' => :'FundSplit'
         }
       end
 
@@ -101,6 +104,10 @@ module PCPServerSDK
         if attributes.key?(:'payment_method_specific_input')
           self.payment_method_specific_input = attributes[:'payment_method_specific_input']
         end
+
+        if attributes.key?(:'fund_split')
+          self.fund_split = attributes[:'fund_split']
+        end
       end
 
       # Checks equality by comparing each attribute.
@@ -111,7 +118,8 @@ module PCPServerSDK
             order_type == o.order_type &&
             order_references == o.order_references &&
             items == o.items &&
-            payment_method_specific_input == o.payment_method_specific_input
+            payment_method_specific_input == o.payment_method_specific_input &&
+            fund_split == o.fund_split
       end
 
       # @see the `==` method
@@ -123,7 +131,7 @@ module PCPServerSDK
       # Calculates hash code according to all attributes.
       # @return [Integer] Hash code
       def hash
-        [order_type, order_references, items, payment_method_specific_input].hash
+        [order_type, order_references, items, payment_method_specific_input, fund_split].hash
       end
 
       # Builds the object from hash

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

@@ -1,39 +1,13 @@
 require 'date'
 require 'time'
 
-# Request to refresh the payment status of a specific payment.
+# Request to pause a specific payment.
 module PCPServerSDK
   module Models
     class PausePaymentRequest
-      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
@@ -43,9 +17,7 @@ module PCPServerSDK
 
       # Attribute type mapping.
       def self.openapi_types
-        {
-          :'refresh_type' => :'RefreshType'
-        }
+        {}
       end
 
       # List of attributes with nullable: true
@@ -66,18 +38,13 @@ module PCPServerSDK
           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.
       # @param [Object] Object to be compared
       def ==(o)
         return true if self.equal?(o)
-        self.class == o.class &&
-            refresh_type == o.refresh_type
+        self.class == o.class
       end
 
       # @see the `==` method
@@ -89,7 +56,7 @@ module PCPServerSDK
       # Calculates hash code according to all attributes.
       # @return [Integer] Hash code
       def hash
-        [refresh_type].hash
+        [].hash
       end
 
       # Builds the object from hash

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

@@ -5,6 +5,9 @@ require 'time'
 module PCPServerSDK
   module Models
     class PaymentEvent
+      # Unique identifier of the payment event.
+      attr_accessor :payment_event_id
+
       attr_accessor :type
 
       attr_accessor :amount_of_money
@@ -18,6 +21,12 @@ module PCPServerSDK
 
       attr_accessor :payment_instructions
 
+      # The date and time the payment event was created. Format: YYYY-MM-DDThh:mm:ss+TZD
+      attr_accessor :creation_date_time
+
+      # Unique reference of the Commerce Case that is also returned for reporting and reconciliation purposes.
+      attr_accessor :merchant_reference
+
       class EnumAttributeValidator
         attr_reader :datatype
         attr_reader :allowable_values
@@ -43,12 +52,15 @@ module PCPServerSDK
       # Attribute mapping from ruby-style variable name to JSON key.
       def self.attribute_map
         {
+          :'payment_event_id' => :'paymentEventId',
           :'type' => :'type',
           :'amount_of_money' => :'amountOfMoney',
           :'payment_status' => :'paymentStatus',
           :'cancellation_reason' => :'cancellationReason',
           :'return_reason' => :'returnReason',
-          :'payment_instructions' => :'paymentInstructions'
+          :'payment_instructions' => :'paymentInstructions',
+          :'creation_date_time' => :'creationDateTime',
+          :'merchant_reference' => :'merchantReference'
         }
       end
 
@@ -60,12 +72,15 @@ module PCPServerSDK
       # Attribute type mapping.
       def self.openapi_types
         {
+          :'payment_event_id' => :'String',
           :'type' => :'PaymentType',
           :'amount_of_money' => :'AmountOfMoney',
           :'payment_status' => :'StatusValue',
           :'cancellation_reason' => :'CancellationReason',
           :'return_reason' => :'String',
-          :'payment_instructions' => :'PaymentInstructions'
+          :'payment_instructions' => :'PaymentInstructions',
+          :'creation_date_time' => :'Time',
+          :'merchant_reference' => :'String'
         }
       end
 
@@ -89,6 +104,10 @@ module PCPServerSDK
           h[k.to_sym] = v
         }
 
+        if attributes.key?(:'payment_event_id')
+          self.payment_event_id = attributes[:'payment_event_id']
+        end
+
         if attributes.key?(:'type')
           self.type = attributes[:'type']
         end
@@ -112,18 +131,29 @@ module PCPServerSDK
         if attributes.key?(:'payment_instructions')
           self.payment_instructions = attributes[:'payment_instructions']
         end
+
+        if attributes.key?(:'creation_date_time')
+          self.creation_date_time = attributes[:'creation_date_time']
+        end
+
+        if attributes.key?(:'merchant_reference')
+          self.merchant_reference = attributes[:'merchant_reference']
+        end
       end
 
       # Checks equality by comparing each attribute.
       def ==(o)
         return true if self.equal?(o)
         self.class == o.class &&
+            payment_event_id == o.payment_event_id &&
             type == o.type &&
             amount_of_money == o.amount_of_money &&
             payment_status == o.payment_status &&
             cancellation_reason == o.cancellation_reason &&
             return_reason == o.return_reason &&
-            payment_instructions == o.payment_instructions
+            payment_instructions == o.payment_instructions &&
+            creation_date_time == o.creation_date_time &&
+            merchant_reference == o.merchant_reference
       end
 
       def eql?(o)
@@ -131,7 +161,7 @@ module PCPServerSDK
       end
 
       def hash
-        [type, amount_of_money, payment_status, cancellation_reason, return_reason, payment_instructions].hash
+        [payment_event_id, type, amount_of_money, payment_status, cancellation_reason, return_reason, payment_instructions, creation_date_time, merchant_reference].hash
       end
 
       # Builds the object from hash