pcp-server-ruby-sdk 1.8.0 → 1.10.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/endpoints/payment_execution_api_client.rb

@@ -6,6 +6,7 @@ require_relative '../models/cancel_payment_response'
 require_relative '../models/capture_payment_response'
 require_relative '../models/complete_payment_response'
 require_relative '../models/create_payment_response'
+require_relative '../models/fund_split_response'
 require_relative '../models/refund_payment_response'
 module PCPServerSDK
   module Endpoints
@@ -176,6 +177,31 @@ module PCPServerSDK
         deserialize_json(response, PCPServerSDK::Models::PaymentExecution)
       end
 
+      # Create a fund split for a payment event
+      # @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 event_id [String] The payment event identifier
+      # @param payload [PCPServerSDK::Models::FundSplitRequest] The fund split request
+      # @return [PCPServerSDK::Models::FundSplitResponse] The fund split response
+      def create_fund_split(merchant_id, commerce_case_id, checkout_id, payment_execution_id, event_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?
+        raise TypeError, 'Event ID is required' if event_id.nil? || event_id.empty?
+
+        url = URI.join(get_config.host, "/v1/#{merchant_id}/commerce-cases/#{commerce_case_id}/checkouts/#{checkout_id}/payment-executions/#{payment_execution_id}/events/#{event_id}/fund-splits")
+
+        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::FundSplitResponse)
+      end
+
 
     private
 

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

@@ -6,6 +6,11 @@ module PCPServerSDK
     class CancelPaymentRequest
       attr_accessor :cancellation_reason
 
+      # Here you can specify the amount that you want to cancel (specified in cents, where single digit currencies
+      # are presumed to have 2 digits). The amount can be lower than the amount that was authorized, but not higher. 
+      # If left empty, the remaining open amount will be cancelled.
+      attr_accessor :amount
+
       class EnumAttributeValidator
         attr_reader :datatype
         attr_reader :allowable_values
@@ -31,7 +36,8 @@ module PCPServerSDK
       # Attribute mapping from ruby-style variable name to JSON key.
       def self.attribute_map
         {
-          :'cancellation_reason' => :'cancellationReason'
+          :'cancellation_reason' => :'cancellationReason',
+          :'amount' => :'amount'
         }
       end
 
@@ -43,7 +49,8 @@ module PCPServerSDK
       # Attribute type mapping.
       def self.openapi_types
         {
-          :'cancellation_reason' => :'CancellationReason'
+          :'cancellation_reason' => :'CancellationReason',
+          :'amount' => :'Integer'
         }
       end
 
@@ -71,6 +78,10 @@ module PCPServerSDK
         if attributes.key?(:'cancellation_reason')
           self.cancellation_reason = attributes[:'cancellation_reason']
         end
+
+        if attributes.key?(:'amount')
+          self.amount = attributes[:'amount']
+        end
       end
 
       # Checks equality by comparing each attribute.
@@ -78,7 +89,8 @@ module PCPServerSDK
       def ==(o)
         return true if self.equal?(o)
         self.class == o.class &&
-            cancellation_reason == o.cancellation_reason
+            cancellation_reason == o.cancellation_reason &&
+            amount == o.amount
       end
 
       # @see the `==` method
@@ -90,7 +102,7 @@ module PCPServerSDK
       # Calculates hash code according to all attributes.
       # @return [Integer] Hash code
       def hash
-        [cancellation_reason].hash
+        [cancellation_reason, amount].hash
       end
 
       # Builds the object from hash

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/fund_split_request.rb

@@ -0,0 +1,153 @@
+
+require 'date'
+require 'time'
+
+module PCPServerSDK
+  module Models
+    class FundSplitRequest
+      attr_accessor :fund_split
+
+      def self.attribute_map
+        {
+          :'fund_split' => :'fundSplit'
+        }
+      end
+
+      def self.acceptable_attributes
+        attribute_map.values
+      end
+
+      def self.openapi_types
+        {
+          :'fund_split' => :'FundSplit'
+        }
+      end
+
+      def self.openapi_nullable
+        Set.new([])
+      end
+
+      def initialize(attributes = {})
+        if (!attributes.is_a?(Hash))
+          fail ArgumentError, "The input argument (attributes) must be a hash in `FundSplitRequest` 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 `FundSplitRequest`. 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?(:'fund_split')
+          self.fund_split = attributes[:'fund_split']
+        end
+      end
+
+      def ==(o)
+        return true if self.equal?(o)
+        self.class == o.class &&
+          fund_split == o.fund_split
+      end
+
+      def eql?(o)
+        self == o
+      end
+
+      def hash
+        [fund_split].hash
+      end
+
+      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
+
+      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
+
+      def to_s
+        to_hash.to_s
+      end
+
+      def to_body
+        to_hash
+      end
+
+      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
+
+      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/fund_split_response.rb

