artikcloud 2.0.0

data/docs/Token.md

@@ -0,0 +1,11 @@
+# ArtikCloud::Token
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**access_token** | **String** |  | [optional] 
+**expires_in** | **Integer** |  | [optional] 
+**scope** | **String** |  | [optional] 
+**token_type** | **String** |  | [optional] 
+
+

data/docs/TokenRequest.md

@@ -0,0 +1,8 @@
+# ArtikCloud::TokenRequest
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**token** | **String** |  | [optional] 
+
+

data/docs/TokenResponse.md

@@ -0,0 +1,8 @@
+# ArtikCloud::TokenResponse
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**data** | [**Token**](Token.md) |  | [optional] 
+
+

data/docs/TokensApi.md

@@ -0,0 +1,117 @@
+# ArtikCloud::TokensApi
+
+All URIs are relative to *https://api.artik.cloud/v1.1*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**check_token**](TokensApi.md#check_token) | **POST** /checkToken | Check Token
+[**refresh_token**](TokensApi.md#refresh_token) | **POST** /token | Refresh Token
+
+
+# **check_token**
+> CheckTokenResponse check_token(token_info)
+
+Check Token
+
+Check Token
+
+### 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::TokensApi.new
+
+token_info = ArtikCloud::TokenRequest.new # TokenRequest | Token object to be checked
+
+
+begin
+  #Check Token
+  result = api_instance.check_token(token_info)
+  p result
+rescue ArtikCloud::ApiError => e
+  puts "Exception when calling TokensApi->check_token: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **token_info** | [**TokenRequest**](TokenRequest.md)| Token object to be checked | 
+
+### Return type
+
+[**CheckTokenResponse**](CheckTokenResponse.md)
+
+### Authorization
+
+[artikcloud_oauth](../README.md#artikcloud_oauth)
+
+### HTTP reuqest headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+
+# **refresh_token**
+> RefreshTokenResponse refresh_token(grant_type, refresh_token)
+
+Refresh Token
+
+Refresh Token
+
+### 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::TokensApi.new
+
+grant_type = "grant_type_example" # String | Grant Type.
+
+refresh_token = "refresh_token_example" # String | Refresh Token.
+
+
+begin
+  #Refresh Token
+  result = api_instance.refresh_token(grant_type, refresh_token)
+  p result
+rescue ArtikCloud::ApiError => e
+  puts "Exception when calling TokensApi->refresh_token: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **grant_type** | **String**| Grant Type. | 
+ **refresh_token** | **String**| Refresh Token. | 
+
+### Return type
+
+[**RefreshTokenResponse**](RefreshTokenResponse.md)
+
+### Authorization
+
+[artikcloud_oauth](../README.md#artikcloud_oauth)
+
+### HTTP reuqest headers
+
+ - **Content-Type**: application/x-www-form-urlencoded
+ - **Accept**: application/json
+
+
+

data/docs/UnregisterDeviceResponse.md

@@ -0,0 +1,18 @@
+# ArtikCloud::UnregisterDeviceResponse
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**certificate_info** | **String** | Device certificate information. | [optional] 
+**certificate_signature** | **String** | Certificate's signature. | [optional] 
+**created_on** | **Integer** | Device created on date. | [optional] 
+**dtid** | **String** | Device type id. | [optional] 
+**eid** | **String** | External ID of the device. | [optional] 
+**id** | **String** | Device id. | [optional] 
+**manifest_version** | **Integer** | Device manifest version. | [optional] 
+**manifest_version_policy** | **String** | Device manifest version policy. | [optional] 
+**name** | **String** | Device name. | [optional] 
+**need_provider_auth** | **BOOLEAN** | Device need provider auth. | [optional] 
+**uid** | **String** | User id. | [optional] 
+
+

data/docs/UnregisterDeviceResponseEnvelope.md

@@ -0,0 +1,8 @@
+# ArtikCloud::UnregisterDeviceResponseEnvelope
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**data** | [**UnregisterDeviceResponse**](UnregisterDeviceResponse.md) |  | [optional] 
+
+

data/docs/User.md

@@ -0,0 +1,14 @@
+# ArtikCloud::User
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **String** |  | 
+**name** | **String** |  | 
+**email** | **String** |  | 
+**full_name** | **String** |  | 
+**sa_identity** | **String** |  | [optional] 
+**created_on** | **Integer** |  | 
+**modified_on** | **Integer** |  | 
+
+

data/docs/UserEnvelope.md

@@ -0,0 +1,8 @@
+# ArtikCloud::UserEnvelope
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**data** | [**User**](User.md) |  | 
+
+

data/docs/UsersApi.md

@@ -0,0 +1,474 @@
+# ArtikCloud::UsersApi
+
+All URIs are relative to *https://api.artik.cloud/v1.1*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**create_user_properties**](UsersApi.md#create_user_properties) | **POST** /users/{userId}/properties | Create User Application Properties
+[**delete_user_properties**](UsersApi.md#delete_user_properties) | **DELETE** /users/{userId}/properties | Delete User Application Properties
+[**get_self**](UsersApi.md#get_self) | **GET** /users/self | Get Current User Profile
+[**get_user_device_types**](UsersApi.md#get_user_device_types) | **GET** /users/{userId}/devicetypes | Get User Device Types
+[**get_user_devices**](UsersApi.md#get_user_devices) | **GET** /users/{userId}/devices | Get User Devices
+[**get_user_properties**](UsersApi.md#get_user_properties) | **GET** /users/{userId}/properties | Get User application properties
+[**get_user_rules**](UsersApi.md#get_user_rules) | **GET** /users/{userId}/rules | Get User Rules
+[**update_user_properties**](UsersApi.md#update_user_properties) | **PUT** /users/{userId}/properties | Update User Application Properties
+
+
+# **create_user_properties**
+> PropertiesEnvelope create_user_properties(user_id, properties, opts)
+
+Create User Application Properties
+
+Create application properties for a user
+
+### 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::UsersApi.new
+
+user_id = "user_id_example" # String | User Id
+
+properties = ArtikCloud::AppProperties.new # AppProperties | Properties to be updated
+
+opts = { 
+  aid: "aid_example" # String | Application ID
+}
+
+begin
+  #Create User Application Properties
+  result = api_instance.create_user_properties(user_id, properties, opts)
+  p result
+rescue ArtikCloud::ApiError => e
+  puts "Exception when calling UsersApi->create_user_properties: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **user_id** | **String**| User Id | 
+ **properties** | [**AppProperties**](AppProperties.md)| Properties to be updated | 
+ **aid** | **String**| Application ID | [optional] 
+
+### Return type
+
+[**PropertiesEnvelope**](PropertiesEnvelope.md)
+
+### Authorization
+
+[artikcloud_oauth](../README.md#artikcloud_oauth)
+
+### HTTP reuqest headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **delete_user_properties**
+> PropertiesEnvelope delete_user_properties(user_id, opts)
+
+Delete User Application Properties
+
+Deletes a user's application properties
+
+### 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::UsersApi.new
+
+user_id = "user_id_example" # String | User Id
+
+opts = { 
+  aid: "aid_example" # String | Application ID
+}
+
+begin
+  #Delete User Application Properties
+  result = api_instance.delete_user_properties(user_id, opts)
+  p result
+rescue ArtikCloud::ApiError => e
+  puts "Exception when calling UsersApi->delete_user_properties: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **user_id** | **String**| User Id | 
+ **aid** | **String**| Application ID | [optional] 
+
+### Return type
+
+[**PropertiesEnvelope**](PropertiesEnvelope.md)
+
+### Authorization
+
+[artikcloud_oauth](../README.md#artikcloud_oauth)
+
+### HTTP reuqest headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+
+# **get_self**
+> UserEnvelope get_self
+
+Get Current User Profile
+
+Get's the current user's profile
+
+### 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::UsersApi.new
+
+begin
+  #Get Current User Profile
+  result = api_instance.get_self
+  p result
+rescue ArtikCloud::ApiError => e
+  puts "Exception when calling UsersApi->get_self: #{e}"
+end
+```
+
+### Parameters
+This endpoint does not need any parameter.
+
+### Return type
+
+[**UserEnvelope**](UserEnvelope.md)
+
+### Authorization
+
+[artikcloud_oauth](../README.md#artikcloud_oauth)
+
+### HTTP reuqest headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+
+# **get_user_device_types**
+> DeviceTypesEnvelope get_user_device_types(user_id, opts)
+
+Get User Device Types
+
+Retrieve User's Device Types
+
+### 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::UsersApi.new
+
+user_id = "user_id_example" # String | User ID.
+
+opts = { 
+  offset: 56, # Integer | Offset for pagination.
+  count: 56, # Integer | Desired count of items in the result set
+  include_shared: true # BOOLEAN | Optional. Boolean (true/false) - If false, only return the user's device types. If true, also return device types shared by other users.
+}
+
+begin
+  #Get User Device Types
+  result = api_instance.get_user_device_types(user_id, opts)
+  p result
+rescue ArtikCloud::ApiError => e
+  puts "Exception when calling UsersApi->get_user_device_types: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **user_id** | **String**| User ID. | 
+ **offset** | **Integer**| Offset for pagination. | [optional] 
+ **count** | **Integer**| Desired count of items in the result set | [optional] 
+ **include_shared** | **BOOLEAN**| Optional. Boolean (true/false) - If false, only return the user's device types. If true, also return device types shared by other users. | [optional] 
+
+### Return type
+
+[**DeviceTypesEnvelope**](DeviceTypesEnvelope.md)
+
+### Authorization
+
+[artikcloud_oauth](../README.md#artikcloud_oauth)
+
+### HTTP reuqest headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+
+# **get_user_devices**
+> DevicesEnvelope get_user_devices(user_id, opts)
+
+Get User Devices
+
+Retrieve User's Devices
+
+### 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::UsersApi.new
+
+user_id = "user_id_example" # String | User ID
+
+opts = { 
+  offset: 56, # Integer | Offset for pagination.
+  count: 56, # Integer | Desired count of items in the result set
+  include_properties: true # BOOLEAN | Optional. Boolean (true/false) - If false, only return the user's device types. If true, also return device types shared by other users.
+}
+
+begin
+  #Get User Devices
+  result = api_instance.get_user_devices(user_id, opts)
+  p result
+rescue ArtikCloud::ApiError => e
+  puts "Exception when calling UsersApi->get_user_devices: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **user_id** | **String**| User ID | 
+ **offset** | **Integer**| Offset for pagination. | [optional] 
+ **count** | **Integer**| Desired count of items in the result set | [optional] 
+ **include_properties** | **BOOLEAN**| Optional. Boolean (true/false) - If false, only return the user's device types. If true, also return device types shared by other users. | [optional] 
+
+### Return type
+
+[**DevicesEnvelope**](DevicesEnvelope.md)
+
+### Authorization
+
+[artikcloud_oauth](../README.md#artikcloud_oauth)
+
+### HTTP reuqest headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+
+# **get_user_properties**
+> PropertiesEnvelope get_user_properties(user_id, opts)
+
+Get User application properties
+
+Get application properties of a user
+
+### 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::UsersApi.new
+
+user_id = "user_id_example" # String | User Id
+
+opts = { 
+  aid: "aid_example" # String | Application ID
+}
+
+begin
+  #Get User application properties
+  result = api_instance.get_user_properties(user_id, opts)
+  p result
+rescue ArtikCloud::ApiError => e
+  puts "Exception when calling UsersApi->get_user_properties: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **user_id** | **String**| User Id | 
+ **aid** | **String**| Application ID | [optional] 
+
+### Return type
+
+[**PropertiesEnvelope**](PropertiesEnvelope.md)
+
+### Authorization
+
+[artikcloud_oauth](../README.md#artikcloud_oauth)
+
+### HTTP reuqest headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+
+# **get_user_rules**
+> RulesEnvelope get_user_rules(user_id, opts)
+
+Get User Rules
+
+Retrieve User's Rules
+
+### 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::UsersApi.new
+
+user_id = "user_id_example" # String | User ID.
+
+opts = { 
+  exclude_disabled: true, # BOOLEAN | Exclude disabled rules in the result.
+  other_applications: true, # BOOLEAN | List rules of other applications if current application id has full read access
+  count: 56, # Integer | Desired count of items in the result set.
+  offset: 56 # Integer | Offset for pagination.
+}
+
+begin
+  #Get User Rules
+  result = api_instance.get_user_rules(user_id, opts)
+  p result
+rescue ArtikCloud::ApiError => e
+  puts "Exception when calling UsersApi->get_user_rules: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **user_id** | **String**| User ID. | 
+ **exclude_disabled** | **BOOLEAN**| Exclude disabled rules in the result. | [optional] 
+ **other_applications** | **BOOLEAN**| List rules of other applications if current application id has full read access | [optional] 
+ **count** | [**Integer**](.md)| Desired count of items in the result set. | [optional] 
+ **offset** | [**Integer**](.md)| Offset for pagination. | [optional] 
+
+### Return type
+
+[**RulesEnvelope**](RulesEnvelope.md)
+
+### Authorization
+
+[artikcloud_oauth](../README.md#artikcloud_oauth)
+
+### HTTP reuqest headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+
+# **update_user_properties**
+> PropertiesEnvelope update_user_properties(user_id, properties, opts)
+
+Update User Application Properties
+
+Updates application properties of a user
+
+### 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::UsersApi.new
+
+user_id = "user_id_example" # String | User Id
+
+properties = ArtikCloud::AppProperties.new # AppProperties | Properties to be updated
+
+opts = { 
+  aid: "aid_example" # String | Application ID
+}
+
+begin
+  #Update User Application Properties
+  result = api_instance.update_user_properties(user_id, properties, opts)
+  p result
+rescue ArtikCloud::ApiError => e
+  puts "Exception when calling UsersApi->update_user_properties: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **user_id** | **String**| User Id | 
+ **properties** | [**AppProperties**](AppProperties.md)| Properties to be updated | 
+ **aid** | **String**| Application ID | [optional] 
+
+### Return type
+
+[**PropertiesEnvelope**](PropertiesEnvelope.md)
+
+### Authorization
+
+[artikcloud_oauth](../README.md#artikcloud_oauth)
+
+### HTTP reuqest headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+

data/docs/WebSocketError.md

@@ -0,0 +1,10 @@
+# ArtikCloud::WebSocketError
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**message** | **String** | Message. | [optional] 
+**code** | **Integer** | Code | [optional] 
+**cid** | **String** | Confirmation ID | [optional] 
+
+