artikcloud 2.0.0 → 2.0.5

data/lib/artikcloud/models/export_history_response.rb

@@ -1,14 +1,23 @@
 =begin
-ARTIK Cloud API
+#ARTIK Cloud API
+
+#No descripton provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
 
 OpenAPI spec version: 2.0.0
 
 Generated by: https://github.com/swagger-api/swagger-codegen.git
 
-License: MIT
-http://en.wikipedia.org/wiki/MIT_License
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+http://www.apache.org/licenses/LICENSE-2.0
 
-Terms of Service: http://www.samsung.com/global/business/mobile/info/terms-and-conditions.html
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
 
 =end
 
@@ -25,18 +34,14 @@ module ArtikCloud
 
     attr_accessor :total
 
+
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
-        
         :'count' => :'count',
-        
         :'data' => :'data',
-        
         :'offset' => :'offset',
-        
         :'total' => :'total'
-        
       }
     end
 
@@ -47,36 +52,50 @@ module ArtikCloud
         :'data' => :'ExportDataArray',
         :'offset' => :'Integer',
         :'total' => :'Integer'
-        
       }
     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[:'count']
+      if attributes.has_key?(:'count')
         self.count = attributes[:'count']
       end
-      
-      if attributes[:'data']
+
+      if attributes.has_key?(:'data')
         self.data = attributes[:'data']
       end
-      
-      if attributes[:'offset']
+
+      if attributes.has_key?(:'offset')
         self.offset = attributes[:'offset']
       end
-      
-      if attributes[:'total']
+
+      if attributes.has_key?(:'total')
         self.total = attributes[:'total']
       end
-      
+
     end
 
-    # Check equality by comparing each attribute.
+    # 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?
+      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 &&
@@ -87,35 +106,41 @@ module ArtikCloud
     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
       [count, data, offset, total].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
+          # 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
@@ -149,21 +174,25 @@ module ArtikCloud
           end
         end
       else # model
-        _model = ArtikCloud.const_get(type).new
-        _model.build_from_hash(value)
+        temp_model = ArtikCloud.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|
@@ -174,8 +203,10 @@ module ArtikCloud
       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) }
@@ -191,4 +222,5 @@ module ArtikCloud
     end
 
   end
+
 end

data/lib/artikcloud/models/export_normalized_messages_response.rb

@@ -1,14 +1,23 @@
 =begin
-ARTIK Cloud API
+#ARTIK Cloud API
+
+#No descripton provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
 
 OpenAPI spec version: 2.0.0
 
 Generated by: https://github.com/swagger-api/swagger-codegen.git
 
-License: MIT
-http://en.wikipedia.org/wiki/MIT_License
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+http://www.apache.org/licenses/LICENSE-2.0
 
-Terms of Service: http://www.samsung.com/global/business/mobile/info/terms-and-conditions.html
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
 
 =end
 
@@ -43,36 +52,23 @@ module ArtikCloud
 
     attr_accessor :url
 
+
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
-        
         :'csv_headers' => :'csvHeaders',
-        
         :'end_date' => :'endDate',
-        
         :'export_id' => :'exportId',
-        
         :'format' => :'format',
-        
         :'order' => :'order',
-        
         :'sdid' => :'sdid',
-        
         :'sdids' => :'sdids',
-        
         :'start_date' => :'startDate',
-        
         :'stdids' => :'stdids',
-        
         :'trial_id' => :'trialId',
-        
         :'uid' => :'uid',
-        
         :'uids' => :'uids',
-        
         :'url' => :'url'
-        
       }
     end
 
@@ -92,72 +88,86 @@ module ArtikCloud
         :'uid' => :'String',
         :'uids' => :'String',
         :'url' => :'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[:'csvHeaders']
+      if attributes.has_key?(:'csvHeaders')
         self.csv_headers = attributes[:'csvHeaders']
       end
-      
-      if attributes[:'endDate']
+
+      if attributes.has_key?(:'endDate')
         self.end_date = attributes[:'endDate']
       end
-      
-      if attributes[:'exportId']
+
+      if attributes.has_key?(:'exportId')
         self.export_id = attributes[:'exportId']
       end
-      
-      if attributes[:'format']
+
+      if attributes.has_key?(:'format')
         self.format = attributes[:'format']
       end
-      
-      if attributes[:'order']
+
+      if attributes.has_key?(:'order')
         self.order = attributes[:'order']
       end
-      
-      if attributes[:'sdid']
+
+      if attributes.has_key?(:'sdid')
         self.sdid = attributes[:'sdid']
       end
-      
-      if attributes[:'sdids']
+
+      if attributes.has_key?(:'sdids')
         self.sdids = attributes[:'sdids']
       end
-      
-      if attributes[:'startDate']
+
+      if attributes.has_key?(:'startDate')
         self.start_date = attributes[:'startDate']
       end
-      
-      if attributes[:'stdids']
+
+      if attributes.has_key?(:'stdids')
         self.stdids = attributes[:'stdids']
       end
-      
-      if attributes[:'trialId']
+
+      if attributes.has_key?(:'trialId')
         self.trial_id = attributes[:'trialId']
       end
-      
-      if attributes[:'uid']
+
+      if attributes.has_key?(:'uid')
         self.uid = attributes[:'uid']
       end
-      
-      if attributes[:'uids']
+
+      if attributes.has_key?(:'uids')
         self.uids = attributes[:'uids']
       end
-      
-      if attributes[:'url']
+
+      if attributes.has_key?(:'url')
         self.url = attributes[:'url']
       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 &&
@@ -177,35 +187,41 @@ module ArtikCloud
     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
       [csv_headers, end_date, export_id, format, order, sdid, sdids, start_date, stdids, trial_id, uid, uids, url].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
+          # 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
@@ -239,21 +255,25 @@ module ArtikCloud
           end
         end
       else # model
-        _model = ArtikCloud.const_get(type).new
-        _model.build_from_hash(value)
+        temp_model = ArtikCloud.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|
@@ -264,8 +284,10 @@ module ArtikCloud
       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) }
@@ -281,4 +303,5 @@ module ArtikCloud
     end
 
   end
+
 end