@@ -0,0 +1,180 @@
+
+require 'date'
+require 'time'
+
+module PCPServerSDK
+  module Models
+    class FundSplitResponse
+      attr_accessor :fund_split_id
+
+      attr_accessor :payment_execution_id
+
+      attr_accessor :event_id
+
+      attr_accessor :fund_split
+
+      def self.attribute_map
+        {
+          :'fund_split_id' => :'fundSplitId',
+          :'payment_execution_id' => :'paymentExecutionId',
+          :'event_id' => :'eventId',
+          :'fund_split' => :'fundSplit'
+        }
+      end
+
+      def self.acceptable_attributes
+        attribute_map.values
+      end
+
+      def self.openapi_types
+        {
+          :'fund_split_id' => :'String',
+          :'payment_execution_id' => :'String',
+          :'event_id' => :'String',
+          :'fund_split' => :'FundSplit'
+        }
+      end
+
+      def self.openapi_nullable
+        Set.new([])
+      end
+
+      def initialize(attributes = {})
+        if (!attributes.is_a?(Hash))
+          fail ArgumentError, "The input argument (attributes) must be a hash in `FundSplitResponse` 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 `FundSplitResponse`. 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?(:'fund_split_id')
+          self.fund_split_id = attributes[:'fund_split_id']
+        end
+
+        if attributes.key?(:'payment_execution_id')
+          self.payment_execution_id = attributes[:'payment_execution_id']
+        end
+
+        if attributes.key?(:'event_id')
+          self.event_id = attributes[:'event_id']
+        end
+
+        if attributes.key?(:'fund_split')
+          self.fund_split = attributes[:'fund_split']
+        end
+      end
+
+      def ==(o)
+        return true if self.equal?(o)
+        self.class == o.class &&
+          fund_split_id == o.fund_split_id &&
+          payment_execution_id == o.payment_execution_id &&
+          event_id == o.event_id &&
+          fund_split == o.fund_split
+      end
+
+      def eql?(o)
+        self == o
+      end
+
+      def hash
+        [fund_split_id, payment_execution_id, event_id, fund_split].hash
+      end
+
+      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
+
+      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
+
+      def to_s
+        to_hash.to_s
+      end
+
+      def to_body
+        to_hash
+      end
+
+      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
+
+      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/payment_references_for_refund.rb

@@ -1,14 +1,21 @@
 require 'date'
 require 'time'
 
-# Object that holds all reference properties for a refund that are linked to this transaction.
+# Object that holds all reference properties that are linked to this refund transaction.
+# Extends the standard PaymentReferences with an additional captureReference field to support
+# scenarios where a Checkout may contain multiple partial captures from different sellers.
 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.
+      # Merchant-provided reference of the capture that this refund should be applied to.
+      #          A single Checkout can contain multiple partial captures.
+      #          By supplying the captureReference the merchant ensures the refund is allocated to the correct
+      #          capture.
+      #          This value must match the merchantReference that was provided in the PaymentReferences of the
+      #          original capture request.
       attr_accessor :capture_reference
 
       # Attribute mapping from ruby-style variable name to JSON key.

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

@@ -23,6 +23,8 @@ module PCPServerSDK
 
       attr_accessor :payment_product840_specific_input
 
+      attr_accessor :payment_product900_specific_input
+
       attr_accessor :redirection_data
 
       # Attribute mapping from ruby-style variable name to JSON key.
@@ -34,6 +36,7 @@ module PCPServerSDK
           :'tokenize' => :'tokenize',
           :'payment_product_id' => :'paymentProductId',
           :'payment_product840_specific_input' => :'paymentProduct840SpecificInput',
+          :'payment_product900_specific_input' => :'paymentProduct900SpecificInput',
           :'redirection_data' => :'redirectionData'
         }
       end
@@ -52,6 +55,7 @@ module PCPServerSDK
           :'tokenize' => :'Boolean',
           :'payment_product_id' => :'Integer',
           :'payment_product840_specific_input' => :'RedirectPaymentProduct840SpecificInput',
+          :'payment_product900_specific_input' => :'RedirectPaymentProduct900SpecificInput',
           :'redirection_data' => :'RedirectionData'
         }
       end
@@ -101,6 +105,10 @@ module PCPServerSDK
           self.payment_product840_specific_input = attributes[:'payment_product840_specific_input']
         end
 
+        if attributes.key?(:'payment_product900_specific_input')
+          self.payment_product900_specific_input = attributes[:'payment_product900_specific_input']
+        end
+
         if attributes.key?(:'redirection_data')
           self.redirection_data = attributes[:'redirection_data']
         end
@@ -117,6 +125,7 @@ module PCPServerSDK
             tokenize == o.tokenize &&
             payment_product_id == o.payment_product_id &&
             payment_product840_specific_input == o.payment_product840_specific_input &&
+            payment_product900_specific_input == o.payment_product900_specific_input &&
             redirection_data == o.redirection_data
       end
 
@@ -129,7 +138,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].hash
+        [requires_approval, payment_processing_token, reporting_token, tokenize, payment_product_id, payment_product840_specific_input, payment_product900_specific_input, redirection_data].hash
       end
 
       # Builds the object from hash