paypal-server-sdk 0.6.0 → 0.7.0

data/lib/paypal_server_sdk/models/authorization.rb

@@ -51,9 +51,8 @@ module PaypalServerSdk
 
     # The date and time, in [Internet date and time
     # format](https://tools.ietf.org/html/rfc3339#section-5.6). Seconds are
-    # required while fractional seconds are
-    # optional.<blockquote><strong>Note:</strong> The regular expression
-    # provides guidance but does not reject all invalid dates.</blockquote>
+    # required while fractional seconds are optional. Note: The regular
+    # expression provides guidance but does not reject all invalid dates.
     # @return [String]
     attr_accessor :expiration_time
 
@@ -64,17 +63,15 @@ module PaypalServerSdk
 
     # The date and time, in [Internet date and time
     # format](https://tools.ietf.org/html/rfc3339#section-5.6). Seconds are
-    # required while fractional seconds are
-    # optional.<blockquote><strong>Note:</strong> The regular expression
-    # provides guidance but does not reject all invalid dates.</blockquote>
+    # required while fractional seconds are optional. Note: The regular
+    # expression provides guidance but does not reject all invalid dates.
     # @return [String]
     attr_accessor :create_time
 
     # The date and time, in [Internet date and time
     # format](https://tools.ietf.org/html/rfc3339#section-5.6). Seconds are
-    # required while fractional seconds are
-    # optional.<blockquote><strong>Note:</strong> The regular expression
-    # provides guidance but does not reject all invalid dates.</blockquote>
+    # required while fractional seconds are optional. Note: The regular
+    # expression provides guidance but does not reject all invalid dates.
     # @return [String]
     attr_accessor :update_time
 
@@ -188,5 +185,27 @@ module PaypalServerSdk
                         create_time: create_time,
                         update_time: update_time)
     end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} status: #{@status}, status_details: #{@status_details}, id: #{@id}, amount:"\
+      " #{@amount}, invoice_id: #{@invoice_id}, custom_id: #{@custom_id},"\
+      " network_transaction_reference: #{@network_transaction_reference}, seller_protection:"\
+      " #{@seller_protection}, expiration_time: #{@expiration_time}, links: #{@links},"\
+      " create_time: #{@create_time}, update_time: #{@update_time}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} status: #{@status.inspect}, status_details: #{@status_details.inspect}, id:"\
+      " #{@id.inspect}, amount: #{@amount.inspect}, invoice_id: #{@invoice_id.inspect}, custom_id:"\
+      " #{@custom_id.inspect}, network_transaction_reference:"\
+      " #{@network_transaction_reference.inspect}, seller_protection:"\
+      " #{@seller_protection.inspect}, expiration_time: #{@expiration_time.inspect}, links:"\
+      " #{@links.inspect}, create_time: #{@create_time.inspect}, update_time:"\
+      " #{@update_time.inspect}>"
+    end
   end
 end

data/lib/paypal_server_sdk/models/authorization_incomplete_reason.rb

@@ -7,10 +7,10 @@ module PaypalServerSdk
   # The reason why the authorized status is `PENDING`.
   class AuthorizationIncompleteReason
     AUTHORIZATION_INCOMPLETE_REASON = [
-      # TODO: Write general description for PENDING_REVIEW
+      # Authorization is pending manual review.
       PENDING_REVIEW = 'PENDING_REVIEW'.freeze,
 
-      # TODO: Write general description for DECLINED_BY_RISK_FRAUD_FILTERS
+      # Risk Filter set by the payee failed for the transaction.
       DECLINED_BY_RISK_FRAUD_FILTERS = 'DECLINED_BY_RISK_FRAUD_FILTERS'.freeze
     ].freeze
 

data/lib/paypal_server_sdk/models/authorization_status.rb

@@ -7,22 +7,28 @@ module PaypalServerSdk
   # The status for the authorized payment.
   class AuthorizationStatus
     AUTHORIZATION_STATUS = [
-      # TODO: Write general description for CREATED
+      # The authorized payment is created. No captured payments have been made
+      # for this authorized payment.
       CREATED = 'CREATED'.freeze,
 
-      # TODO: Write general description for CAPTURED
+      # The authorized payment has one or more captures against it. The sum of
+      # these captured payments is greater than the amount of the original
+      # authorized payment.
       CAPTURED = 'CAPTURED'.freeze,
 
-      # TODO: Write general description for DENIED
+      # PayPal cannot authorize funds for this authorized payment.
       DENIED = 'DENIED'.freeze,
 
-      # TODO: Write general description for PARTIALLY_CAPTURED
+      # A captured payment was made for the authorized payment for an amount
+      # that is less than the amount of the original authorized payment.
       PARTIALLY_CAPTURED = 'PARTIALLY_CAPTURED'.freeze,
 
-      # TODO: Write general description for VOIDED
+      # The authorized payment was voided. No more captured payments can be made
+      # against this authorized payment.
       VOIDED = 'VOIDED'.freeze,
 
-      # TODO: Write general description for PENDING
+      # The created authorization is in pending state. For more information, see
+      # status.details.
       PENDING = 'PENDING'.freeze
     ].freeze
 

