pcp-server-ruby-sdk 1.0.0 → 1.2.0

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

@@ -1,9 +1,9 @@
-
 require 'date'
 require 'time'
+
 module PCPServerSDK
   module Models
-    # Object containing Capture details. 
+    # Object containing Capture details.
     class CaptureOutput
       attr_accessor :amount_of_money
 
@@ -15,17 +15,20 @@ module PCPServerSDK
       # Payment method identifier used by our payment engine.
       attr_accessor :payment_method
 
+      attr_accessor :payment_instructions
+
       # Attribute mapping from ruby-style variable name to JSON key.
       def self.attribute_map
         {
           :'amount_of_money' => :'amountOfMoney',
           :'merchant_parameters' => :'merchantParameters',
           :'references' => :'references',
-          :'payment_method' => :'paymentMethod'
+          :'payment_method' => :'paymentMethod',
+          :'payment_instructions' => :'paymentInstructions'
         }
       end
 
-      # Returns all the JSON keys this model knows about
+      # Returns all the JSON keys this model knows about.
       def self.acceptable_attributes
         attribute_map.values
       end
@@ -36,24 +39,24 @@ module PCPServerSDK
           :'amount_of_money' => :'AmountOfMoney',
           :'merchant_parameters' => :'String',
           :'references' => :'PaymentReferences',
-          :'payment_method' => :'String'
+          :'payment_method' => :'String',
+          :'payment_instructions' => :'PaymentInstructions'
         }
       end
 
-      # List of attributes with nullable: true
+      # List of attributes with nullable: true.
       def self.openapi_nullable
-        Set.new([
-        ])
+        Set.new([])
       end
 
-      # Initializes the object
-      # @param [Hash] attributes Model attributes in the form of hash
+      # 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 `CaptureOutput` initialize method"
         end
 
-        # check to see if the attribute exists and convert string to symbol for hash key
+        # 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 `CaptureOutput`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
@@ -76,34 +79,39 @@ module PCPServerSDK
         if attributes.key?(:'payment_method')
           self.payment_method = attributes[:'payment_method']
         end
+
+        if attributes.key?(:'payment_instructions')
+          self.payment_instructions = attributes[:'payment_instructions']
+        end
       end
 
       # Checks equality by comparing each attribute.
-      # @param [Object] Object to be compared
+      # @param [Object] Object to be compared.
       def ==(o)
         return true if self.equal?(o)
         self.class == o.class &&
-            amount_of_money == o.amount_of_money &&
-            merchant_parameters == o.merchant_parameters &&
-            references == o.references &&
-            payment_method == o.payment_method
+          amount_of_money == o.amount_of_money &&
+          merchant_parameters == o.merchant_parameters &&
+          references == o.references &&
+          payment_method == o.payment_method &&
+          payment_instructions == o.payment_instructions
       end
 
-      # @see the `==` method
-      # @param [Object] Object to be compared
+      # @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
+      # @return [Integer] Hash code.
       def hash
-        [amount_of_money, merchant_parameters, references, payment_method].hash
+        [amount_of_money, merchant_parameters, references, payment_method, payment_instructions].hash
       end
 
-      # Builds the object from hash
-      # @param [Hash] attributes Model attributes in the form of hash
-      # @return [Object] Returns the model itself
+      # 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)
@@ -112,8 +120,6 @@ module PCPServerSDK
           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
@@ -124,10 +130,10 @@ module PCPServerSDK
         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
+      # 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
@@ -147,7 +153,6 @@ module PCPServerSDK
             false
           end
         when :Object
-          # generic object (usually a Hash), return directly
           value
         when /\AArray<(?<inner_type>.+)>\z/
           inner_type = Regexp.last_match[:inner_type]
@@ -161,26 +166,25 @@ module PCPServerSDK
             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
+      # 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
+      # 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
+      # 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|
@@ -195,10 +199,10 @@ module PCPServerSDK
         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
+      # 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) }

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

@@ -5,7 +5,8 @@ module PCPServerSDK
   module Models
     # Fraud results contained in the CardFraudResults object. 
     class CardFraudResults
