pcp-server-ruby-sdk 1.7.0 → 1.9.0

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

@@ -0,0 +1,198 @@
+require 'date'
+require 'time'
+
+# Object that holds all reference properties for a refund that are linked to this transaction.
+module PCPServerSDK
+  module Models
+    class PaymentReferencesForRefund
+      # Unique reference of the Commerce Case that is also returned for reporting and reconciliation purposes.
+      attr_accessor :merchant_reference
+
+      # Reference to the capture to be refunded.
+      attr_accessor :capture_reference
+
+      # Attribute mapping from ruby-style variable name to JSON key.
+      def self.attribute_map
+        {
+          :'merchant_reference' => :'merchantReference',
+          :'capture_reference' => :'captureReference'
+        }
+      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
+        {
+          :'merchant_reference' => :'String',
+          :'capture_reference' => :'String'
+        }
+      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 `PaymentReferencesForRefund` 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 `PaymentReferencesForRefund`. 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?(:'merchant_reference')
+          self.merchant_reference = attributes[:'merchant_reference']
+        end
+
+        if attributes.key?(:'capture_reference')
+          self.capture_reference = attributes[:'capture_reference']
+        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 &&
+            merchant_reference == o.merchant_reference &&
+            capture_reference == o.capture_reference
+      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
+        [merchant_reference, capture_reference].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/redirect_payment_method_specific_input.rb

@@ -25,9 +25,6 @@ module PCPServerSDK
 
       attr_accessor :redirection_data
 
-      # Indicates whether the PayPal JavaScript SDK flow is used on the redirect level.
-      attr_accessor :java_script_sdk_flow
-
       # Attribute mapping from ruby-style variable name to JSON key.
       def self.attribute_map
         {
@@ -37,8 +34,7 @@ module PCPServerSDK
           :'tokenize' => :'tokenize',
           :'payment_product_id' => :'paymentProductId',
           :'payment_product840_specific_input' => :'paymentProduct840SpecificInput',
-          :'redirection_data' => :'redirectionData',
-          :'java_script_sdk_flow' => :'javaScriptSdkFlow'
+          :'redirection_data' => :'redirectionData'
         }
       end
 
@@ -56,8 +52,7 @@ module PCPServerSDK
           :'tokenize' => :'Boolean',
           :'payment_product_id' => :'Integer',
           :'payment_product840_specific_input' => :'RedirectPaymentProduct840SpecificInput',
-          :'redirection_data' => :'RedirectionData',
-          :'java_script_sdk_flow' => :'Boolean'
+          :'redirection_data' => :'RedirectionData'
         }
       end
 
@@ -109,10 +104,6 @@ module PCPServerSDK
         if attributes.key?(:'redirection_data')
           self.redirection_data = attributes[:'redirection_data']
         end
-
-        if attributes.key?(:'java_script_sdk_flow')
-          self.java_script_sdk_flow = attributes[:'java_script_sdk_flow']
-        end
       end
 
       # Checks equality by comparing each attribute.
@@ -126,8 +117,7 @@ module PCPServerSDK
             tokenize == o.tokenize &&
             payment_product_id == o.payment_product_id &&
             payment_product840_specific_input == o.payment_product840_specific_input &&
-            redirection_data == o.redirection_data &&
-            java_script_sdk_flow == o.java_script_sdk_flow
+            redirection_data == o.redirection_data
       end
 
       # @see the `==` method
@@ -139,7 +129,7 @@ module PCPServerSDK
       # Calculates hash code according to all attributes.
       # @return [Integer] Hash code
       def hash
-        [requires_approval, payment_processing_token, reporting_token, tokenize, payment_product_id, payment_product840_specific_input, redirection_data, java_script_sdk_flow].hash
+        [requires_approval, payment_processing_token, reporting_token, tokenize, payment_product_id, payment_product840_specific_input, redirection_data].hash
       end
 
       # Builds the object from hash

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

@@ -17,17 +17,13 @@ module PCPServerSDK
       # Token to identify the card in the reporting.
       attr_accessor :reporting_token
 
-      # Indicates whether the PayPal JavaScript SDK flow was used for the redirect payment.
-      attr_accessor :java_script_sdk_flow
-
       # Attribute mapping from ruby-style variable name to JSON key.
       def self.attribute_map
         {
           :'payment_product_id' => :'paymentProductId',
           :'payment_product840_specific_output' => :'paymentProduct840SpecificOutput',
           :'payment_processing_token' => :'paymentProcessingToken',
-          :'reporting_token' => :'reportingToken',
-          :'java_script_sdk_flow' => :'javaScriptSdkFlow'
+          :'reporting_token' => :'reportingToken'
         }
       end
 
