square_connect 2.0.0 → 2.0.2.13

data/lib/square_connect/models/refund.rb

@@ -1,28 +1,27 @@
 =begin
-Square Connect API
+#Square Connect API
 
 OpenAPI spec version: 2.0
 
 Generated by: https://github.com/swagger-api/swagger-codegen.git
 
-
 =end
 
 require 'date'
 
 module SquareConnect
-  # 
+  # Represents a refund processed for a Square transaction.
   class Refund
-    # The unique ID of the refund.
+    # The refund's unique ID.
     attr_accessor :id
 
     # The ID of the refund's associated location.
     attr_accessor :location_id
 
-    # The ID of the transaction refunded.
+    # The ID of the transaction that the refunded tender is part of.
     attr_accessor :transaction_id
 
-    # The ID of the tender refunded.
+    # The ID of the refunded tender.
     attr_accessor :tender_id
 
     # The time when the refund was created, in RFC 3339 format.
@@ -31,37 +30,49 @@ module SquareConnect
     # The reason for the refund being issued.
     attr_accessor :reason
 
-    # The amount of money refunded.
+    # The amount of money refunded to the buyer.
     attr_accessor :amount_money
 
-    # 
+    # The current status of the refund (`PENDING`, `APPROVED`, `REJECTED`, or `FAILED`).
     attr_accessor :status
 
-    # The amount of processing fee refunded.
+    # The amount of Square processing fee money refunded to the *merchant*.
     attr_accessor :processing_fee_money
 
+    class EnumAttributeValidator
+      attr_reader :datatype
+      attr_reader :allowable_values
+
+      def initialize(datatype, allowable_values)
+        @allowable_values = allowable_values.map do |value|
+          case datatype.to_s
+          when /Integer/i
+            value.to_i
+          when /Float/i
+            value.to_f
+          else
+            value
+          end
+        end
+      end
+
+      def valid?(value)
+        !value || allowable_values.include?(value)
+      end
+    end
+
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
-        
         :'id' => :'id',
-        
         :'location_id' => :'location_id',
-        
         :'transaction_id' => :'transaction_id',
-        
         :'tender_id' => :'tender_id',
-        
         :'created_at' => :'created_at',
-        
         :'reason' => :'reason',
-        
         :'amount_money' => :'amount_money',
-        
         :'status' => :'status',
-        
         :'processing_fee_money' => :'processing_fee_money'
-        
       }
     end
 
@@ -77,65 +88,117 @@ module SquareConnect
         :'amount_money' => :'Money',
         :'status' => :'String',
         :'processing_fee_money' => :'Money'
-        
       }
     end
 
+    # Initializes the object
+    # @param [Hash] attributes Model attributes in the form of hash
     def initialize(attributes = {})
       return unless attributes.is_a?(Hash)
 
       # convert string to symbol for hash key
-      attributes = attributes.inject({}){|memo,(k,v)| memo[k.to_sym] = v; memo}
+      attributes = attributes.each_with_object({}){|(k,v), h| h[k.to_sym] = v}
 
-      
-      if attributes[:'id']
+      if attributes.has_key?(:'id')
         self.id = attributes[:'id']
       end
-      
-      if attributes[:'location_id']
+
+      if attributes.has_key?(:'location_id')
         self.location_id = attributes[:'location_id']
       end
-      
-      if attributes[:'transaction_id']
+
+      if attributes.has_key?(:'transaction_id')
         self.transaction_id = attributes[:'transaction_id']
       end
-      
-      if attributes[:'tender_id']
+
+      if attributes.has_key?(:'tender_id')
         self.tender_id = attributes[:'tender_id']
       end
-      
-      if attributes[:'created_at']
+
+      if attributes.has_key?(:'created_at')
         self.created_at = attributes[:'created_at']
       end
-      
-      if attributes[:'reason']
+
+      if attributes.has_key?(:'reason')
         self.reason = attributes[:'reason']
       end
-      
-      if attributes[:'amount_money']
+
+      if attributes.has_key?(:'amount_money')
         self.amount_money = attributes[:'amount_money']
       end