-      #  Result of the Address Verification Service checks. Possible values are:   * A - Address (Street) matches, Zip does not   * B - Street address match for international transactions—Postal code not verified due to incompatible  formats   * C - Street address and postal code not verified for international transaction due to incompatible formats   * D - Street address and postal code match for international transaction, cardholder name is incorrect   * E - AVS error   * F - Address does match and five digit ZIP code does match (UK only)   * G - Address information is unavailable; international transaction; non-AVS participant   * H - Billing address and postal code match, cardholder name is incorrect (Amex)   * I - Address information not verified for international transaction   * K - Cardholder name matches (Amex)   * L - Cardholder name and postal code match (Amex)   * M - Cardholder name, street address, and postal code match for international transaction   * N - No Match on Address (Street) or Zip   * O - Cardholder name and address match (Amex)   * P - Postal codes match for international transaction—Street address not verified due to incompatible formats   * Q - Billing address matches, cardholder is incorrect (Amex)   * R - Retry, System unavailable or Timed out   * S - Service not supported by issuer   * U - Address information is unavailable   * W - 9 digit Zip matches, Address (Street) does not   * X - Exact AVS Match   * Y - Address (Street) and 5 digit Zip match   * Z - 5 digit Zip matches, Address (Street) does not   * 0 - No service available
+      # Result of the Address Verification Service checks.
+      # @return [AvsResult]
       attr_accessor :avs_result
 
       # Attribute mapping from ruby-style variable name to JSON key.
@@ -23,7 +24,7 @@ module PCPServerSDK
       # Attribute type mapping.
       def self.openapi_types
         {
-          :'avs_result' => :'String'
+          :'avs_result' => :'AvsResult'
         }
       end
 

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

@@ -5,7 +5,10 @@ module PCPServerSDK
   module Models
     # Object containing data related to recurring.
     class CardRecurrenceDetails
-      # * first = This transaction is the first of a series of recurring transactions * recurring = This transaction is a subsequent transaction in a series of recurring transactions  Note: For any first of a recurring the system will automatically create a token as you will need to use a token for any subsequent recurring transactions. In case a token already exists this is indicated in the response with a value of False for the isNewToken property in the response.
+      # Indicates whether this transaction is the first or a subsequent transaction in a series of recurring transactions.
+      # Note: For any first of a recurring the system will automatically create a token as you will need to use a token for any subsequent recurring transactions. 
+      # In case a token already exists this is indicated in the response with a value of False for the isNewToken property in the response.
+      # @return [RecurringPaymentSequenceIndicator]
       attr_accessor :recurring_payment_sequence_indicator
 
       # Attribute mapping from ruby-style variable name to JSON key.
@@ -23,7 +26,7 @@ module PCPServerSDK
       # Attribute type mapping.
       def self.openapi_types
         {
-          :'recurring_payment_sequence_indicator' => :'String'
+          :'recurring_payment_sequence_indicator' => :'RecurringPaymentSequenceIndicator'
         }
       end
 

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

@@ -17,7 +17,12 @@ module PCPServerSDK
       # Fiscal registration number of the customer or the tax registration number of the company for a business customer. Please find below specifics per country:  * Brazil - Consumer (CPF) with a length of 11 digits  * Brazil - Company (CNPJ) with a length of 14 digits  * Denmark - Consumer (CPR-nummer or personnummer) with a length of 10 digits  * Finland - Consumer (Finnish: henkilötunnus (abbreviated as HETU), Swedish: personbeteckning) with a length of 11 characters  * Norway - Consumer (fødselsnummer) with a length of 11 digits  * Sweden - Consumer (personnummer) with a length of 10 or 12 digits
       attr_accessor :fiscal_number
 
-      # Business relation to the customer. Possible values:         * B2C - Indicates business to consumer * B2B - Indicates business to business  Mandatory for the the following payment methods: * 3390 - PAYONE Secured Invoice * 3391 - PAYONE Secured Installment * 3392 - PAYONE Secured Direct Debit
+      # Business relation to the customer.
+      # Mandatory for the following payment methods:
+      # * 3390 - PAYONE Secured Invoice
+      # * 3391 - PAYONE Secured Installment
+      # * 3392 - PAYONE Secured Direct Debit
+      # @return [BusinessRelation]
       attr_accessor :business_relation
 
       # The locale that the customer should be addressed in (for 3rd parties).   Note: Only the language code is supported.
@@ -25,6 +30,9 @@ module PCPServerSDK
 
       attr_accessor :personal_information
 
