pcp-server-ruby-sdk 1.8.0 → 1.9.0

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

@@ -109,7 +109,7 @@ module PCPServerSDK
       # @param commerce_case_id [String] The commerce case identifier
       # @param checkout_id [String] The checkout identifier
       # @return [nil]
-      def remove_checkout_request(merchant_id, commerce_case_id, checkout_id)
+      def delete_checkout_request(merchant_id, commerce_case_id, checkout_id)
         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?
@@ -125,6 +125,8 @@ module PCPServerSDK
         nil
       end
 
+      alias remove_checkout_request delete_checkout_request
+
       # Complete a checkout
       # @param merchant_id [String] The merchant identifier
       # @param commerce_case_id [String] The commerce case identifier

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

@@ -3,6 +3,7 @@ require 'json'
 require 'uri'
 require_relative 'base_api_client'
 require_relative '../models/commerce_case_response'
+require_relative '../models/commerce_cases_response'
 require_relative '../models/create_commerce_case_response'
 require_relative '../models/customer'
 
@@ -54,8 +55,8 @@ module PCPServerSDK
 
       # Get commerce cases
       # @param merchant_id [String] The merchant identifier
-      # @param query_params [PCPServerSDK::Models::GetCommerceCasesQuery] The query parameters
-      # @return [Array<PCPServerSDK::Models::CommerceCaseResponse>] The commerce cases
+      # @param query_params [PCPServerSDK::Queries::GetCommerceCasesQuery] The query parameters
+      # @return [PCPServerSDK::Models::CommerceCasesResponse] The commerce cases
       def get_commerce_cases_request(merchant_id, query_params = nil)
         raise TypeError, MERCHANT_ID_REQUIRED_ERROR if merchant_id.nil? || merchant_id.empty?
 
@@ -70,8 +71,8 @@ module PCPServerSDK
           headers: {}
         }
 
-        request = make_api_call(url.to_s, request_init)
-        request.map { |r| deserialize_json(r, PCPServerSDK::Models::CommerceCaseResponse) }
+        response = make_api_call(url.to_s, request_init)
+        deserialize_json(response, PCPServerSDK::Models::CommerceCasesResponse)
       end
 
       # Update a commerce case

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

@@ -4,6 +4,7 @@ require 'uri'
 require_relative 'base_api_client'
 require_relative '../models/cancel_response'
 require_relative '../models/deliver_response'
+require_relative '../models/complete_payment_response'
 require_relative '../models/order_response'
 require_relative '../models/return_response'
 module PCPServerSDK
@@ -22,6 +23,7 @@ module PCPServerSDK
       # @return [PCPServerSDK::Models::OrderResponse] The order response
       def create_order(merchant_id, commerce_case_id, checkout_id, payload)
         validate_ids(merchant_id, commerce_case_id, checkout_id)
+        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}/order")
 
@@ -35,6 +37,28 @@ module PCPServerSDK
         deserialize_json(response, PCPServerSDK::Models::OrderResponse)
       end
 
+      # Complete an order
+      # @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_order(merchant_id, commerce_case_id, checkout_id, payload)
+        validate_ids(merchant_id, commerce_case_id, checkout_id)
+        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
+
       # Deliver an order
       # @param merchant_id [String] The merchant identifier
       # @param commerce_case_id [String] The commerce case identifier
@@ -43,6 +67,7 @@ module PCPServerSDK
       # @return [PCPServerSDK::Models::DeliverResponse] The deliver response
       def deliver_order(merchant_id, commerce_case_id, checkout_id, payload)
         validate_ids(merchant_id, commerce_case_id, checkout_id)
+        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}/deliver")
 

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

@@ -56,6 +56,8 @@ module PCPServerSDK
 
         if attributes.key?(:'supplier_id')
           self.supplier_id = attributes[:'supplier_id']
+        else
+          self.supplier_id = nil
         end
 
         if attributes.key?(:'order_reference')

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

@@ -0,0 +1,18 @@
+require_relative 'commerce_case_response'
+
+module PCPServerSDK
+  module Models
+    # Top-level response for listing Commerce Cases.
+    class CommerceCasesResponse < Array
+      def self.build_from_hash(attributes)
+        return new unless attributes.is_a?(Array)
+
+        new.concat(attributes.map { |item| PCPServerSDK::Models::CommerceCaseResponse.build_from_hash(item) })
+      end
+
+      def to_body
+        map { |item| item.respond_to?(:to_body) ? item.to_body : item }
+      end
+    end
+  end
+end

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.8.0'
+  VERSION = '1.9.0'
 end

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

@@ -52,6 +52,7 @@ 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'
@@ -175,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'
@@ -191,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.8.0",
+  "version": "1.9.0",
   "lockfileVersion": 3,
   "requires": true,
   "packages": {
     "": {
       "name": "pcp-serversdk-ruby",
-      "version": "1.8.0",
+      "version": "1.9.0",
       "devDependencies": {
         "@commitlint/cli": "19.4.0",
         "@commitlint/config-conventional": "19.2.2",

data/package.json

@@ -1,6 +1,6 @@
 {
   "name": "pcp-serversdk-ruby",
-  "version": "1.8.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') }