artikcloud 2.1.1 → 2.2.2

data/docs/DevicesStatusApi.md

@@ -0,0 +1,183 @@
+# ArtikCloud::DevicesStatusApi
+
+All URIs are relative to *https://api.artik.cloud/v1.1*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**get_device_status**](DevicesStatusApi.md#get_device_status) | **GET** /devices/{deviceId}/status | Get Device Status
+[**get_devices_status**](DevicesStatusApi.md#get_devices_status) | **GET** /devices/status | Get Devices Status
+[**put_device_status**](DevicesStatusApi.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::DevicesStatusApi.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 DevicesStatusApi->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::DevicesStatusApi.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 DevicesStatusApi->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::DevicesStatusApi.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 DevicesStatusApi->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/MessageOut.md

@@ -3,6 +3,12 @@
 ## Properties
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
+**data** | **Hash<String, Object>** | Message Payload. | [optional] 
+**cid** | **String** | Confirmation ID. | [optional] 
+**ddid** | **String** | Destination Device ID. | [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 "message"]
 **mid** | **String** | Message ID. | [optional] 
 **uid** | **String** | User ID. | [optional] 
 **sdtid** | **String** | Source Device Type ID. | [optional] 

data/docs/MonetizationApi.md

@@ -0,0 +1,289 @@
+# ArtikCloud::MonetizationApi
+
+All URIs are relative to *https://api.artik.cloud/v1.1*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**create_pricing_tiers**](MonetizationApi.md#create_pricing_tiers) | **POST** /pricing/devicetypes/{dtid}/pricingtiers | Define devicetype's pricing tiers.
+[**get_pricing_tiers**](MonetizationApi.md#get_pricing_tiers) | **GET** /pricing/devices/{did}/pricingtiers | Get a device's pricing tiers
+[**get_the__pricing_tiers**](MonetizationApi.md#get_the__pricing_tiers) | **GET** /pricing/devicetypes/{dtid}/pricingtiers | Get devicetype's pricing tiers.
+[**get_upgrade_path**](MonetizationApi.md#get_upgrade_path) | **GET** /pricing/devices/{did}/revenueshare/upgradepath | Get upgrade path
+[**set_pricing_tier**](MonetizationApi.md#set_pricing_tier) | **PUT** /pricing/devices/{did}/pricingtiers | Set a device's pricing tier
+
+
+# **create_pricing_tiers**
+> DeviceTypePricingTier create_pricing_tiers(dtid, pricing_tier_info)
+
+Define devicetype's pricing tiers.
+
+Define devicetype's pricing tiers.
+
+### 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::MonetizationApi.new
+
+dtid = "dtid_example" # String | DeviceType ID
+
+pricing_tier_info = ArtikCloud::DeviceTypePricingTier.new # DeviceTypePricingTier | Pricing tier info
+
+
+begin
+  #Define devicetype's pricing tiers.
+  result = api_instance.create_pricing_tiers(dtid, pricing_tier_info)
+  p result
+rescue ArtikCloud::ApiError => e
+  puts "Exception when calling MonetizationApi->create_pricing_tiers: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **dtid** | **String**| DeviceType ID | 
+ **pricing_tier_info** | [**DeviceTypePricingTier**](DeviceTypePricingTier.md)| Pricing tier info | 
+
+### Return type
+
+[**DeviceTypePricingTier**](DeviceTypePricingTier.md)
+
+### Authorization
+
+[artikcloud_oauth](../README.md#artikcloud_oauth)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+
+# **get_pricing_tiers**
+> DevicePricingTiersEnvelope get_pricing_tiers(did, opts)
+
+Get a device's pricing tiers
+
+Get a device's pricing tiers
+
+### 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::MonetizationApi.new
+
+did = "did_example" # String | Device ID
+
+opts = { 
+  active: true # BOOLEAN | Filter by active
+}
+
+begin
+  #Get a device's pricing tiers
+  result = api_instance.get_pricing_tiers(did, opts)
+  p result
+rescue ArtikCloud::ApiError => e
+  puts "Exception when calling MonetizationApi->get_pricing_tiers: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **did** | **String**| Device ID | 
+ **active** | **BOOLEAN**| Filter by active | [optional] 
+
+### Return type
+
+[**DevicePricingTiersEnvelope**](DevicePricingTiersEnvelope.md)
+
+### Authorization
+
+[artikcloud_oauth](../README.md#artikcloud_oauth)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+
+# **get_the__pricing_tiers**
+> DeviceTypePricingTiersEnvelope get_the__pricing_tiers(dtid, version)
+
+Get devicetype's pricing tiers.
+
+Get devicetype's pricing tiers.
+
+### 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::MonetizationApi.new
+
+dtid = "dtid_example" # String | DeviceType ID
+
+version = 56 # Integer | Version
+
+
+begin
+  #Get devicetype's pricing tiers.
+  result = api_instance.get_the__pricing_tiers(dtid, version)
+  p result
+rescue ArtikCloud::ApiError => e
+  puts "Exception when calling MonetizationApi->get_the__pricing_tiers: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **dtid** | **String**| DeviceType ID | 
+ **version** | **Integer**| Version | 
+
+### Return type
+
+[**DeviceTypePricingTiersEnvelope**](DeviceTypePricingTiersEnvelope.md)
+
+### Authorization
+
+[artikcloud_oauth](../README.md#artikcloud_oauth)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+
+# **get_upgrade_path**
+> UpgradePathEnvelope get_upgrade_path(did, action)
+
+Get upgrade path
+
+Get upgrade path
+
+### 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::MonetizationApi.new
+
+did = "did_example" # String | Device ID
+
+action = "action_example" # String | Action to perform
+
+
+begin
+  #Get upgrade path
+  result = api_instance.get_upgrade_path(did, action)
+  p result
+rescue ArtikCloud::ApiError => e
+  puts "Exception when calling MonetizationApi->get_upgrade_path: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **did** | **String**| Device ID | 
+ **action** | **String**| Action to perform | 
+
+### Return type
+
+[**UpgradePathEnvelope**](UpgradePathEnvelope.md)
+
+### Authorization
+
+[artikcloud_oauth](../README.md#artikcloud_oauth)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+
+# **set_pricing_tier**
+> DevicePricingTierEnvelope set_pricing_tier(did, pricing_tier)
+
+Set a device's pricing tier
+
+Set a device's pricing tier
+
+### 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::MonetizationApi.new
+
+did = "did_example" # String | Device ID
+
+pricing_tier = ArtikCloud::DevicePricingTierRequest.new # DevicePricingTierRequest | Pricing tier
+
+
+begin
+  #Set a device's pricing tier
+  result = api_instance.set_pricing_tier(did, pricing_tier)
+  p result
+rescue ArtikCloud::ApiError => e
+  puts "Exception when calling MonetizationApi->set_pricing_tier: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **did** | **String**| Device ID | 
+ **pricing_tier** | [**DevicePricingTierRequest**](DevicePricingTierRequest.md)| Pricing tier | 
+
+### Return type
+
+[**DevicePricingTierEnvelope**](DevicePricingTierEnvelope.md)
+
+### Authorization
+
+[artikcloud_oauth](../README.md#artikcloud_oauth)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+

data/docs/OutputRule.md

@@ -17,5 +17,6 @@ Name | Type | Description | Notes
 **rule** | **Hash<String, Object>** |  | [optional] 
 **uid** | **String** |  | [optional] 
 **warning** | [**RuleWarningOutput**](RuleWarningOutput.md) |  | [optional] 
+**owner** | **String** |  | [optional] 
 
 

data/docs/RejectedCSVRow.md

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

data/docs/RejectedCSVRowsEnvelope.md

@@ -0,0 +1,11 @@
+# ArtikCloud::RejectedCSVRowsEnvelope
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**offset** | **Integer** | Page starting position | [optional] 
+**count** | **Integer** | Page size | [optional] 
+**total** | **Integer** | Total number or rejected rows | [optional] 
+**data** | [**Array<RejectedCSVRow>**](RejectedCSVRow.md) | Array of rejected rows | [optional] 
+
+

data/docs/Tier.md

@@ -0,0 +1,17 @@
+# ArtikCloud::Tier
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**modified_on** | **Integer** | Modified On | [optional] 
+**message_limit** | **Integer** | Message Limit | [optional] 
+**cost** | **String** | Cost | [optional] 
+**name** | **String** | Name | [optional] 
+**description** | **String** | Description | [optional] 
+**interval** | **String** | Interval | [optional] 
+**ptid** | **String** | Pricing Tier ID | [optional] 
+**type** | **String** | Type | [optional] 
+**billing_interval** | **String** | Billing Interval | [optional] 
+**created_on** | **Integer** | Created On | [optional] 
+
+

data/docs/UpgradePath.md

@@ -0,0 +1,8 @@
+# ArtikCloud::UpgradePath
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**url** | **String** | Url to display the upgrade path to the user | [optional] 
+
+

data/docs/UpgradePathEnvelope.md

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

data/docs/UpgradePathUserToken.md

@@ -0,0 +1,10 @@
+# ArtikCloud::UpgradePathUserToken
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**uid** | **String** | User ID | [optional] 
+**access_token** | **String** | User token from initial upgrade path request | [optional] 
+**did** | **String** | Device ID | [optional] 
+
+

data/docs/UpgradePathUserTokenEnvelope.md

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

data/docs/UploadIdEnvelope.md

@@ -0,0 +1,8 @@
+# ArtikCloud::UploadIdEnvelope
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**upload_id** | **String** | Id identifying the uploaded CSV. | [optional] 
+
+

data/docs/UploadStatusEnvelope.md

@@ -0,0 +1,8 @@
+# ArtikCloud::UploadStatusEnvelope
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**status** | **String** | The uploaded CSV status, like 'Processing', 'Completed' or 'Failed' | [optional] 
+
+

data/docs/UsersApi.md

@@ -262,7 +262,8 @@ opts = {
   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.
   owner: "owner_example", # String | Return owned and/or shared devices. Default to ALL.
-  include_share_info: true # BOOLEAN | Include share info
+  include_share_info: true, # BOOLEAN | Include share info
+  dtid: "dtid_example" # String | Return only devices of this device type. If empty, assumes all device types allowed by the authorization.
 }
 
 begin
@@ -284,6 +285,7 @@ Name | Type | Description  | Notes
  **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] 
  **owner** | **String**| Return owned and/or shared devices. Default to ALL. | [optional] 
  **include_share_info** | **BOOLEAN**| Include share info | [optional] 
+ **dtid** | **String**| Return only devices of this device type. If empty, assumes all device types allowed by the authorization. | [optional] 
 
 ### Return type
 
@@ -380,7 +382,8 @@ user_id = "user_id_example" # String | User ID.
 opts = { 
   exclude_disabled: true, # BOOLEAN | Exclude disabled rules in the result.
   count: 56, # Integer | Desired count of items in the result set.
-  offset: 56 # Integer | Offset for pagination.
+  offset: 56, # Integer | Offset for pagination.
+  owner: "owner_example" # String | Rule owner
 }
 
 begin
@@ -400,6 +403,7 @@ Name | Type | Description  | Notes
  **exclude_disabled** | **BOOLEAN**| Exclude disabled rules in the result. | [optional] 
  **count** | **Integer**| Desired count of items in the result set. | [optional] 
  **offset** | **Integer**| Offset for pagination. | [optional] 
+ **owner** | **String**| Rule owner | [optional] 
 
 ### Return type
 

data/docs/ValidityPeriod.md

@@ -0,0 +1,9 @@
+# ArtikCloud::ValidityPeriod
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**not_before** | **Integer** | Not before | [optional] 
+**not_after** | **Integer** | Not before | [optional] 
+
+

data/docs/Whitelist.md

@@ -0,0 +1,10 @@
+# ArtikCloud::Whitelist
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**vdid** | **String** | VendorDeviceId | [optional] 
+**did** | **String** | Device ID | [optional] 
+**uploaded_on** | **Integer** | Uploaded on | [optional] 
+
+

data/docs/WhitelistEnvelope.md

@@ -0,0 +1,8 @@
+# ArtikCloud::WhitelistEnvelope
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**data** | **Hash<String, Object>** | Free form JSON object | [optional] 
+
+

data/docs/WhitelistResultEnvelope.md

@@ -0,0 +1,12 @@
+# ArtikCloud::WhitelistResultEnvelope
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**dtid** | **String** | Device type id | [optional] 
+**offset** | **Integer** | Page starting position | [optional] 
+**count** | **Integer** | Page size | [optional] 
+**total** | **Integer** | Total number or whitelist vdids | [optional] 
+**data** | [**Array<Whitelist>**](Whitelist.md) | Array of whitelisted vdids | [optional] 
+
+