+      # Object containing data related to the account the customer has with you.
+      attr_accessor :account
+
       # Attribute mapping from ruby-style variable name to JSON key.
       def self.attribute_map
         {
@@ -35,7 +43,8 @@ module PCPServerSDK
           :'fiscal_number' => :'fiscalNumber',
           :'business_relation' => :'businessRelation',
           :'locale' => :'locale',
-          :'personal_information' => :'personalInformation'
+          :'personal_information' => :'personalInformation',
+          :'account' => :'account'
         }
       end
 
@@ -52,9 +61,10 @@ module PCPServerSDK
           :'billing_address' => :'Address',
           :'contact_details' => :'ContactDetails',
           :'fiscal_number' => :'String',
-          :'business_relation' => :'String',
+          :'business_relation' => :'BusinessRelation',
           :'locale' => :'String',
-          :'personal_information' => :'PersonalInformation'
+          :'personal_information' => :'PersonalInformation',
+          :'account' => :'CustomerAccount'
         }
       end
 
@@ -110,6 +120,10 @@ module PCPServerSDK
         if attributes.key?(:'personal_information')
           self.personal_information = attributes[:'personal_information']
         end
+
+        if attributes.key?(:'account')
+          self.account = attributes[:'account']
+        end
       end
 
       # Checks equality by comparing each attribute.
@@ -124,7 +138,8 @@ module PCPServerSDK
             fiscal_number == o.fiscal_number &&
             business_relation == o.business_relation &&
             locale == o.locale &&
-            personal_information == o.personal_information
+            personal_information == o.personal_information &&
+            account == o.account
       end
 
       # @see the `==` method
@@ -136,7 +151,7 @@ module PCPServerSDK
       # Calculates hash code according to all attributes.
       # @return [Integer] Hash code
       def hash
-        [company_information, merchant_customer_id, billing_address, contact_details, fiscal_number, business_relation, locale, personal_information].hash
+        [company_information, merchant_customer_id, billing_address, contact_details, fiscal_number, business_relation, locale, personal_information, account].hash
       end
 
       # Builds the object from hash

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

@@ -0,0 +1,51 @@
+require 'date'
+require 'time'
+
+module PCPServerSDK
+  module Models
+    # Object containing data related to the account the customer has with you.
+    class CustomerAccount
+      # Creation date and time of the customer account in ISO 8601 format (UTC).
+      attr_accessor :create_date
+
+      # Attribute mapping from ruby-style variable name to JSON key.
+      def self.attribute_map
+        {
+          :'create_date' => :'createDate'
+        }
+      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
+        {
+          :'create_date' => :'Time'
+        }
+      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 `CustomerAccount` 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 `CustomerAccount`. 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?(:'create_date')
+          self.create_date = attributes[:'create_date']
+        end
+      end
+    end
+  end
+end

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

@@ -1,25 +1,27 @@
-
 require 'date'
 require 'time'
 
-# Object containing the specific output details for financing payment methods (Buy Now Pay Later)
 module PCPServerSDK
   module Models
+    # Object containing the specific output details for financing payment methods (Buy Now Pay Later).
     class FinancingPaymentMethodSpecificOutput
-      # Payment product identifier - please check product documentation for a full overview of possible values. Currently supported payment methods * 3390 - PAYONE Secured Invoice * 3391 - PAYONE Secured Installment * 3392 - PAYONE Secured Direct Debit
+      # Payment product identifier.
       attr_accessor :payment_product_id
 
       attr_accessor :payment_product3391_specific_output
 
+      attr_accessor :payment_instructions
+
       # Attribute mapping from ruby-style variable name to JSON key.
       def self.attribute_map
         {
           :'payment_product_id' => :'paymentProductId',
-          :'payment_product3391_specific_output' => :'paymentProduct3391SpecificOutput'
+          :'payment_product3391_specific_output' => :'paymentProduct3391SpecificOutput',
+          :'payment_instructions' => :'paymentInstructions'
         }
       end
 
-      # Returns all the JSON keys this model knows about
+      # Returns all the JSON keys this model knows about.
       def self.acceptable_attributes
         attribute_map.values
       end