data/lib/paypal_server_sdk/models/authorization_status_details.rb

@@ -46,5 +46,17 @@ module PaypalServerSdk
       # Create object from extracted values.
       AuthorizationStatusDetails.new(reason: reason)
     end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} reason: #{@reason}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} reason: #{@reason.inspect}>"
+    end
   end
 end

data/lib/paypal_server_sdk/models/authorization_status_with_details.rb

@@ -56,5 +56,17 @@ module PaypalServerSdk
       AuthorizationStatusWithDetails.new(status: status,
                                          status_details: status_details)
     end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} status: #{@status}, status_details: #{@status_details}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} status: #{@status.inspect}, status_details: #{@status_details.inspect}>"
+    end
   end
 end

data/lib/paypal_server_sdk/models/authorization_with_additional_data.rb

@@ -53,9 +53,8 @@ module PaypalServerSdk
 
     # The date and time, in [Internet date and time
     # format](https://tools.ietf.org/html/rfc3339#section-5.6). Seconds are
-    # required while fractional seconds are
-    # optional.<blockquote><strong>Note:</strong> The regular expression
-    # provides guidance but does not reject all invalid dates.</blockquote>
+    # required while fractional seconds are optional. Note: The regular
+    # expression provides guidance but does not reject all invalid dates.
     # @return [String]
     attr_accessor :expiration_time
 
@@ -66,17 +65,15 @@ module PaypalServerSdk
 
     # The date and time, in [Internet date and time
     # format](https://tools.ietf.org/html/rfc3339#section-5.6). Seconds are
-    # required while fractional seconds are
-    # optional.<blockquote><strong>Note:</strong> The regular expression
-    # provides guidance but does not reject all invalid dates.</blockquote>
+    # required while fractional seconds are optional. Note: The regular
+    # expression provides guidance but does not reject all invalid dates.
     # @return [String]
     attr_accessor :create_time
 
     # The date and time, in [Internet date and time
     # format](https://tools.ietf.org/html/rfc3339#section-5.6). Seconds are
-    # required while fractional seconds are
-    # optional.<blockquote><strong>Note:</strong> The regular expression
-    # provides guidance but does not reject all invalid dates.</blockquote>
+    # required while fractional seconds are optional. Note: The regular
+    # expression provides guidance but does not reject all invalid dates.
     # @return [String]
     attr_accessor :update_time
 
@@ -201,5 +198,28 @@ module PaypalServerSdk
                                           update_time: update_time,
                                           processor_response: processor_response)
     end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} status: #{@status}, status_details: #{@status_details}, id: #{@id}, amount:"\
+      " #{@amount}, invoice_id: #{@invoice_id}, custom_id: #{@custom_id},"\
+      " network_transaction_reference: #{@network_transaction_reference}, seller_protection:"\
+      " #{@seller_protection}, expiration_time: #{@expiration_time}, links: #{@links},"\
+      " create_time: #{@create_time}, update_time: #{@update_time}, processor_response:"\
+      " #{@processor_response}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} status: #{@status.inspect}, status_details: #{@status_details.inspect}, id:"\
+      " #{@id.inspect}, amount: #{@amount.inspect}, invoice_id: #{@invoice_id.inspect}, custom_id:"\
+      " #{@custom_id.inspect}, network_transaction_reference:"\
+      " #{@network_transaction_reference.inspect}, seller_protection:"\
+      " #{@seller_protection.inspect}, expiration_time: #{@expiration_time.inspect}, links:"\
+      " #{@links.inspect}, create_time: #{@create_time.inspect}, update_time:"\
+      " #{@update_time.inspect}, processor_response: #{@processor_response.inspect}>"
+    end
   end
 end

data/lib/paypal_server_sdk/models/avs_code.rb

