artikcloud 2.0.0

data/docs/AggregatesResponse.md

@@ -0,0 +1,13 @@
+# ArtikCloud::AggregatesResponse
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**data** | [**Array<AggregateData>**](AggregateData.md) |  | [optional] 
+**end_date** | **Integer** |  | [optional] 
+**field** | **String** |  | [optional] 
+**sdid** | **String** |  | [optional] 
+**size** | **Integer** |  | [optional] 
+**start_date** | **Integer** |  | [optional] 
+
+

data/docs/AppProperties.md

@@ -0,0 +1,10 @@
+# ArtikCloud::AppProperties
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**uid** | **String** |  | [optional] 
+**aid** | **String** |  | [optional] 
+**properties** | **String** |  | 
+
+

data/docs/CheckTokenMessage.md

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

data/docs/CheckTokenResponse.md

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

data/docs/Device.md

@@ -0,0 +1,21 @@
+# ArtikCloud::Device
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **String** | Device ID | [optional] 
+**uid** | **String** | User ID | [optional] 
+**dtid** | **String** | Device Type ID | [optional] 
+**name** | **String** | Name | [optional] 
+**manifest_version** | **Integer** | Manifest Version | [optional] 
+**manifest_version_policy** | **String** | Manifest Version Policy (LATEST, DEVICE) | [optional] 
+**need_provider_auth** | **BOOLEAN** | Needs Provider Authentication | [optional] 
+**properties** | **Hash<String, Object>** |  | [optional] 
+**created_on** | **Integer** | Created On (milliseconds since epoch) | [optional] 
+**connected** | **BOOLEAN** | Is Connected | [optional] 
+**certificate_info** | **String** | Certificate Info (if any) | [optional] 
+**certificate_signature** | **String** | Certificate Signature (if any) | [optional] 
+**eid** | **String** | External ID (if any) | [optional] 
+**provider_credentials** | **Hash<String, Object>** |  | [optional] 
+
+

data/docs/DeviceArray.md

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

data/docs/DeviceEnvelope.md

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

data/docs/DeviceRegCompleteRequest.md

@@ -0,0 +1,8 @@
+# ArtikCloud::DeviceRegCompleteRequest
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**nonce** | **String** | Nonce obtained from the initial registration request. | [optional] 
+
+

data/docs/DeviceRegConfirmUserRequest.md

@@ -0,0 +1,10 @@
+# ArtikCloud::DeviceRegConfirmUserRequest
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**device_id** | **String** | Device ID. Optional if deviceName is present | [optional] 
+**device_name** | **String** | Device Name. Optional if deviceId is present | [optional] 
+**pin** | **String** | Pin obtained in the registrations call. | [optional] 
+
+

data/docs/DeviceRegConfirmUserResponse.md

@@ -0,0 +1,8 @@
+# ArtikCloud::DeviceRegConfirmUserResponse
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**rid** | **String** | The registration request id. | [optional] 
+
+

data/docs/DeviceRegConfirmUserResponseEnvelope.md

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

data/docs/DeviceRegStatusResponse.md

@@ -0,0 +1,9 @@
+# ArtikCloud::DeviceRegStatusResponse
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**did** | **String** | The created or existing device id. | [optional] 
+**status** | **String** | Status of the ongoing device registration request. | [optional] 
+
+

data/docs/DeviceRegStatusResponseEnvelope.md

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

data/docs/DeviceToken.md

@@ -0,0 +1,11 @@
+# ArtikCloud::DeviceToken
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**access_token** | **String** |  | 
+**uid** | **String** |  | 
+**did** | **String** |  | 
+**cid** | **String** |  | 
+
+

data/docs/DeviceTokenEnvelope.md

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

data/docs/DeviceType.md

@@ -0,0 +1,25 @@
+# ArtikCloud::DeviceType
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **String** | Device Type ID. | [optional] 
+**unique_name** | **String** | Unique Name. | [optional] 
+**latest_version** | **Integer** | Latest Manifest version. | [optional] 
+**last_updated** | **Integer** |  | [optional] 
+**name** | **String** | Name. | [optional] 
+**description** | **String** | Description. | [optional] 
+**uid** | **String** | User ID. | [optional] 
+**oid** | **String** | Organization ID. | [optional] 
+**has_cloud_connector** | **BOOLEAN** | Uses Cloud Connectors SDK | [optional] 
+**approved** | **BOOLEAN** | Approval status. | [optional] 
+**published** | **BOOLEAN** | Published status. | [optional] 
+**protected** | **BOOLEAN** | Protected status. | [optional] 
+**in_store** | **BOOLEAN** | In Store. | [optional] 
+**owned_by_current_user** | **BOOLEAN** | Does the current user own a device of this device type | [optional] 
+**tags** | [**Array<Tag>**](Tag.md) | Tags | [optional] 
+**rsp** | **BOOLEAN** | Require Secure Device Registration (SDR) Protocol. | [optional] 
+**issuer_dn** | **String** | Issuer Distinguished Name (Used in SDR) | [optional] 
+**vid** | **String** | Vendor ID. (Used in SDR) | [optional] 
+
+

data/docs/DeviceTypeArray.md

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

data/docs/DeviceTypeEnvelope.md

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

data/docs/DeviceTypesApi.md