-      
-      if attributes[:'status']
+
+      if attributes.has_key?(:'status')
         self.status = attributes[:'status']
       end
-      
-      if attributes[:'processing_fee_money']
+
+      if attributes.has_key?(:'processing_fee_money')
         self.processing_fee_money = attributes[:'processing_fee_money']
       end
-      
+
+    end
+
+    # Show invalid properties with the reasons. Usually used together with valid?
+    # @return Array for valid properies with the reasons
+    def list_invalid_properties
+      invalid_properties = Array.new
+      if @id.nil?
+        invalid_properties.push("invalid value for 'id', id cannot be nil.")
+      end
+
+      if @location_id.nil?
+        invalid_properties.push("invalid value for 'location_id', location_id cannot be nil.")
+      end
+
+      if @transaction_id.nil?
+        invalid_properties.push("invalid value for 'transaction_id', transaction_id cannot be nil.")
+      end
+
+      if @tender_id.nil?
+        invalid_properties.push("invalid value for 'tender_id', tender_id cannot be nil.")
+      end
+
+      if @reason.nil?
+        invalid_properties.push("invalid value for 'reason', reason cannot be nil.")
+      end
+
+      if @amount_money.nil?
+        invalid_properties.push("invalid value for 'amount_money', amount_money cannot be nil.")
+      end
+
+      if @status.nil?
+        invalid_properties.push("invalid value for 'status', status cannot be nil.")
+      end
+
+      return invalid_properties
+    end
+
+    # Check to see if the all the properties in the model are valid
+    # @return true if the model is valid
+    def valid?
+      return false if @id.nil?
+      return false if @location_id.nil?
+      return false if @transaction_id.nil?
+      return false if @tender_id.nil?
+      return false if @reason.nil?
+      return false if @amount_money.nil?
+      return false if @status.nil?
+      status_validator = EnumAttributeValidator.new('String', ["PENDING", "APPROVED", "REJECTED", "FAILED"])
+      return false unless status_validator.valid?(@status)
+      return true
     end
 
     # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] status Object to be assigned
     def status=(status)
-      allowed_values = ["PENDING", "APPROVED", "REJECTED", "FAILED"]
-      if status && !allowed_values.include?(status)
-        fail "invalid value for 'status', must be one of #{allowed_values}"
+      validator = EnumAttributeValidator.new('String', ["PENDING", "APPROVED", "REJECTED", "FAILED"])
+      unless validator.valid?(status)
+        fail ArgumentError, "invalid value for 'status', must be one of #{validator.allowable_values}."
       end
       @status = status
     end
 
-    # Check equality by comparing each attribute.
+    # Checks equality by comparing each attribute.
+    # @param [Object] Object to be compared
     def ==(o)
       return true if self.equal?(o)
       self.class == o.class &&
@@ -151,35 +214,41 @@ module SquareConnect
     end
 
     # @see the `==` method
+    # @param [Object] Object to be compared
     def eql?(o)
       self == o
     end
 
-    # Calculate hash code according to all attributes.
+    # Calculates hash code according to all attributes.
+    # @return [Fixnum] Hash code
     def hash
       [id, location_id, transaction_id, tender_id, created_at, reason, amount_money, status, processing_fee_money].hash
     end
 
-    # build the object from hash
+    # Builds the object from hash
+    # @param [Hash] attributes Model attributes in the form of hash
+    # @return [Object] Returns the model itself
     def build_from_hash(attributes)
       return nil unless attributes.is_a?(Hash)
       self.class.swagger_types.each_pair do |key, type|
-        if type =~ /^Array<(.*)>/i
+        if type =~ /\AArray<(.*)>/i
+          # check to ensure the input is an array given that the the attribute
+          # is documented as an array but the input is not
           if attributes[self.class.attribute_map[key]].is_a?(Array)
             self.send("#{key}=", attributes[self.class.attribute_map[key]].map{ |v| _deserialize($1, v) } )
-          else
-            #TODO show warning in debug mode
           end
         elsif !attributes[self.class.attribute_map[key]].nil?
           self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
-        else
-          # data not found in attributes(hash), not an issue as the data can be optional
-        end
+        end # or else data not found in attributes(hash), not an issue as the data can be optional
       end
 
       self
     end
 