@@ -8,77 +8,108 @@ module PaypalServerSdk
   # Express transactions.
   class AvsCode
     AVS_CODE = [
-      # TODO: Write general description for A
-      A = 'A'.freeze,
-
-      # TODO: Write general description for B
-      B = 'B'.freeze,
-
-      # TODO: Write general description for C
-      C = 'C'.freeze,
-
-      # TODO: Write general description for D
-      D = 'D'.freeze,
-
-      # TODO: Write general description for E
-      E = 'E'.freeze,
-
-      # TODO: Write general description for F
-      F = 'F'.freeze,
-
-      # TODO: Write general description for G
-      G = 'G'.freeze,
-
-      # TODO: Write general description for I
-      I = 'I'.freeze,
-
-      # TODO: Write general description for M
-      M = 'M'.freeze,
-
-      # TODO: Write general description for N
-      N = 'N'.freeze,
-
-      # TODO: Write general description for P
-      P = 'P'.freeze,
-
-      # TODO: Write general description for R
-      R = 'R'.freeze,
-
-      # TODO: Write general description for S
-      S = 'S'.freeze,
-
-      # TODO: Write general description for U
-      U = 'U'.freeze,
-
-      # TODO: Write general description for W
-      W = 'W'.freeze,
-
-      # TODO: Write general description for X
-      X = 'X'.freeze,
-
-      # TODO: Write general description for Y
-      Y = 'Y'.freeze,
-
-      # TODO: Write general description for Z
-      Z = 'Z'.freeze,
-
-      # TODO: Write general description for NULL
-      NULL = 'Null'.freeze,
-
-      # TODO: Write general description for ENUM_0
-      ENUM_0 = '0'.freeze,
-
-      # TODO: Write general description for ENUM_1
-      ENUM_1 = '1'.freeze,
-
-      # TODO: Write general description for ENUM_2
-      ENUM_2 = '2'.freeze,
-
-      # TODO: Write general description for ENUM_3
-      ENUM_3 = '3'.freeze,
-
-      # TODO: Write general description for ENUM_4
-      ENUM_4 = '4'.freeze
+      # For Visa, Mastercard, or Discover transactions, the address matches but
+      # the zip code does not match. For American Express transactions, the card
+      # holder address is correct.
+      AVS_A = 'A'.freeze,
+
+      # For Visa, Mastercard, or Discover transactions, the address matches.
+      # International A.
+      AVS_B = 'B'.freeze,
+
+      # For Visa, Mastercard, or Discover transactions, no values match.
+      # International N.
+      AVS_C = 'C'.freeze,
+
+      # For Visa, Mastercard, or Discover transactions, the address and postal
+      # code match. International X.
+      AVS_D = 'D'.freeze,
+
+      # For Visa, Mastercard, or Discover transactions, not allowed for Internet
+      # or phone transactions. For American Express card holder, the name is
+      # incorrect but the address and postal code match.
+      AVS_E = 'E'.freeze,
+
+      # For Visa, Mastercard, or Discover transactions, the address and postal
+      # code match. UK-specific X. For American Express card holder, the name is
+      # incorrect but the address matches.
+      AVS_F = 'F'.freeze,
+
+      # For Visa, Mastercard, or Discover transactions, global is unavailable.
+      # Nothing matches.
+      AVS_G = 'G'.freeze,
+
+      # For Visa, Mastercard, or Discover transactions, international is
+      # unavailable. Not applicable.
+      AVS_I = 'I'.freeze,
+
+      # For Visa, Mastercard, or Discover transactions, the address and postal
+      # code match. For American Express card holder, the name, address, and
+      # postal code match.
+      AVS_M = 'M'.freeze,
+
+      # For Visa, Mastercard, or Discover transactions, nothing matches. For
+      # American Express card holder, the address and postal code are both
+      # incorrect.
+      AVS_N = 'N'.freeze,
+
+      # For Visa, Mastercard, or Discover transactions, postal international Z.
+      # Postal code only.
+      AVS_P = 'P'.freeze,
+
+      # For Visa, Mastercard, or Discover transactions, re-try the request. For
+      # American Express, the system is unavailable.
+      AVS_R = 'R'.freeze,
+
+      # For Visa, Mastercard, Discover, or American Express, the service is not
+      # supported.
+      AVS_S = 'S'.freeze,
+
+      # For Visa, Mastercard, or Discover transactions, the service is
+      # unavailable. For American Express, information is not available. For
+      # Maestro, the address is not checked or the acquirer had no response. The
+      # service is not available.
+      AVS_U = 'U'.freeze,
+
+      # For Visa, Mastercard, or Discover transactions, whole ZIP code. For
+      # American Express, the card holder name, address, and postal code are all
+      # incorrect.
+      AVS_W = 'W'.freeze,
+
+      # For Visa, Mastercard, or Discover transactions, exact match of the
+      # address and the nine-digit ZIP code. For American Express, the card
+      # holder name, address, and postal code are all incorrect.
+      AVS_X = 'X'.freeze,
+
+      # For Visa, Mastercard, or Discover transactions, the address and
+      # five-digit ZIP code match. For American Express, the card holder address
+      # and postal code are both correct.
+      AVS_Y = 'Y'.freeze,
+
+      # For Visa, Mastercard, or Discover transactions, the five-digit ZIP code
+      # matches but no address. For American Express, only the card holder
+      # postal code is correct.
+      AVS_Z = 'Z'.freeze,
+
+      # For Maestro, no AVS response was obtained.
+      AVS_NULL = 'Null'.freeze,
+
+      # For Maestro, all address information matches.
+      AVS_0 = '0'.freeze,
+
+      # For Maestro, none of the address information matches.
+      AVS_1 = '1'.freeze,
+
+      # For Maestro, part of the address information matches.
+      AVS_2 = '2'.freeze,
+
+      # For Maestro, the merchant did not provide AVS information. It was not
+      # processed.
+      AVS_3 = '3'.freeze,
+
+      # For Maestro, the address was not checked or the acquirer had no
+      # response. The service is not available.
+      AVS_4 = '4'.freeze
     ].freeze
 
     def self.validate(value)

