square_connect 2.0.0 → 2.0.2.13

data/lib/square_connect/models/list_transactions_request.rb

@@ -1,42 +1,58 @@
 =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
-  # Defines the query parameters that can be included in\na request to the **ListTransactions** endpoint.
+  # Defines the query parameters that can be included in a request to the [ListTransactions](#endpoint-listtransactions) endpoint.
   class ListTransactionsRequest
-    # The beginning of the requested reporting period, in RFC 3339 format.
+    # The beginning of the requested reporting period, in RFC 3339 format.  See [Date ranges](#dateranges) for details on date inclusivity/exclusivity.  Default value: The current time minus one year.
     attr_accessor :begin_time
 
-    # The end of the requested reporting period, in RFC 3339 format.
+    # The end of the requested reporting period, in RFC 3339 format.  See [Date ranges](#dateranges) for details on date inclusivity/exclusivity.  Default value: The current time.
     attr_accessor :end_time
 
-    # The order in which results are listed in the response (`ASC` for\nchronological, `DESC` for reverse-chronological).
+    # The order in which results are listed in the response (`ASC` for oldest first, `DESC` for newest first).  Default value: `DESC`
     attr_accessor :sort_order
 
-    # A pagination cursor to retrieve the next set of results for your\noriginal query to the endpoint.
+    # A pagination cursor returned by a previous call to this endpoint. Provide this to retrieve the next set of results for your original query.  See [Paginating results](#paginatingresults) for more information.
     attr_accessor :cursor
 
+    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
       {
-        
         :'begin_time' => :'begin_time',
-        
         :'end_time' => :'end_time',
-        
         :'sort_order' => :'sort_order',
-        
         :'cursor' => :'cursor'
-        
       }
     end
 
@@ -47,45 +63,62 @@ module SquareConnect
         :'end_time' => :'String',
         :'sort_order' => :'String',
         :'cursor' => :'String'
-        
       }
     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[:'begin_time']
+      if attributes.has_key?(:'begin_time')
         self.begin_time = attributes[:'begin_time']
       end
-      
-      if attributes[:'end_time']
+
+      if attributes.has_key?(:'end_time')
         self.end_time = attributes[:'end_time']
       end
-      
-      if attributes[:'sort_order']
+
+      if attributes.has_key?(:'sort_order')
         self.sort_order = attributes[:'sort_order']
       end
-      
-      if attributes[:'cursor']
+
+      if attributes.has_key?(:'cursor')
         self.cursor = attributes[:'cursor']
       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
+      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?
+      sort_order_validator = EnumAttributeValidator.new('String', ["DESC", "ASC"])
+      return false unless sort_order_validator.valid?(@sort_order)
+      return true
     end
 
     # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] sort_order Object to be assigned
     def sort_order=(sort_order)
-      allowed_values = ["DESC", "ASC"]
-      if sort_order && !allowed_values.include?(sort_order)
-        fail "invalid value for 'sort_order', must be one of #{allowed_values}"
+      validator = EnumAttributeValidator.new('String', ["DESC", "ASC"])
+      unless validator.valid?(sort_order)
+        fail ArgumentError, "invalid value for 'sort_order', must be one of #{validator.allowable_values}."
       end
       @sort_order = sort_order
     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 &&
@@ -96,35 +129,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
       [begin_time, end_time, sort_order, cursor].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
@@ -138,15 +177,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|
@@ -155,21 +197,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|
@@ -180,8 +226,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) }
@@ -197,4 +245,5 @@ module SquareConnect
     end
 
   end
+
 end

data/lib/square_connect/models/list_transactions_response.rb

@@ -1,17 +1,16 @@
 =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
-  # Defines the fields that are included in the response body of\na request to the **ListTransactions** endpoint.\n\nOne of `errors` or `transactions` is present in a given response (never both).
+  # Defines the fields that are included in the response body of a request to the [ListTransactions](#endpoint-listtransactions) endpoint.  One of `errors` or `transactions` is present in a given response (never both).
   class ListTransactionsResponse
     # Any errors that occurred during the request.
     attr_accessor :errors
@@ -19,19 +18,16 @@ module SquareConnect
     # An array of transactions that match your query.
     attr_accessor :transactions
 
-    # A pagination cursor for retrieving the next set of results,\nif any remain.\n\nProvide this value as the `cursor` parameter in a subsequent request\nto the **ListTransactions** endpoint.
+    # A pagination cursor for retrieving the next set of results, if any remain. Provide this value as the `cursor` parameter in a subsequent request to this endpoint.  See [Paginating results](#paginatingresults) for more information.
     attr_accessor :cursor
 
+
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
-        
         :'errors' => :'errors',
-        
         :'transactions' => :'transactions',
-        
         :'cursor' => :'cursor'
-        
       }
     end
 
@@ -41,36 +37,50 @@ module SquareConnect
         :'errors' => :'Array<Error>',
         :'transactions' => :'Array<Transaction>',
         :'cursor' => :'String'
-        
       }
     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[:'errors']
+      if attributes.has_key?(:'errors')
         if (value = attributes[:'errors']).is_a?(Array)
           self.errors = value
         end
       end
-      
-      if attributes[:'transactions']
+
+      if attributes.has_key?(:'transactions')
         if (value = attributes[:'transactions']).is_a?(Array)
           self.transactions = value
         end
       end
-      
-      if attributes[:'cursor']
+
+      if attributes.has_key?(:'cursor')
         self.cursor = attributes[:'cursor']
       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
+      return invalid_properties
     end
 
-    # Check equality by comparing each attribute.
+    # Check to see if the all the properties in the model are valid
+    # @return true if the model is valid
+    def valid?
+      return true
+    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 &&
@@ -80,35 +90,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
       [errors, transactions, cursor].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
@@ -122,15 +138,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|
@@ -139,21 +158,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|
@@ -164,8 +187,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) }
@@ -181,4 +206,5 @@ module SquareConnect
     end
 
   end
+
 end