@@ -42,8 +38,7 @@ module PCPServerSDK
           :'payment_product_id' => :'Integer',
           :'payment_product840_specific_output' => :'PaymentProduct840SpecificOutput',
           :'payment_processing_token' => :'String',
-          :'reporting_token' => :'String',
-          :'java_script_sdk_flow' => :'Boolean'
+          :'reporting_token' => :'String'
         }
       end
 
@@ -83,10 +78,6 @@ module PCPServerSDK
         if attributes.key?(:'reporting_token')
           self.reporting_token = attributes[:'reporting_token']
         end
-
-        if attributes.key?(:'java_script_sdk_flow')
-          self.java_script_sdk_flow = attributes[:'java_script_sdk_flow']
-        end
       end
 
       # Checks equality by comparing each attribute.
@@ -97,8 +88,7 @@ module PCPServerSDK
             payment_product_id == o.payment_product_id &&
             payment_product840_specific_output == o.payment_product840_specific_output &&
             payment_processing_token == o.payment_processing_token &&
-            reporting_token == o.reporting_token &&
-            java_script_sdk_flow == o.java_script_sdk_flow
+            reporting_token == o.reporting_token
       end
 
       # @see the `==` method
@@ -110,7 +100,7 @@ module PCPServerSDK
       # Calculates hash code according to all attributes.
       # @return [Integer] Hash code
       def hash
-        [payment_product_id, payment_product840_specific_output, payment_processing_token, reporting_token, java_script_sdk_flow].hash
+        [payment_product_id, payment_product840_specific_output, payment_processing_token, reporting_token].hash
       end
 
       # Builds the object from hash

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

@@ -33,7 +33,7 @@ module PCPServerSDK
       def self.openapi_types
         {
           :'amount_of_money' => :'PositiveAmountOfMoney',
-          :'references' => :'PaymentReferences',
+          :'references' => :'PaymentReferencesForRefund',
           :'_return' => :'ReturnInformation',
           :'fund_split' => :'FundSplit'
         }

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

@@ -0,0 +1,108 @@
+require 'date'
+require 'psych'
+require 'set'
+
+module PCPServerSDK
+  module Models
+    module RequiredFieldValidation
+      SCHEMA_PATH = File.expand_path('../../../api-definition.yaml', __dir__)
+
+      class << self
+        def install!
+          required_attributes_by_class.each do |class_name, required_attributes|
+            next unless PCPServerSDK::Models.const_defined?(class_name, false)
+
+            klass = PCPServerSDK::Models.const_get(class_name)
+            next unless klass.is_a?(Class)
+            next if klass < Array
+            next unless klass.respond_to?(:attribute_map)
+            next if klass.instance_variable_defined?(:@required_field_validation_installed)
+
+            klass.prepend(build_validation_module(required_attributes))
+            klass.singleton_class.prepend(build_class_validation_module)
+            klass.instance_variable_set(:@required_field_validation_installed, true)
+          end
+        end
+
+        private
+
+          def build_validation_module(required_attributes)
+            Module.new do
+              define_method(:initialize) do |attributes = {}|
+                @required_field_validation_initializing = true
+                initialization_succeeded = false
+
+                begin
+                  super(attributes)
+                  initialization_succeeded = true
+                ensure
+                  @required_field_validation_initializing = false
+                end
+
+                if initialization_succeeded && attributes.is_a?(Hash) && !attributes.empty?
+                  validate_required_fields!
+                end
+              end
+
+              define_method(:validate_required_fields!) do
+                missing_attributes = required_attributes.select { |attribute| public_send(attribute).nil? }
+                return if missing_attributes.empty?
+
+                raise ArgumentError, "#{missing_attributes.first} cannot be nil"
+              end
+
+              define_method(:to_hash) do
+                validate_required_fields!
+                super()
+              end
+
+              required_attributes.each do |attribute|
+                define_method("#{attribute}=") do |value|
+                  if value.nil? && !@required_field_validation_initializing
+                    raise ArgumentError, "#{attribute} cannot be nil"
+                  end
+
+                  super(value)
+                end
+              end
+            end
+          end
+          def build_class_validation_module
+            Module.new do
+              def build_from_hash(attributes)
+                object = super(attributes)
+                return object if object.nil?
+                return object if object.is_a?(Array)
+
+                object.send(:validate_required_fields!) if object.respond_to?(:validate_required_fields!, true)
+                object
+              end
+            end
+          end
+
+          def required_attributes_by_class
+            @required_attributes_by_class ||= begin
+              spec = Psych.safe_load_file(SCHEMA_PATH, permitted_classes: [Time, Date, Symbol], aliases: true)
+              schemas = spec.dig('components', 'schemas') || {}
+
+              schemas.each_with_object({}) do |(schema_name, schema), mapping|
+                required_properties = Array(schema['required'])
+                next if required_properties.empty?
+                next unless PCPServerSDK::Models.const_defined?(schema_name, false)
+
+                klass = PCPServerSDK::Models.const_get(schema_name)
+                next unless klass.is_a?(Class)
+                next unless klass.respond_to?(:attribute_map)
+
+                attribute_map = klass.attribute_map.invert
+                required_attributes = required_properties.filter_map { |property| attribute_map[property.to_sym] }
+                next if required_attributes.empty?
+
+                mapping[schema_name] = required_attributes.freeze
+              end.freeze
+            end
+          end
+      end
+    end
+  end
+end

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