+    # Deserializes the data based on type
+    # @param string type Data type
+    # @param string value Value to be deserialized
+    # @return [Object] Deserialized data
     def _deserialize(type, value)
       case type.to_sym
       when :DateTime
@@ -193,15 +262,18 @@ module SquareConnect
       when :Float
         value.to_f
       when :BOOLEAN
-        if value.to_s =~ /^(true|t|yes|y|1)$/i
+        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/
+      when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
         k_type = Regexp.last_match[:k_type]
         v_type = Regexp.last_match[:v_type]
         {}.tap do |hash|
@@ -210,21 +282,25 @@ module SquareConnect
           end
         end
       else # model
-        _model = SquareConnect.const_get(type).new
-        _model.build_from_hash(value)
+        temp_model = SquareConnect.const_get(type).new
+        temp_model.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_body (backward compatibility))
+    # 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
 
-    # return 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|
@@ -235,8 +311,10 @@ module SquareConnect
       hash
     end
 
-    # Method to output non-array 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) }
@@ -252,4 +330,5 @@ module SquareConnect
     end
 
   end
+
 end

data/lib/square_connect/models/refund_status.rb

@@ -1,147 +1,21 @@
 =begin
-Square Connect API
+#Square Connect API
 
 OpenAPI spec version: 2.0
 
 Generated by: https://github.com/swagger-api/swagger-codegen.git
 
-
 =end
 
 require 'date'
 
 module SquareConnect
-  # 
   class RefundStatus
-    # Attribute mapping from ruby-style variable name to JSON key.
-    def self.attribute_map
-      {
-        
-      }
-    end
-
-    # Attribute type mapping.
-    def self.swagger_types
-      {
-        
-      }
-    end
-
-    def initialize(attributes = {})
-      return unless attributes.is_a?(Hash)
-
-      # convert string to symbol for hash key
-      attributes = attributes.inject({}){|memo,(k,v)| memo[k.to_sym] = v; memo}
-
-      
-    end
-
-    # Check equality by comparing each attribute.
-    def ==(o)
-      return true if self.equal?(o)
-      self.class == o.class
-    end
-
-    # @see the `==` method
-    def eql?(o)
-      self == o
-    end
-
-    # Calculate hash code according to all attributes.
-    def hash
-      [].hash
-    end
-
-    # build the object from hash
-    def build_from_hash(attributes)
-      return nil unless attributes.is_a?(Hash)
-      self.class.swagger_types.each_pair do |key, type|
-        if type =~ /^Array<(.*)>/i
-          if attributes[self.class.attribute_map[key]].is_a?(Array)
-            self.send("#{key}=", attributes[self.class.attribute_map[key]].map{ |v| _deserialize($1, v) } )
-          else
-            #TODO show warning in debug mode
-          end
-        elsif !attributes[self.class.attribute_map[key]].nil?
-          self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
-        else
-          # data not found in attributes(hash), not an issue as the data can be optional
-        end
-      end
-
-      self
-    end
-
-    def _deserialize(type, value)
-      case type.to_sym
-      when :DateTime
-        DateTime.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 =~ /^(true|t|yes|y|1)$/i
-          true
-        else
-          false
-        end
-      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
-        _model = SquareConnect.const_get(type).new
-        _model.build_from_hash(value)
-      end
-    end
-
-    def to_s
-      to_hash.to_s
-    end
-
-    # to_body is an alias to to_body (backward compatibility))
-    def to_body
-      to_hash
-    end
-
-    # return the object in the form of hash
-    def to_hash
-      hash = {}
-      self.class.attribute_map.each_pair do |attr, param|
-        value = self.send(attr)
-        next if value.nil?
-        hash[param] = _to_hash(value)
-      end
-      hash
-    end
-
-    # Method to output non-array value in the form of hash
-    # For object, use to_hash. Otherwise, just return the value
-    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
-
+    
+    PENDING = "PENDING".freeze
+    APPROVED = "APPROVED".freeze
+    REJECTED = "REJECTED".freeze
+    FAILED = "FAILED".freeze
   end
+
 end