data/lib/paypal_server_sdk/models/bancontact_payment_object.rb

@@ -14,11 +14,10 @@ module PaypalServerSdk
     attr_accessor :name
 
     # The [two-character ISO 3166-1 code](/api/rest/reference/country-codes/)
-    # that identifies the country or region.<blockquote><strong>Note:</strong>
-    # The country code for Great Britain is <code>GB</code> and not
-    # <code>UK</code> as used in the top-level domain names for that country.
-    # Use the `C2` country code for China worldwide for comparable uncontrolled
-    # price (CUP) method, bank card, and cross-border transactions.</blockquote>
+    # that identifies the country or region. Note: The country code for Great
+    # Britain is GB and not UK as used in the top-level domain names for that
+    # country. Use the `C2` country code for China worldwide for comparable
+    # uncontrolled price (CUP) method, bank card, and cross-border transactions.
     # @return [String]
     attr_accessor :country_code
 
@@ -91,5 +90,20 @@ module PaypalServerSdk
                                   iban_last_chars: iban_last_chars,
                                   card_last_digits: card_last_digits)
     end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} name: #{@name}, country_code: #{@country_code}, bic: #{@bic},"\
+      " iban_last_chars: #{@iban_last_chars}, card_last_digits: #{@card_last_digits}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} name: #{@name.inspect}, country_code: #{@country_code.inspect}, bic:"\
+      " #{@bic.inspect}, iban_last_chars: #{@iban_last_chars.inspect}, card_last_digits:"\
+      " #{@card_last_digits.inspect}>"
+    end
   end
 end

data/lib/paypal_server_sdk/models/bancontact_payment_request.rb

@@ -14,11 +14,10 @@ module PaypalServerSdk
     attr_accessor :name
 
     # The [two-character ISO 3166-1 code](/api/rest/reference/country-codes/)
-    # that identifies the country or region.<blockquote><strong>Note:</strong>
-    # The country code for Great Britain is <code>GB</code> and not
-    # <code>UK</code> as used in the top-level domain names for that country.
-    # Use the `C2` country code for China worldwide for comparable uncontrolled
-    # price (CUP) method, bank card, and cross-border transactions.</blockquote>
+    # that identifies the country or region. Note: The country code for Great
+    # Britain is GB and not UK as used in the top-level domain names for that
+    # country. Use the `C2` country code for China worldwide for comparable
+    # uncontrolled price (CUP) method, bank card, and cross-border transactions.
     # @return [String]
     attr_accessor :country_code
 
@@ -69,5 +68,19 @@ module PaypalServerSdk
                                    country_code: country_code,
                                    experience_context: experience_context)
     end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} name: #{@name}, country_code: #{@country_code}, experience_context:"\
+      " #{@experience_context}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} name: #{@name.inspect}, country_code: #{@country_code.inspect},"\
+      " experience_context: #{@experience_context.inspect}>"
+    end
   end
 end

data/lib/paypal_server_sdk/models/base_model.rb

@@ -5,6 +5,7 @@
 
 module PaypalServerSdk
   # Base model.
+  # rubocop:disable all
   class BaseModel < CoreLibrary::BaseModel
     # Returns a Hash representation of the current object.
     def to_hash
