artikcloud 2.0.0 → 2.0.5

data/lib/artikcloud/models/web_socket_error.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
 
@@ -26,16 +35,13 @@ module ArtikCloud
     # Confirmation ID
     attr_accessor :cid
 
+
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
-        
         :'message' => :'message',
-        
         :'code' => :'code',
-        
         :'cid' => :'cid'
-        
       }
     end
 
@@ -45,32 +51,46 @@ module ArtikCloud
         :'message' => :'String',
         :'code' => :'Integer',
         :'cid' => :'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[:'message']
+      if attributes.has_key?(:'message')
         self.message = attributes[:'message']
       end
-      
-      if attributes[:'code']
+
+      if attributes.has_key?(:'code')
         self.code = attributes[:'code']
       end
-      
-      if attributes[:'cid']
+
+      if attributes.has_key?(:'cid')
         self.cid = attributes[:'cid']
       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 &&
@@ -80,35 +100,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
       [message, code, cid].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
@@ -142,21 +168,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|
@@ -167,8 +197,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) }
@@ -184,4 +216,5 @@ module ArtikCloud
     end
 
   end
+
 end

data/lib/artikcloud/version.rb

@@ -1,17 +1,26 @@
 =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
 
 module ArtikCloud
-  VERSION = "2.0.0"
+  VERSION = "2.0.5"
 end

data/lib/artikcloud.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
 
@@ -21,10 +30,13 @@ require 'artikcloud/configuration'
 # Models
 require 'artikcloud/models/ack_envelope'
 require 'artikcloud/models/acknowledgement'
+require 'artikcloud/models/action'
+require 'artikcloud/models/action_array'
 require 'artikcloud/models/action_details'
 require 'artikcloud/models/action_details_array'
 require 'artikcloud/models/action_in'
 require 'artikcloud/models/action_out'
+require 'artikcloud/models/actions'
 require 'artikcloud/models/aggregate_data'
 require 'artikcloud/models/aggregates_histogram_data'
 require 'artikcloud/models/aggregates_histogram_response'
@@ -67,15 +79,20 @@ require 'artikcloud/models/manifest_properties'
 require 'artikcloud/models/manifest_properties_envelope'
 require 'artikcloud/models/manifest_versions'
 require 'artikcloud/models/manifest_versions_envelope'
+require 'artikcloud/models/message'
 require 'artikcloud/models/message_action'
 require 'artikcloud/models/message_id'
 require 'artikcloud/models/message_id_envelope'
 require 'artikcloud/models/message_in'
 require 'artikcloud/models/message_out'
 require 'artikcloud/models/non_empty_string'
+require 'artikcloud/models/normalized_action'
+require 'artikcloud/models/normalized_actions_envelope'
 require 'artikcloud/models/normalized_message'
 require 'artikcloud/models/normalized_messages_envelope'
 require 'artikcloud/models/output_rule'
+require 'artikcloud/models/presence_envelope'
+require 'artikcloud/models/presence_model'
 require 'artikcloud/models/properties_envelope'
 require 'artikcloud/models/refresh_token_response'
 require 'artikcloud/models/register_message'
@@ -86,10 +103,15 @@ require 'artikcloud/models/rule_error'
 require 'artikcloud/models/rule_update_info'
 require 'artikcloud/models/rule_warning_output'
 require 'artikcloud/models/rules_envelope'
+require 'artikcloud/models/snapshot_response'
+require 'artikcloud/models/snapshot_responses'
+require 'artikcloud/models/snapshots_response_envelope'
 require 'artikcloud/models/tag'
 require 'artikcloud/models/tag_array'
 require 'artikcloud/models/tags_envelope'
 require 'artikcloud/models/token'
+require 'artikcloud/models/token_info'
+require 'artikcloud/models/token_info_success_response'
 require 'artikcloud/models/token_request'
 require 'artikcloud/models/token_response'
 require 'artikcloud/models/unregister_device_response'

data/spec/api/device_types_api_spec.rb