@@ -1,4 +1,4 @@
 
 module PCPServerSDK
-  VERSION = '1.7.0'
+  VERSION = '1.9.0'
 end

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

@@ -52,8 +52,10 @@ require_relative 'PCP-server-Ruby-SDK/models/checkout_references'
 require_relative 'PCP-server-Ruby-SDK/models/checkout_response'
 require_relative 'PCP-server-Ruby-SDK/models/checkouts_response'
 require_relative 'PCP-server-Ruby-SDK/models/commerce_case_response'
+require_relative 'PCP-server-Ruby-SDK/models/commerce_cases_response'
 require_relative 'PCP-server-Ruby-SDK/models/company_information'
 require_relative 'PCP-server-Ruby-SDK/models/complete_financing_payment_method_specific_input'
+require_relative 'PCP-server-Ruby-SDK/models/complete_order_request'
 require_relative 'PCP-server-Ruby-SDK/models/complete_payment_method_specific_input'
 require_relative 'PCP-server-Ruby-SDK/models/complete_payment_request'
 require_relative 'PCP-server-Ruby-SDK/models/complete_payment_response'
@@ -119,6 +121,7 @@ require_relative 'PCP-server-Ruby-SDK/models/payment_product771_specific_output'
 require_relative 'PCP-server-Ruby-SDK/models/payment_product840_customer_account'
 require_relative 'PCP-server-Ruby-SDK/models/payment_product840_specific_output'
 require_relative 'PCP-server-Ruby-SDK/models/payment_references'
+require_relative 'PCP-server-Ruby-SDK/models/payment_references_for_refund'
 require_relative 'PCP-server-Ruby-SDK/models/payment_response'
 require_relative 'PCP-server-Ruby-SDK/models/payment_status_output'
 require_relative 'PCP-server-Ruby-SDK/models/payment_type'
@@ -173,6 +176,7 @@ require_relative 'PCP-server-Ruby-SDK/models/applepay/apple_pay_payment_data_hea
 require_relative 'PCP-server-Ruby-SDK/models/applepay/apple_pay_payment_method'
 require_relative 'PCP-server-Ruby-SDK/models/applepay/apple_pay_payment_method_type'
 require_relative 'PCP-server-Ruby-SDK/models/applepay/apple_pay_payment_token'
+require_relative 'PCP-server-Ruby-SDK/models/required_field_validation'
 
 # Queries
 require_relative 'PCP-server-Ruby-SDK/queries/get_checkouts_query'
@@ -189,6 +193,8 @@ require_relative 'PCP-server-Ruby-SDK/request_header_generator'
 require_relative 'PCP-server-Ruby-SDK/version'
 
 module PCPServerSDK
+  PCPServerSDK::Models::RequiredFieldValidation.install!
+
   class << self
     # Customize default settings for the SDK using block.
     #   PCPServerSDK.configure do |config|

data/package-lock.json

