pcp-server-ruby-sdk 1.7.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/cancel_payment_request.rb

@@ -73,6 +73,14 @@ module PCPServerSDK
         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 &&
+            cancellation_reason == o.cancellation_reason
+      end
+
       # @see the `==` method
       # @param [Object] Object to be compared
       def eql?(o)

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

@@ -0,0 +1,187 @@
+require 'date'
+require 'time'
+
+# Request to complete an order.
+module PCPServerSDK
+  module Models
+    class CompleteOrderRequest
+      attr_accessor :complete_payment_method_specific_input
+
+      # Attribute mapping from ruby-style variable name to JSON key.
+      def self.attribute_map
+        {
+          :'complete_payment_method_specific_input' => :'completePaymentMethodSpecificInput'
+        }
+      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
+        {
+          :'complete_payment_method_specific_input' => :'CompletePaymentMethodSpecificInput'
+        }
+      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 `CompleteOrderRequest` 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 `CompleteOrderRequest`. 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?(:'complete_payment_method_specific_input')
+          self.complete_payment_method_specific_input = attributes[:'complete_payment_method_specific_input']
+        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 &&
+            complete_payment_method_specific_input == o.complete_payment_method_specific_input
+      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
+        [complete_payment_method_specific_input].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/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/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