@@ -0,0 +1,110 @@
+=begin
+#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
+
+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
+
+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
+
+require 'spec_helper'
+require 'json'
+
+# Unit tests for ArtikCloud::DeviceTypesApi
+# Automatically generated by swagger-codegen (github.com/swagger-api/swagger-codegen)
+# Please update as you see appropriate
+describe 'DeviceTypesApi' do
+  before do
+    # run before each test
+    @instance = ArtikCloud::DeviceTypesApi.new
+  end
+
+  after do
+    # run after each test
+  end
+
+  describe 'test an instance of DeviceTypesApi' do
+    it 'should create an instact of DeviceTypesApi' do
+      # expect(@instance).to be_instance_of(ArtikCloud::DeviceTypesApi)
+    end
+  end
+
+  # unit tests for get_available_manifest_versions
+  # Get Available Manifest Versions
+  # Get a Device Type's available manifest versions
+  # @param device_type_id deviceTypeId
+  # @param [Hash] opts the optional parameters
+  # @return [ManifestVersionsEnvelope]
+  describe 'get_available_manifest_versions test' do
+    it "should work" do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for get_device_type
+  # Get Device Type
+  # Retrieves a Device Type
+  # @param device_type_id deviceTypeId
+  # @param [Hash] opts the optional parameters
+  # @return [DeviceTypeEnvelope]
+  describe 'get_device_type test' do
+    it "should work" do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for get_device_types
+  # Get Device Types
+  # Retrieves Device Types
+  # @param name Device Type name
+  # @param [Hash] opts the optional parameters
+  # @option opts [Integer] :offset Offset for pagination.
+  # @option opts [Integer] :count Desired count of items in the result set
+  # @option opts [String] :tags Elements tagged with the list of tags. (comma separated)
+  # @return [DeviceTypesEnvelope]
+  describe 'get_device_types test' do
+    it "should work" do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for get_latest_manifest_properties
+  # Get Latest Manifest Properties
+  # Get a Device Type's manifest properties for the latest version.
+  # @param device_type_id Device Type ID.
+  # @param [Hash] opts the optional parameters
+  # @return [ManifestPropertiesEnvelope]
+  describe 'get_latest_manifest_properties test' do
+    it "should work" do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for get_manifest_properties
+  # Get manifest properties
+  # Get a Device Type's manifest properties for a specific version.
+  # @param device_type_id Device Type ID.
+  # @param version Manifest Version.
+  # @param [Hash] opts the optional parameters
+  # @return [ManifestPropertiesEnvelope]
+  describe 'get_manifest_properties test' do
+    it "should work" do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+end

data/spec/api/devices_api_spec.rb

@@ -0,0 +1,143 @@
+=begin
+#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
+
+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
+
+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
+
+require 'spec_helper'
+require 'json'
+
+# Unit tests for ArtikCloud::DevicesApi
+# Automatically generated by swagger-codegen (github.com/swagger-api/swagger-codegen)
+# Please update as you see appropriate
+describe 'DevicesApi' do
+  before do
+    # run before each test
+    @instance = ArtikCloud::DevicesApi.new
+  end
+
+  after do
+    # run after each test
+  end
+
+  describe 'test an instance of DevicesApi' do
+    it 'should create an instact of DevicesApi' do
+      # expect(@instance).to be_instance_of(ArtikCloud::DevicesApi)
+    end
+  end
+
+  # unit tests for add_device
+  # Add Device
+  # Create a device
+  # @param device Device to be added to the user
+  # @param [Hash] opts the optional parameters
+  # @return [DeviceEnvelope]
+  describe 'add_device test' do
+    it "should work" do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for delete_device
+  # Delete Device
+  # Deletes a device
+  # @param device_id deviceId
+  # @param [Hash] opts the optional parameters
+  # @return [DeviceEnvelope]
+  describe 'delete_device test' do
+    it "should work" do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for delete_device_token
+  # Delete Device Token
+  # Deletes a device's token
+  # @param device_id deviceId
+  # @param [Hash] opts the optional parameters
+  # @return [DeviceTokenEnvelope]
+  describe 'delete_device_token test' do
+    it "should work" do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for get_device
+  # Get Device
+  # Retrieves a device
+  # @param device_id deviceId
+  # @param [Hash] opts the optional parameters
+  # @return [DeviceEnvelope]
+  describe 'get_device test' do
+    it "should work" do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for get_device_presence
+  # Get device presence information
+  # Return the presence status of the given device along with the time it was last seen
+  # @param device_id Device ID.
+  # @param [Hash] opts the optional parameters
+  # @return [PresenceEnvelope]
+  describe 'get_device_presence test' do
+    it "should work" do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for get_device_token
+  # Get Device Token
+  # Retrieves a device's token
+  # @param device_id deviceId
+  # @param [Hash] opts the optional parameters
+  # @return [DeviceTokenEnvelope]
+  describe 'get_device_token test' do
+    it "should work" do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for update_device
+  # Update Device
+  # Updates a device
+  # @param device_id deviceId
+  # @param device Device to be updated
+  # @param [Hash] opts the optional parameters
+  # @return [DeviceEnvelope]
+  describe 'update_device test' do
+    it "should work" do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for update_device_token
+  # Update Device Token
+  # Updates a device's token
+  # @param device_id deviceId
+  # @param [Hash] opts the optional parameters
+  # @return [DeviceTokenEnvelope]
+  describe 'update_device_token test' do
+    it "should work" do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+end