@@ -0,0 +1,284 @@
+# ArtikCloud::DeviceTypesApi
+
+All URIs are relative to *https://api.artik.cloud/v1.1*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**get_available_manifest_versions**](DeviceTypesApi.md#get_available_manifest_versions) | **GET** /devicetypes/{deviceTypeId}/availablemanifestversions | Get Available Manifest Versions
+[**get_device_type**](DeviceTypesApi.md#get_device_type) | **GET** /devicetypes/{deviceTypeId} | Get Device Type
+[**get_device_types**](DeviceTypesApi.md#get_device_types) | **GET** /devicetypes | Get Device Types
+[**get_latest_manifest_properties**](DeviceTypesApi.md#get_latest_manifest_properties) | **GET** /devicetypes/{deviceTypeId}/manifests/latest/properties | Get Latest Manifest Properties
+[**get_manifest_properties**](DeviceTypesApi.md#get_manifest_properties) | **GET** /devicetypes/{deviceTypeId}/manifests/{version}/properties | Get manifest properties
+
+
+# **get_available_manifest_versions**
+> ManifestVersionsEnvelope get_available_manifest_versions(device_type_id)
+
+Get Available Manifest Versions
+
+Get a Device Type's available manifest versions
+
+### 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::DeviceTypesApi.new
+
+device_type_id = "device_type_id_example" # String | deviceTypeId
+
+
+begin
+  #Get Available Manifest Versions
+  result = api_instance.get_available_manifest_versions(device_type_id)
+  p result
+rescue ArtikCloud::ApiError => e
+  puts "Exception when calling DeviceTypesApi->get_available_manifest_versions: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **device_type_id** | **String**| deviceTypeId | 
+
+### Return type
+
+[**ManifestVersionsEnvelope**](ManifestVersionsEnvelope.md)
+
+### Authorization
+
+[artikcloud_oauth](../README.md#artikcloud_oauth)
+
+### HTTP reuqest headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+
+# **get_device_type**
+> DeviceTypeEnvelope get_device_type(device_type_id)
+
+Get Device Type
+
+Retrieves a Device Type
+
+### 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::DeviceTypesApi.new
+
+device_type_id = "device_type_id_example" # String | deviceTypeId
+
+
+begin
+  #Get Device Type
+  result = api_instance.get_device_type(device_type_id)
+  p result
+rescue ArtikCloud::ApiError => e
+  puts "Exception when calling DeviceTypesApi->get_device_type: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **device_type_id** | **String**| deviceTypeId | 
+
+### Return type
+
+[**DeviceTypeEnvelope**](DeviceTypeEnvelope.md)
+
+### Authorization
+
+[artikcloud_oauth](../README.md#artikcloud_oauth)
+
+### HTTP reuqest headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+
+# **get_device_types**
+> DeviceTypesEnvelope get_device_types(name, opts)
+
+Get Device Types
+
+Retrieves 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::DeviceTypesApi.new
+
+name = "name_example" # String | Device Type name
+
+opts = { 
+  offset: 56, # Integer | Offset for pagination.
+  count: 56, # Integer | Desired count of items in the result set
+  tags: "tags_example" # String | Elements tagged with the list of tags. (comma separated)
+}
+
+begin
+  #Get Device Types
+  result = api_instance.get_device_types(name, opts)
+  p result
+rescue ArtikCloud::ApiError => e
+  puts "Exception when calling DeviceTypesApi->get_device_types: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **name** | **String**| Device Type name | 
+ **offset** | **Integer**| Offset for pagination. | [optional] 
+ **count** | **Integer**| Desired count of items in the result set | [optional] 
+ **tags** | **String**| Elements tagged with the list of tags. (comma separated) | [optional] 
+
+### Return type
+
+[**DeviceTypesEnvelope**](DeviceTypesEnvelope.md)
+
+### Authorization
+
+[artikcloud_oauth](../README.md#artikcloud_oauth)
+
+### HTTP reuqest headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+
+# **get_latest_manifest_properties**
+> ManifestPropertiesEnvelope get_latest_manifest_properties(device_type_id)
+
+Get Latest Manifest Properties
+
+Get a Device Type's manifest properties for the latest version.
+
+### 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::DeviceTypesApi.new
+
+device_type_id = "device_type_id_example" # String | Device Type ID.
+
+
+begin
+  #Get Latest Manifest Properties
+  result = api_instance.get_latest_manifest_properties(device_type_id)
+  p result
+rescue ArtikCloud::ApiError => e
+  puts "Exception when calling DeviceTypesApi->get_latest_manifest_properties: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **device_type_id** | **String**| Device Type ID. | 
+
+### Return type
+
+[**ManifestPropertiesEnvelope**](ManifestPropertiesEnvelope.md)
+
+### Authorization
+
+[artikcloud_oauth](../README.md#artikcloud_oauth)
+
+### HTTP reuqest headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+
+# **get_manifest_properties**
+> ManifestPropertiesEnvelope get_manifest_properties(device_type_id, version)
+
+Get manifest properties
+
+Get a Device Type's manifest properties for a specific version.
+
+### 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::DeviceTypesApi.new
+
+device_type_id = "device_type_id_example" # String | Device Type ID.
+
+version = "version_example" # String | Manifest Version.
+
+
+begin
+  #Get manifest properties
+  result = api_instance.get_manifest_properties(device_type_id, version)
+  p result
+rescue ArtikCloud::ApiError => e
+  puts "Exception when calling DeviceTypesApi->get_manifest_properties: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **device_type_id** | **String**| Device Type ID. | 
+ **version** | **String**| Manifest Version. | 
+
+### Return type
+
+[**ManifestPropertiesEnvelope**](ManifestPropertiesEnvelope.md)
+
+### Authorization
+
+[artikcloud_oauth](../README.md#artikcloud_oauth)
+
+### HTTP reuqest headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+

data/docs/DeviceTypesEnvelope.md

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