artikcloud 2.1.0 → 2.1.1

data/docs/DevicestatusApi.md

@@ -1,183 +0,0 @@
-# ArtikCloud::DevicestatusApi
-
-All URIs are relative to *https://api.artik.cloud/v1.1*
-
-Method | HTTP request | Description
-------------- | ------------- | -------------
-[**get_device_status**](DevicestatusApi.md#get_device_status) | **GET** /devices/{deviceId}/status | Get Device Status
-[**get_devices_status**](DevicestatusApi.md#get_devices_status) | **GET** /devices/status | Get Devices Status
-[**put_device_status**](DevicestatusApi.md#put_device_status) | **PUT** /devices/{deviceId}/status | Update Device Status
-
-
-# **get_device_status**
-> DeviceStatus get_device_status(device_id, opts)
-
-Get Device Status
-
-Get Device Status
-
-### Example
-```ruby
-# load the gem
-require 'artikcloud'
-# setup authorization
-ArtikCloud.configure do |config|
-  # Configure OAuth2 access token for authorization: artikcloud_oauth
-  config.access_token = 'YOUR ACCESS TOKEN'
-end
-
-api_instance = ArtikCloud::DevicestatusApi.new
-
-device_id = "device_id_example" # String | Device ID.
-
-opts = { 
-  include_snapshot: true, # BOOLEAN | Include device snapshot into the response
-  include_snapshot_timestamp: true # BOOLEAN | Include device snapshot timestamp into the response
-}
-
-begin
-  #Get Device Status
-  result = api_instance.get_device_status(device_id, opts)
-  p result
-rescue ArtikCloud::ApiError => e
-  puts "Exception when calling DevicestatusApi->get_device_status: #{e}"
-end
-```
-
-### Parameters
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **device_id** | **String**| Device ID. | 
- **include_snapshot** | **BOOLEAN**| Include device snapshot into the response | [optional] 
- **include_snapshot_timestamp** | **BOOLEAN**| Include device snapshot timestamp into the response | [optional] 
-
-### Return type
-
-[**DeviceStatus**](DeviceStatus.md)
-
-### Authorization
-
-[artikcloud_oauth](../README.md#artikcloud_oauth)
-
-### HTTP request headers
-
- - **Content-Type**: Not defined
- - **Accept**: application/json
-
-
-
-# **get_devices_status**
-> DeviceStatusBatch get_devices_status(dids, opts)
-
-Get Devices Status
-
-Get Devices Status
-
-### Example
-```ruby
-# load the gem
-require 'artikcloud'
-# setup authorization
-ArtikCloud.configure do |config|
-  # Configure OAuth2 access token for authorization: artikcloud_oauth
-  config.access_token = 'YOUR ACCESS TOKEN'
-end
-
-api_instance = ArtikCloud::DevicestatusApi.new
-
-dids = "dids_example" # String | List of device ids (comma-separated) for which the statuses are requested.
-
-opts = { 
-  include_snapshot: true, # BOOLEAN | Include device snapshot into the response
-  include_snapshot_timestamp: true # BOOLEAN | Include device snapshot timestamp into the response
-}
-
-begin
-  #Get Devices Status
-  result = api_instance.get_devices_status(dids, opts)
-  p result
-rescue ArtikCloud::ApiError => e
-  puts "Exception when calling DevicestatusApi->get_devices_status: #{e}"
-end
-```
-
-### Parameters
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **dids** | **String**| List of device ids (comma-separated) for which the statuses are requested. | 
- **include_snapshot** | **BOOLEAN**| Include device snapshot into the response | [optional] 
- **include_snapshot_timestamp** | **BOOLEAN**| Include device snapshot timestamp into the response | [optional] 
-
-### Return type
-
-[**DeviceStatusBatch**](DeviceStatusBatch.md)
-
-### Authorization
-
-[artikcloud_oauth](../README.md#artikcloud_oauth)
-
-### HTTP request headers
-
- - **Content-Type**: Not defined
- - **Accept**: application/json
-
-
-
-# **put_device_status**
-> DeviceStatus put_device_status(device_id, opts)
-
-Update Device Status
-
-Update Device Status
-
-### Example
-```ruby
-# load the gem
-require 'artikcloud'
-# setup authorization
-ArtikCloud.configure do |config|
-  # Configure OAuth2 access token for authorization: artikcloud_oauth
-  config.access_token = 'YOUR ACCESS TOKEN'
-end
-
-api_instance = ArtikCloud::DevicestatusApi.new
-
-device_id = "device_id_example" # String | Device ID.
-
-opts = { 
-  body: ArtikCloud::DeviceStatusPut.new # DeviceStatusPut | Body
-}
-
-begin
-  #Update Device Status
-  result = api_instance.put_device_status(device_id, opts)
-  p result
-rescue ArtikCloud::ApiError => e
-  puts "Exception when calling DevicestatusApi->put_device_status: #{e}"
-end
-```
-
-### Parameters
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **device_id** | **String**| Device ID. | 
- **body** | [**DeviceStatusPut**](DeviceStatusPut.md)| Body | [optional] 
-
-### Return type
-
-[**DeviceStatus**](DeviceStatus.md)
-
-### Authorization
-
-[artikcloud_oauth](../README.md#artikcloud_oauth)
-
-### HTTP request headers
-
- - **Content-Type**: Not defined
- - **Accept**: application/json
-
-
-

data/docs/MetadataRequest.md

@@ -1,7 +0,0 @@
-# ArtikCloud::MetadataRequest
-
-## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-
-

data/lib/artikcloud/models/metadata_request.rb

@@ -1,190 +0,0 @@
-=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 'date'
-
-module ArtikCloud
-  # 
-  class MetadataRequest
-
-    # Attribute mapping from ruby-style variable name to JSON key.
-    def self.attribute_map
-      {
-      }
-    end
-
-    # Attribute type mapping.
-    def self.swagger_types
-      {
-      }
-    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.each_with_object({}){|(k,v), h| h[k.to_sym] = v}
-
-    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
-
-    # Checks equality by comparing each attribute.
-    # @param [Object] Object to be compared
-    def ==(o)
-      return true if self.equal?(o)
-      self.class == o.class
-    end
-
-    # @see the `==` method
-    # @param [Object] Object to be compared
-    def eql?(o)
-      self == o
-    end
-
-    # Calculates hash code according to all attributes.
-    # @return [Fixnum] Hash code
-    def hash
-      [].hash
-    end
-
-    # 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) } )
-          end
-        elsif !attributes[self.class.attribute_map[key]].nil?
-          self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
-        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
-        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 :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/
-        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
-        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_hash (backward compatibility)
-    # @return [Hash] Returns the object in the form of hash
-    def to_body
-      to_hash
-    end
-
-    # 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|
-        value = self.send(attr)
-        next if value.nil?
-        hash[param] = _to_hash(value)
-      end
-      hash
-    end
-
-    # 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) }
-      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
-
-  end
-
-end