data/spec/api/export_api_spec.rb

@@ -0,0 +1,96 @@
+=begin
+#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
+
+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
+
+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
+
+require 'spec_helper'
+require 'json'
+
+# Unit tests for ArtikCloud::ExportApi
+# Automatically generated by swagger-codegen (github.com/swagger-api/swagger-codegen)
+# Please update as you see appropriate
+describe 'ExportApi' do
+  before do
+    # run before each test
+    @instance = ArtikCloud::ExportApi.new
+  end
+
+  after do
+    # run after each test
+  end
+
+  describe 'test an instance of ExportApi' do
+    it 'should create an instact of ExportApi' do
+      # expect(@instance).to be_instance_of(ArtikCloud::ExportApi)
+    end
+  end
+
+  # unit tests for export_request
+  # Create Export Request
+  # Export normalized messages. The following input combinations are supported:<br/><table><tr><th>Combination</th><th>Parameters</th><th>Description</th></tr><tr><td>Get by users</td><td>uids</td><td>Search by a list of User IDs. For each user in the list, the current authenticated user must have read access over the specified user.</td></tr><tr><td>Get by devices</td><td>sdids</td><td>Search by Source Device IDs.</td></tr><tr><td>Get by device types</td><td>uids,sdtids</td><td>Search by list of Source Device Type IDs for the given list of users.</td></tr><tr><td>Get by trial</td><td>trialId</td><td>Search by Trial ID.</td></tr><tr><td>Get by combination of parameters</td><td>uids,sdids,sdtids</td><td>Search by list of Source Device IDs. Each Device ID must belong to a Source Device Type ID and a User ID.</td></tr><tr><td>Common</td><td>startDate,endDate,order,format,url,csvHeaders</td><td>Parameters that can be used with the above combinations.</td></tr></table>
+  # @param export_request_info ExportRequest object that is passed in the body
+  # @param [Hash] opts the optional parameters
+  # @return [ExportRequestResponse]
+  describe 'export_request test' do
+    it "should work" do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for get_export_history
+  # Get Export History
+  # Get the history of export requests.
+  # @param [Hash] opts the optional parameters
+  # @option opts [String] :trial_id Filter by trialId.
+  # @option opts [Integer] :count Pagination count.
+  # @option opts [Integer] :offset Pagination offset.
+  # @return [ExportHistoryResponse]
+  describe 'get_export_history test' do
+    it "should work" do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for get_export_result
+  # Get Export Result
+  # Retrieve result of the export query in tgz format. The tar file may contain one or more files with the results.
+  # @param export_id Export ID of the export query.
+  # @param [Hash] opts the optional parameters
+  # @return [String]
+  describe 'get_export_result test' do
+    it "should work" do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for get_export_status
+  # Check Export Status
+  # Check status of the export query.
+  # @param export_id Export ID of the export query.
+  # @param [Hash] opts the optional parameters
+  # @return [ExportStatusResponse]
+  describe 'get_export_status test' do
+    it "should work" do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+end