@@ -28,24 +30,24 @@ module PCPServerSDK
       def self.openapi_types
         {
           :'payment_product_id' => :'Integer',
-          :'payment_product3391_specific_output' => :'PaymentProduct3391SpecificOutput'
+          :'payment_product3391_specific_output' => :'PaymentProduct3391SpecificOutput',
+          :'payment_instructions' => :'PaymentInstructions'
         }
       end
 
-      # List of attributes with nullable: true
+      # List of attributes with nullable: true.
       def self.openapi_nullable
-        Set.new([
-        ])
+        Set.new([])
       end
 
-      # Initializes the object
-      # @param [Hash] attributes Model attributes in the form of hash
+      # 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 `FinancingPaymentMethodSpecificOutput` initialize method"
         end
 
-        # check to see if the attribute exists and convert string to symbol for hash key
+        # 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 `FinancingPaymentMethodSpecificOutput`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
@@ -60,32 +62,37 @@ module PCPServerSDK
         if attributes.key?(:'payment_product3391_specific_output')
           self.payment_product3391_specific_output = attributes[:'payment_product3391_specific_output']
         end
+
+        if attributes.key?(:'payment_instructions')
+          self.payment_instructions = attributes[:'payment_instructions']
+        end
       end
 
       # Checks equality by comparing each attribute.
-      # @param [Object] Object to be compared
+      # @param [Object] Object to be compared.
       def ==(o)
         return true if self.equal?(o)
         self.class == o.class &&
-            payment_product_id == o.payment_product_id &&
-            payment_product3391_specific_output == o.payment_product3391_specific_output
+          payment_product_id == o.payment_product_id &&
+          payment_product3391_specific_output == o.payment_product3391_specific_output &&
+          payment_instructions == o.payment_instructions
       end
 
-      # @see the `==` method
-      # @param [Object] Object to be compared
+      # @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
+      # @return [Integer] Hash code.
       def hash
-        [payment_product_id, payment_product3391_specific_output].hash
+        [payment_product_id, payment_product3391_specific_output, payment_instructions].hash
       end
 
-      # Builds the object from hash
-      # @param [Hash] attributes Model attributes in the form of hash
-      # @return [Object] Returns the model itself
+      # 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)
@@ -94,8 +101,6 @@ module PCPServerSDK
           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
@@ -106,10 +111,10 @@ module PCPServerSDK
         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
+      # 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
@@ -129,7 +134,6 @@ module PCPServerSDK
             false
           end
         when :Object
-          # generic object (usually a Hash), return directly
           value
         when /\AArray<(?<inner_type>.+)>\z/
           inner_type = Regexp.last_match[:inner_type]
@@ -143,26 +147,25 @@ module PCPServerSDK
             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
+      # 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
+      # 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
+      # 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|
@@ -177,10 +180,10 @@ module PCPServerSDK
         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
+      # 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) }

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

@@ -6,7 +6,8 @@ require 'time'
 module PCPServerSDK
   module Models
     class MerchantAction
-      # Action merchants needs to take in the online payment process. Possible values are:   * REDIRECT - The customer needs to be redirected using the details found in redirectData   * SHOW_FORM - The customer needs to be shown a form with the fields found in formFields. You can submit the data entered by the user in a Complete payment request.   * SHOW_INSTRUCTIONS - The customer needs to be shown payment instruction using the details found in showData. Alternatively the instructions can be rendered by us using the instructionsRenderingData   * SHOW_TRANSACTION_RESULTS - The customer needs to be shown the transaction results using the details found in showData. Alternatively the instructions can be rendered by us using the instructionsRenderingData   * MOBILE_THREEDS_CHALLENGE - The customer needs to complete a challenge as part of the 3D Secure authentication inside your mobile app. The details contained in mobileThreeDSecureChallengeParameters need to be provided to the EMVco certified Mobile SDK as a challengeParameters object.   * CALL_THIRD_PARTY - The merchant needs to call a third party using the data found in thirdPartyData
+      # Action merchants needs to take in the online payment process.
+      # @return [ActionType]
       attr_accessor :action_type
 
       attr_accessor :redirect_data
@@ -27,7 +28,7 @@ module PCPServerSDK
       # Attribute type mapping.
       def self.openapi_types
         {
-          :'action_type' => :'String',
+          :'action_type' => :'ActionType',
           :'redirect_data' => :'RedirectData'
         }
       end