@@ -15,48 +16,95 @@ module PaypalServerSdk
       instance_variables.each do |name|
         value = instance_variable_get(name)
         name = name[1..]
-        key = self.class.names.key?(name) ? self.class.names[name] : name
-        optional_fields = self.class.optionals
-        nullable_fields = self.class.nullables
-        if value.nil?
-          next unless nullable_fields.include?(name)
-
-          if !optional_fields.include?(name) && !nullable_fields.include?(name)
-            raise ArgumentError,
-                  "`#{name}` cannot be nil in `#{self.class}`. Please specify a valid value."
+        if name == 'additional_properties'
+          additional_properties = process_additional_properties(value, self.class.names)
+          hash.merge!(additional_properties)
+        else
+          key = self.class.names.key?(name) ? self.class.names[name] : name
+          optional_fields = self.class.optionals
+          nullable_fields = self.class.nullables
+          if value.nil?
+            next unless nullable_fields.include?(name)
+
+            if !optional_fields.include?(name) && !nullable_fields.include?(name)
+              raise ArgumentError,
+                    "`#{name}` cannot be nil in `#{self.class}`. Please specify a valid value."
+            end
           end
-        end
 
-        hash[key] = nil
-        unless value.nil?
-          if respond_to?("to_custom_#{name}")
-            if (value.instance_of? Array) || (value.instance_of? Hash)
-              params = [hash, key]
-              hash[key] = send("to_custom_#{name}", *params)
+          hash[key] = nil
+          unless value.nil?
+            if respond_to?("to_custom_#{name}")
+              if (value.instance_of? Array) || (value.instance_of? Hash)
+                params = [hash, key]
+                hash[key] = send("to_custom_#{name}", *params)
+              else
+                hash[key] = send("to_custom_#{name}")
+              end
+            elsif respond_to?("to_union_type_#{name}")
+              hash[key] = send("to_union_type_#{name}")
+            elsif value.instance_of? Array
+              hash[key] = value.map { |v| v.is_a?(BaseModel) ? v.to_hash : v }
+            elsif value.instance_of? Hash
+              hash[key] = {}
+              value.each do |k, v|
+                hash[key][k] = v.is_a?(BaseModel) ? v.to_hash : v
+              end
             else
-              hash[key] = send("to_custom_#{name}")
+              hash[key] = value.is_a?(BaseModel) ? value.to_hash : value
             end
-          elsif respond_to?("to_union_type_#{name}")
-            hash[key] = send("to_union_type_#{name}")
-          elsif value.instance_of? Array
-            hash[key] = value.map { |v| v.is_a?(BaseModel) ? v.to_hash : v }
-          elsif value.instance_of? Hash
-            hash[key] = {}
-            value.each do |k, v|
-              hash[key][k] = v.is_a?(BaseModel) ? v.to_hash : v
-            end
-          else
-            hash[key] = value.is_a?(BaseModel) ? value.to_hash : value
           end
         end
       end
       hash
     end
 
+    # Processes additional properties, ensuring no conflicts with existing properties.
+    def process_additional_properties(additional_properties, existing_prop_names)
+      hash = {}
+      additional_properties.each do |name, value|
+        check_for_conflict(name, existing_prop_names)
+
+        hash[name] = if value.is_a?(Array)
+                       process_array(value)
+                     elsif value.is_a?(Hash)
+                       process_hash(value)
+                     else
+                       process_basic_value(value)
+                     end
+      end
+      hash
+    end
+
+    # Checks if an additional property conflicts with a model's existing property.
+    def check_for_conflict(name, existing_prop_names)
+      return unless existing_prop_names.key?(name)
+
+      raise ArgumentError, "An additional property key, '#{name}' conflicts with one of the model's properties"
+    end
+
+    # Processes an array of values, recursively calling `to_hash` on BaseModel objects.
+    def process_array(value)
+      value.map { |v| v.is_a?(BaseModel) ? v.to_hash : v }
+    end
+
+    # Processes a hash of values, recursively calling `to_hash` on BaseModel objects.
+    def process_hash(value)
+      value.transform_values do |v|
+        v.is_a?(BaseModel) ? v.to_hash : v
+      end
+    end
+
+    # Processes a basic value (non-array, non-hash).
+    def process_basic_value(value)
+      value.is_a?(BaseModel) ? value.to_hash : value
+    end
+
     # Returns a JSON representation of the curent object.
     def to_json(options = {})
       hash = to_hash
       hash.to_json(options)
     end
   end
+  # rubocop:enable all
 end