artikcloud 2.0.0

data/docs/PropertiesEnvelope.md

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

data/docs/RefreshTokenResponse.md

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

data/docs/RegisterMessage.md

@@ -0,0 +1,12 @@
+# ArtikCloud::RegisterMessage
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**cid** | **String** | Confirmation ID. | [optional] 
+**authorization** | **String** | Authorization header containing access token (Bearer <access_token>). | [optional] 
+**sdid** | **String** | Source Device ID. | [optional] 
+**ts** | **Integer** | Timestamp (past, present or future). Defaults to current time if not provided. | [optional] 
+**type** | **String** | Type. | [optional] [default to "register"]
+
+

data/docs/RegistrationsApi.md

@@ -0,0 +1,167 @@
+# ArtikCloud::RegistrationsApi
+
+All URIs are relative to *https://api.artik.cloud/v1.1*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**confirm_user**](RegistrationsApi.md#confirm_user) | **PUT** /devices/registrations/pin | Confirm User
+[**get_request_status_for_user**](RegistrationsApi.md#get_request_status_for_user) | **GET** /devices/registrations/{requestId}/status | Get Request Status For User
+[**unregister_device**](RegistrationsApi.md#unregister_device) | **DELETE** /devices/{deviceId}/registrations | Unregister Device
+
+
+# **confirm_user**
+> DeviceRegConfirmUserResponseEnvelope confirm_user(registration_info)
+
+Confirm User
+
+This call updates the registration request issued earlier by associating it with an authenticated user and captures all additional information required to add a new device.
+
+### 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::RegistrationsApi.new
+
+registration_info = ArtikCloud::DeviceRegConfirmUserRequest.new # DeviceRegConfirmUserRequest | Device Registration information.
+
+
+begin
+  #Confirm User
+  result = api_instance.confirm_user(registration_info)
+  p result
+rescue ArtikCloud::ApiError => e
+  puts "Exception when calling RegistrationsApi->confirm_user: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **registration_info** | [**DeviceRegConfirmUserRequest**](DeviceRegConfirmUserRequest.md)| Device Registration information. | 
+
+### Return type
+
+[**DeviceRegConfirmUserResponseEnvelope**](DeviceRegConfirmUserResponseEnvelope.md)
+
+### Authorization
+
+[artikcloud_oauth](../README.md#artikcloud_oauth)
+
+### HTTP reuqest headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+
+# **get_request_status_for_user**
+> DeviceRegStatusResponseEnvelope get_request_status_for_user(request_id)
+
+Get Request Status For User
+
+This call checks the status of the request so users can poll and know when registration is complete.
+
+### 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::RegistrationsApi.new
+
+request_id = "request_id_example" # String | Request ID.
+
+
+begin
+  #Get Request Status For User
+  result = api_instance.get_request_status_for_user(request_id)
+  p result
+rescue ArtikCloud::ApiError => e
+  puts "Exception when calling RegistrationsApi->get_request_status_for_user: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **request_id** | **String**| Request ID. | 
+
+### Return type
+
+[**DeviceRegStatusResponseEnvelope**](DeviceRegStatusResponseEnvelope.md)
+
+### Authorization
+
+[artikcloud_oauth](../README.md#artikcloud_oauth)
+
+### HTTP reuqest headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+
+# **unregister_device**
+> UnregisterDeviceResponseEnvelope unregister_device(device_id)
+
+Unregister Device
+
+This call clears any associations from the secure device registration.
+
+### 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::RegistrationsApi.new
+
+device_id = "device_id_example" # String | Device ID.
+
+
+begin
+  #Unregister Device
+  result = api_instance.unregister_device(device_id)
+  p result
+rescue ArtikCloud::ApiError => e
+  puts "Exception when calling RegistrationsApi->unregister_device: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **device_id** | **String**| Device ID. | 
+
+### Return type
+
+[**UnregisterDeviceResponseEnvelope**](UnregisterDeviceResponseEnvelope.md)
+
+### Authorization
+
+[artikcloud_oauth](../README.md#artikcloud_oauth)
+
+### HTTP reuqest headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+

data/docs/RuleArray.md

@@ -0,0 +1,8 @@
+# ArtikCloud::RuleArray
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**rules** | [**Array<OutputRule>**](OutputRule.md) |  | [optional] 
+
+

data/docs/RuleCreationInfo.md

@@ -0,0 +1,11 @@
+# ArtikCloud::RuleCreationInfo
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**description** | **String** | Description | [optional] 
+**enabled** | **BOOLEAN** | Is Enabled | [optional] 
+**name** | **String** | Name | [optional] 
+**rule** | **Hash<String, Object>** | Rule | [optional] 
+
+

data/docs/RuleEnvelope.md

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

data/docs/RuleError.md

@@ -0,0 +1,11 @@
+# ArtikCloud::RuleError
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**error_code** | **Integer** |  | [optional] 
+**field_path** | [**FieldPath**](FieldPath.md) |  | [optional] 
+**message_args** | **Array<String>** |  | [optional] 
+**message_key** | **String** |  | [optional] 
+
+

data/docs/RuleUpdateInfo.md

@@ -0,0 +1,11 @@
+# ArtikCloud::RuleUpdateInfo
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**description** | **String** | Description | [optional] 
+**enabled** | **BOOLEAN** | Is Enabled | [optional] 
+**name** | **String** | Name | [optional] 
+**rule** | **Hash<String, Object>** | Rule | [optional] 
+
+

data/docs/RuleWarningOutput.md

@@ -0,0 +1,9 @@
+# ArtikCloud::RuleWarningOutput
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**code** | **String** |  | [optional] 
+**message** | **String** |  | [optional] 
+
+

data/docs/RulesApi.md

@@ -0,0 +1,226 @@
+# ArtikCloud::RulesApi
+
+All URIs are relative to *https://api.artik.cloud/v1.1*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**create_rule**](RulesApi.md#create_rule) | **POST** /rules | Create Rule
+[**delete_rule**](RulesApi.md#delete_rule) | **DELETE** /rules/{ruleId} | Delete Rule
+[**get_rule**](RulesApi.md#get_rule) | **GET** /rules/{ruleId} | Get Rule
+[**update_rule**](RulesApi.md#update_rule) | **PUT** /rules/{ruleId} | Update Rule
+
+
+# **create_rule**
+> RuleEnvelope create_rule(rule_info, user_id)
+
+Create Rule
+
+Create a new Rule
+
+### 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::RulesApi.new
+
+rule_info = ArtikCloud::RuleCreationInfo.new # RuleCreationInfo | Rule object that needs to be added
+
+user_id = "user_id_example" # String | User ID
+
+
+begin
+  #Create Rule
+  result = api_instance.create_rule(rule_info, user_id)
+  p result
+rescue ArtikCloud::ApiError => e
+  puts "Exception when calling RulesApi->create_rule: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **rule_info** | [**RuleCreationInfo**](RuleCreationInfo.md)| Rule object that needs to be added | 
+ **user_id** | **String**| User ID | 
+
+### Return type
+
+[**RuleEnvelope**](RuleEnvelope.md)
+
+### Authorization
+
+[artikcloud_oauth](../README.md#artikcloud_oauth)
+
+### HTTP reuqest headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+
+# **delete_rule**
+> RuleEnvelope delete_rule(rule_id)
+
+Delete Rule
+
+Delete a Rule
+
+### 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::RulesApi.new
+
+rule_id = "rule_id_example" # String | Rule ID.
+
+
+begin
+  #Delete Rule
+  result = api_instance.delete_rule(rule_id)
+  p result
+rescue ArtikCloud::ApiError => e
+  puts "Exception when calling RulesApi->delete_rule: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **rule_id** | **String**| Rule ID. | 
+
+### Return type
+
+[**RuleEnvelope**](RuleEnvelope.md)
+
+### Authorization
+
+[artikcloud_oauth](../README.md#artikcloud_oauth)
+
+### HTTP reuqest headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+
+# **get_rule**
+> RuleEnvelope get_rule(rule_id)
+
+Get Rule
+
+Get a rule using the Rule ID
+
+### 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::RulesApi.new
+
+rule_id = "rule_id_example" # String | Rule ID.
+
+
+begin
+  #Get Rule
+  result = api_instance.get_rule(rule_id)
+  p result
+rescue ArtikCloud::ApiError => e
+  puts "Exception when calling RulesApi->get_rule: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **rule_id** | **String**| Rule ID. | 
+
+### Return type
+
+[**RuleEnvelope**](RuleEnvelope.md)
+
+### Authorization
+
+[artikcloud_oauth](../README.md#artikcloud_oauth)
+
+### HTTP reuqest headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+
+# **update_rule**
+> RuleEnvelope update_rule(rule_id, rule_info)
+
+Update Rule
+
+Update an existing Rule
+
+### 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::RulesApi.new
+
+rule_id = "rule_id_example" # String | Rule ID.
+
+rule_info = ArtikCloud::RuleUpdateInfo.new # RuleUpdateInfo | Rule object that needs to be updated
+
+
+begin
+  #Update Rule
+  result = api_instance.update_rule(rule_id, rule_info)
+  p result
+rescue ArtikCloud::ApiError => e
+  puts "Exception when calling RulesApi->update_rule: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **rule_id** | **String**| Rule ID. | 
+ **rule_info** | [**RuleUpdateInfo**](RuleUpdateInfo.md)| Rule object that needs to be updated | 
+
+### Return type
+
+[**RuleEnvelope**](RuleEnvelope.md)
+
+### Authorization
+
+[artikcloud_oauth](../README.md#artikcloud_oauth)
+
+### HTTP reuqest headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+

data/docs/RulesEnvelope.md

@@ -0,0 +1,11 @@
+# ArtikCloud::RulesEnvelope
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**count** | **Integer** |  | [optional] 
+**data** | [**RuleArray**](RuleArray.md) |  | [optional] 
+**offset** | **Integer** |  | [optional] 
+**total** | **Integer** |  | [optional] 
+
+

data/docs/Tag.md

@@ -0,0 +1,9 @@
+# ArtikCloud::Tag
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **String** | Tag Name. | [optional] 
+**is_category** | **BOOLEAN** | Is Category. | [optional] 
+
+

data/docs/TagArray.md

@@ -0,0 +1,8 @@
+# ArtikCloud::TagArray
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**tags** | [**Array<Tag>**](Tag.md) |  | [optional] 
+
+

data/docs/TagsApi.md

@@ -0,0 +1,169 @@
+# ArtikCloud::TagsApi
+
+All URIs are relative to *https://api.artik.cloud/v1.1*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**get_tag_categories**](TagsApi.md#get_tag_categories) | **GET** /tags/categories | Get all categories
+[**get_tag_suggestions**](TagsApi.md#get_tag_suggestions) | **GET** /tags/suggestions | Get tag suggestions
+[**get_tags_by_categories**](TagsApi.md#get_tags_by_categories) | **GET** /tags | Get all tags of categories
+
+
+# **get_tag_categories**
+> TagsEnvelope get_tag_categories
+
+Get all categories
+
+Get all tags marked as categories
+
+### 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::TagsApi.new
+
+begin
+  #Get all categories
+  result = api_instance.get_tag_categories
+  p result
+rescue ArtikCloud::ApiError => e
+  puts "Exception when calling TagsApi->get_tag_categories: #{e}"
+end
+```
+
+### Parameters
+This endpoint does not need any parameter.
+
+### Return type
+
+[**TagsEnvelope**](TagsEnvelope.md)
+
+### Authorization
+
+[artikcloud_oauth](../README.md#artikcloud_oauth)
+
+### HTTP reuqest headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+
+# **get_tag_suggestions**
+> TagsEnvelope get_tag_suggestions(opts)
+
+Get tag suggestions
+
+Get tag suggestions for applications, device types that have been most used with a group of tags.
+
+### 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::TagsApi.new
+
+opts = { 
+  entity_type: "entity_type_example", # String | Entity type name.
+  tags: "tags_example", # String | Comma separated list of tags.
+  name: "name_example", # String | Name of tags used for type ahead.
+  count: 56 # Integer | Number of results to return. Max 10.
+}
+
+begin
+  #Get tag suggestions
+  result = api_instance.get_tag_suggestions(opts)
+  p result
+rescue ArtikCloud::ApiError => e
+  puts "Exception when calling TagsApi->get_tag_suggestions: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **entity_type** | **String**| Entity type name. | [optional] 
+ **tags** | **String**| Comma separated list of tags. | [optional] 
+ **name** | **String**| Name of tags used for type ahead. | [optional] 
+ **count** | [**Integer**](.md)| Number of results to return. Max 10. | [optional] 
+
+### Return type
+
+[**TagsEnvelope**](TagsEnvelope.md)
+
+### Authorization
+
+[artikcloud_oauth](../README.md#artikcloud_oauth)
+
+### HTTP reuqest headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+
+# **get_tags_by_categories**
+> TagsEnvelope get_tags_by_categories(opts)
+
+Get all tags of categories
+
+Get all tags related to the list of categories
+
+### 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::TagsApi.new
+
+opts = { 
+  categories: "categories_example" # String | Comma separated list of categories.
+}
+
+begin
+  #Get all tags of categories
+  result = api_instance.get_tags_by_categories(opts)
+  p result
+rescue ArtikCloud::ApiError => e
+  puts "Exception when calling TagsApi->get_tags_by_categories: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **categories** | **String**| Comma separated list of categories. | [optional] 
+
+### Return type
+
+[**TagsEnvelope**](TagsEnvelope.md)
+
+### Authorization
+
+[artikcloud_oauth](../README.md#artikcloud_oauth)
+
+### HTTP reuqest headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+

data/docs/TagsEnvelope.md

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