artikcloud 2.0.0 → 2.0.5

data/lib/artikcloud/models/normalized_messages_envelope.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
 
@@ -37,30 +46,20 @@ module ArtikCloud
 
     attr_accessor :data
 
+
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
-        
         :'sdids' => :'sdids',
-        
         :'sdid' => :'sdid',
-        
         :'uid' => :'uid',
-        
         :'start_date' => :'startDate',
-        
         :'end_date' => :'endDate',
-        
         :'order' => :'order',
-        
         :'_next' => :'next',
-        
         :'count' => :'count',
-        
         :'size' => :'size',
-        
         :'data' => :'data'
-        
       }
     end
 
@@ -77,62 +76,79 @@ module ArtikCloud
         :'count' => :'Integer',
         :'size' => :'Integer',
         :'data' => :'Array<NormalizedMessage>'
-        
       }
     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[:'sdids']
+      if attributes.has_key?(:'sdids')
         self.sdids = attributes[:'sdids']
       end
-      
-      if attributes[:'sdid']
+
+      if attributes.has_key?(:'sdid')
         self.sdid = attributes[:'sdid']
       end
-      
-      if attributes[:'uid']
+
+      if attributes.has_key?(:'uid')
         self.uid = attributes[:'uid']
       end
-      
-      if attributes[:'startDate']
+
+      if attributes.has_key?(:'startDate')
         self.start_date = attributes[:'startDate']
       end
-      
-      if attributes[:'endDate']
+
+      if attributes.has_key?(:'endDate')
         self.end_date = attributes[:'endDate']
       end
-      
-      if attributes[:'order']
+
+      if attributes.has_key?(:'order')
         self.order = attributes[:'order']
       end
-      
-      if attributes[:'next']
+
+      if attributes.has_key?(:'next')
         self._next = attributes[:'next']
       end
-      
-      if attributes[:'count']
+
+      if attributes.has_key?(:'count')
         self.count = attributes[:'count']
       end
-      
-      if attributes[:'size']
+
+      if attributes.has_key?(:'size')
         self.size = attributes[:'size']
       end
-      
-      if attributes[:'data']
+
+      if attributes.has_key?(:'data')
         if (value = attributes[:'data']).is_a?(Array)
           self.data = value
         end
       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 false if @count.nil?
+      return false if @size.nil?
+      return false if @data.nil?
+      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 &&
@@ -149,35 +165,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
       [sdids, sdid, uid, start_date, end_date, order, _next, count, size, data].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
@@ -211,21 +233,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|
@@ -236,8 +262,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) }
@@ -253,4 +281,5 @@ module ArtikCloud
     end
 
   end
+
 end

data/lib/artikcloud/models/output_rule.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
 
@@ -45,38 +54,24 @@ module ArtikCloud
 
     attr_accessor :warning
 
+
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
-        
         :'aid' => :'aid',
-        
         :'created_on' => :'createdOn',
-        
         :'description' => :'description',
-        
         :'enabled' => :'enabled',
-        
         :'error' => :'error',
-        
         :'id' => :'id',
-        
         :'index' => :'index',
-        
         :'invalidated_on' => :'invalidatedOn',
-        
         :'language_version' => :'languageVersion',
-        
         :'modified_on' => :'modifiedOn',
-        
         :'name' => :'name',
-        
         :'rule' => :'rule',
-        
         :'uid' => :'uid',
-        
         :'warning' => :'warning'
-        
       }
     end
 
@@ -97,78 +92,92 @@ module ArtikCloud
         :'rule' => :'Hash<String, Object>',
         :'uid' => :'String',
         :'warning' => :'RuleWarningOutput'
-        
       }
     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[:'aid']
+      if attributes.has_key?(:'aid')
         self.aid = attributes[:'aid']
       end
-      
-      if attributes[:'createdOn']
+
+      if attributes.has_key?(:'createdOn')
         self.created_on = attributes[:'createdOn']
       end
-      
-      if attributes[:'description']
+
+      if attributes.has_key?(:'description')
         self.description = attributes[:'description']
       end
-      
-      if attributes[:'enabled']
+
+      if attributes.has_key?(:'enabled')
         self.enabled = attributes[:'enabled']
       end
-      
-      if attributes[:'error']
+
+      if attributes.has_key?(:'error')
         self.error = attributes[:'error']
       end
-      
-      if attributes[:'id']
+
+      if attributes.has_key?(:'id')
         self.id = attributes[:'id']
       end
-      
-      if attributes[:'index']
+
+      if attributes.has_key?(:'index')
         self.index = attributes[:'index']
       end
-      
-      if attributes[:'invalidatedOn']
+
+      if attributes.has_key?(:'invalidatedOn')
         self.invalidated_on = attributes[:'invalidatedOn']
       end
-      
-      if attributes[:'languageVersion']
+
+      if attributes.has_key?(:'languageVersion')
         self.language_version = attributes[:'languageVersion']
       end
-      
-      if attributes[:'modifiedOn']
+
+      if attributes.has_key?(:'modifiedOn')
         self.modified_on = attributes[:'modifiedOn']
       end
-      
-      if attributes[:'name']
+
+      if attributes.has_key?(:'name')
         self.name = attributes[:'name']
       end
-      
-      if attributes[:'rule']
+
+      if attributes.has_key?(:'rule')
         if (value = attributes[:'rule']).is_a?(Array)
           self.rule = value
         end
       end
-      
-      if attributes[:'uid']
+
+      if attributes.has_key?(:'uid')
         self.uid = attributes[:'uid']
       end
-      
-      if attributes[:'warning']
+
+      if attributes.has_key?(:'warning')
         self.warning = attributes[:'warning']
       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?
+      return true
     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 &&
@@ -189,35 +198,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
       [aid, created_on, description, enabled, error, id, index, invalidated_on, language_version, modified_on, name, rule, uid, warning].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
@@ -251,21 +266,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|
@@ -276,8 +295,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) }
@@ -293,4 +314,5 @@ module ArtikCloud
     end
 
   end
+
 end