@@ -1,12 +1,12 @@
 {
   "name": "pcp-serversdk-ruby",
-  "version": "1.7.0",
+  "version": "1.9.0",
   "lockfileVersion": 3,
   "requires": true,
   "packages": {
     "": {
       "name": "pcp-serversdk-ruby",
-      "version": "1.7.0",
+      "version": "1.9.0",
       "devDependencies": {
         "@commitlint/cli": "19.4.0",
         "@commitlint/config-conventional": "19.2.2",
@@ -306,6 +306,20 @@
         "node": ">=10.13.0"
       }
     },
+    "node_modules/@simple-libs/stream-utils": {
+      "version": "1.2.0",
+      "resolved": "https://registry.npmjs.org/@simple-libs/stream-utils/-/stream-utils-1.2.0.tgz",
+      "integrity": "sha512-KxXvfapcixpz6rVEB6HPjOUZT22yN6v0vI0urQSk1L8MlEWPDFCZkhw2xmkyoTGYeFw7tWTZd7e3lVzRZRN/EA==",
+      "dev": true,
+      "license": "MIT",
+      "optional": true,
+      "engines": {
+        "node": ">=18"
+      },
+      "funding": {
+        "url": "https://ko-fi.com/dangreen"
+      }
+    },
     "node_modules/@types/conventional-commits-parser": {
       "version": "5.0.2",
       "resolved": "https://registry.npmjs.org/@types/conventional-commits-parser/-/conventional-commits-parser-5.0.2.tgz",

data/package.json

@@ -1,6 +1,6 @@
 {
   "name": "pcp-serversdk-ruby",
-  "version": "1.7.0",
+  "version": "1.9.0",
   "type": "commonjs",
   "scripts": {
     "changelog": "conventional-changelog -i CHANGELOG.md -s --config ./changelog.config.js"

data/spec/endpoints/checkout_api_client_spec.rb

@@ -255,6 +255,28 @@ RSpec.describe PCPServerSDK::Endpoints::CheckoutApiClient do
     end
   end
 
+  describe '#remove_checkout_request' do
+    context 'when request is successful' do
+      let(:response) { double('Response', body: '{}', code: 200) }
+
+      before do
+        allow(client).to receive(:get_response).and_return(response)
+      end
+
+      it 'does not raise an error' do
+        expect { client.remove_checkout_request('1', '2', '3') }.not_to raise_error
+      end
+    end
+
+    context 'when some params are nil' do
+      it 'raises a TypeError' do
+        expect { client.remove_checkout_request(nil, '2', '3') }.to raise_error(TypeError, 'Merchant ID is required')
+        expect { client.remove_checkout_request('1', nil, '3') }.to raise_error(TypeError, 'Commerce Case ID is required')
+        expect { client.remove_checkout_request('1', '2', nil) }.to raise_error(TypeError, 'Checkout ID is required')
+      end
+    end
+  end
+
   describe '#complete_checkout_request' do
     let(:payload) { double('PCPServerSDK::Models::CompleteOrderRequest') }
     

data/spec/endpoints/order_management_checkout_actions_api_client_spec.rb

@@ -113,6 +113,57 @@ RSpec.describe PCPServerSDK::Endpoints::OrderManagementCheckoutActionsApiClient
     end
   end
 
+  describe '#complete_order' do
+    let(:payload) { double('PCPServerSDK::Models::CompleteOrderRequest') }
+
+    context 'when request is successful' do
+      let(:response) { double('Response', body: '{}', code: '200') }
+      let(:expected_response) { PCPServerSDK::Models::CompletePaymentResponse.new }
+
+      before do
+        allow(client).to receive(:get_response).and_return(response)
+      end
+
+      it 'returns a successful response' do
+        result = client.complete_order('1', '2', '3', payload)
+        expect(result).to eq(expected_response)
+      end
+    end
+
+    context 'when request is unsuccessful (400)' do
+      let(:response) { double('Response', body: error_body, code: '400') }
+
+      before do
+        allow(client).to receive(:get_response).and_return(response)
+      end
+
+      it 'raises an PCPServerSDK::Errors::ApiErrorResponseException' do
+        expect { client.complete_order('1', '2', '3', payload) }.to raise_error(PCPServerSDK::Errors::ApiErrorResponseException)
+      end
+    end
+
+    context 'when request is unsuccessful (500)' do
+      let(:response) { double('Response', body: '{}', code: '500') }
+
+      before do
+        allow(client).to receive(:get_response).and_return(response)
+      end
+
+      it 'raises an PCPServerSDK::Errors::ApiResponseRetrievalException' do
+        expect { client.complete_order('1', '2', '3', payload) }.to raise_error(PCPServerSDK::Errors::ApiResponseRetrievalException)
+      end
+    end
+
+    context 'when some params are nil' do
+      it 'raises a TypeError' do
+        expect { client.complete_order(nil, '2', '3', payload) }.to raise_error(TypeError, 'Merchant ID is required')
+        expect { client.complete_order('1', nil, '3', payload) }.to raise_error(TypeError, 'Commerce Case ID is required')
+        expect { client.complete_order('1', '2', nil, payload) }.to raise_error(TypeError, 'Checkout ID is required')
+        expect { client.complete_order('1', '2', '3', nil) }.to raise_error(TypeError, 'Payload is required')
+      end
+    end
+  end
+
   describe '#return_order' do
     let(:payload) { double('PCPServerSDK::Models::ReturnRequest') }