artikcloud 2.0.8 → 2.1.0

data/docs/DevicestatusApi.md

@@ -0,0 +1,183 @@
+# 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/NotifMessage.md

@@ -0,0 +1,15 @@
+# ArtikCloud::NotifMessage
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**uid** | **String** |  | [optional] 
+**cts** | **Integer** |  | [optional] 
+**data** | **Hash<String, Object>** |  | [optional] 
+**mid** | **String** |  | [optional] 
+**sdid** | **String** |  | [optional] 
+**mv** | **String** |  | [optional] 
+**sdtid** | **String** |  | [optional] 
+**ts** | **Integer** |  | [optional] 
+
+

data/docs/NotifMessageArray.md

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

data/docs/NotifMessagesResponse.md

@@ -0,0 +1,12 @@
+# ArtikCloud::NotifMessagesResponse
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**total** | **Integer** |  | [optional] 
+**offset** | **Integer** |  | [optional] 
+**data** | [**NotifMessageArray**](NotifMessageArray.md) |  | [optional] 
+**count** | **Integer** |  | [optional] 
+**order** | **String** |  | [optional] 
+
+

data/docs/Subscription.md

@@ -0,0 +1,24 @@
+# ArtikCloud::Subscription
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**aws_region** | **String** | AWS region (if subscriptionType is awsKinesis | [optional] 
+**include_shared_devices** | **BOOLEAN** | Include Shared Devices | [optional] 
+**description** | **String** | Description | [optional] 
+**aws_key** | **String** | AWS key (if subscriptionType is awsKinesis | [optional] 
+**aws_secret** | **String** | AWS secret (if subscriptionType is awsKinesis | [optional] 
+**created_on** | **Integer** | Creation timestamp | [optional] 
+**aws_kinesis_stream_name** | **String** | AWS Kinesis stream name (if subscriptionType is awsKinesis | [optional] 
+**uid** | **String** | User ID | [optional] 
+**message_type** | **String** | Message type | [optional] 
+**ddid** | **String** | Destination device ID | [optional] 
+**subscription_type** | **String** | Subscription type (either httpCallback or awsKinesis, default to httpCallback) | [optional] 
+**name** | **String** | Name | [optional] 
+**sdid** | **String** | Source device ID | [optional] 
+**callback_url** | **String** | Callback URL | [optional] 
+**id** | **String** | Subscription ID | [optional] 
+**aid** | **String** | Application ID | [optional] 
+**sdtid** | **String** | Source device type ID | [optional] 
+
+

data/docs/SubscriptionArray.md

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

data/docs/SubscriptionEnvelope.md

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

data/docs/SubscriptionInfo.md

@@ -0,0 +1,20 @@
+# ArtikCloud::SubscriptionInfo
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**aws_region** | **String** | AWS region (if subscriptionType is awsKinesis | [optional] 
+**description** | **String** | Description | [optional] 
+**aws_key** | **String** | AWS key (if subscriptionType is awsKinesis | [optional] 
+**aws_secret** | **String** | AWS secret (if subscriptionType is awsKinesis | [optional] 
+**aws_kinesis_stream_name** | **String** | AWS Kinesis stream name (if subscriptionType is awsKinesis | [optional] 
+**uid** | **String** | User ID | [optional] 
+**message_type** | **String** | Message type | [optional] 
+**ddid** | **String** | Destination device ID | [optional] 
+**subscription_type** | **String** | Subscription type (either httpCallback or awsKinesis, default to httpCallback) | [optional] 
+**name** | **String** | Name | [optional] 
+**sdid** | **String** | Source device ID | [optional] 
+**callback_url** | **String** | Callback URL | [optional] 
+**sdtid** | **String** | Source device type ID | [optional] 
+
+

data/docs/SubscriptionsApi.md

@@ -0,0 +1,342 @@
+# ArtikCloud::SubscriptionsApi
+
+All URIs are relative to *https://api.artik.cloud/v1.1*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**create_subscription**](SubscriptionsApi.md#create_subscription) | **POST** /subscriptions | Create Subscription
+[**delete_subscription**](SubscriptionsApi.md#delete_subscription) | **DELETE** /subscriptions/{subId} | Delete Subscription
+[**get_all_subscriptions**](SubscriptionsApi.md#get_all_subscriptions) | **GET** /subscriptions | Get All Subscriptions
+[**get_messages**](SubscriptionsApi.md#get_messages) | **GET** /notifications/{notifId}/messages | Get Messages
+[**get_subscription**](SubscriptionsApi.md#get_subscription) | **GET** /subscriptions/{subId} | Get Subscription
+[**validate_subscription**](SubscriptionsApi.md#validate_subscription) | **POST** /subscriptions/{subId}/validate | Validate Subscription
+
+
+# **create_subscription**
+> SubscriptionEnvelope create_subscription(subscription_info)
+
+Create Subscription
+
+Create Subscription
+
+### 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::SubscriptionsApi.new
+
+subscription_info = ArtikCloud::SubscriptionInfo.new # SubscriptionInfo | Subscription details
+
+
+begin
+  #Create Subscription
+  result = api_instance.create_subscription(subscription_info)
+  p result
+rescue ArtikCloud::ApiError => e
+  puts "Exception when calling SubscriptionsApi->create_subscription: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **subscription_info** | [**SubscriptionInfo**](SubscriptionInfo.md)| Subscription details | 
+
+### Return type
+
+[**SubscriptionEnvelope**](SubscriptionEnvelope.md)
+
+### Authorization
+
+[artikcloud_oauth](../README.md#artikcloud_oauth)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+
+# **delete_subscription**
+> SubscriptionEnvelope delete_subscription(sub_id)
+
+Delete Subscription
+
+Delete Subscription
+
+### 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::SubscriptionsApi.new
+
+sub_id = "sub_id_example" # String | Subscription ID.
+
+
+begin
+  #Delete Subscription
+  result = api_instance.delete_subscription(sub_id)
+  p result
+rescue ArtikCloud::ApiError => e
+  puts "Exception when calling SubscriptionsApi->delete_subscription: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **sub_id** | **String**| Subscription ID. | 
+
+### Return type
+
+[**SubscriptionEnvelope**](SubscriptionEnvelope.md)
+
+### Authorization
+
+[artikcloud_oauth](../README.md#artikcloud_oauth)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+
+# **get_all_subscriptions**
+> SubscriptionsEnvelope get_all_subscriptions(opts)
+
+Get All Subscriptions
+
+Get All Subscriptions
+
+### 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::SubscriptionsApi.new
+
+opts = { 
+  uid: "uid_example", # String | User ID
+  offset: 56, # Integer | Offset for pagination.
+  count: 56 # Integer | Desired count of items in the result set.
+}
+
+begin
+  #Get All Subscriptions
+  result = api_instance.get_all_subscriptions(opts)
+  p result
+rescue ArtikCloud::ApiError => e
+  puts "Exception when calling SubscriptionsApi->get_all_subscriptions: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **uid** | **String**| User ID | [optional] 
+ **offset** | **Integer**| Offset for pagination. | [optional] 
+ **count** | **Integer**| Desired count of items in the result set. | [optional] 
+
+### Return type
+
+[**SubscriptionsEnvelope**](SubscriptionsEnvelope.md)
+
+### Authorization
+
+[artikcloud_oauth](../README.md#artikcloud_oauth)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+
+# **get_messages**
+> NotifMessagesResponse get_messages(notif_id, opts)
+
+Get Messages
+
+Get Messages
+
+### 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::SubscriptionsApi.new
+
+notif_id = "notif_id_example" # String | Notification ID.
+
+opts = { 
+  offset: 56, # Integer | Offset for pagination.
+  count: 56, # Integer | Desired count of items in the result set.
+  order: "order_example" # String | Sort order of results by ts. Either 'asc' or 'desc'.
+}
+
+begin
+  #Get Messages
+  result = api_instance.get_messages(notif_id, opts)
+  p result
+rescue ArtikCloud::ApiError => e
+  puts "Exception when calling SubscriptionsApi->get_messages: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **notif_id** | **String**| Notification ID. | 
+ **offset** | **Integer**| Offset for pagination. | [optional] 
+ **count** | **Integer**| Desired count of items in the result set. | [optional] 
+ **order** | **String**| Sort order of results by ts. Either 'asc' or 'desc'. | [optional] 
+
+### Return type
+
+[**NotifMessagesResponse**](NotifMessagesResponse.md)
+
+### Authorization
+
+[artikcloud_oauth](../README.md#artikcloud_oauth)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+
+# **get_subscription**
+> SubscriptionEnvelope get_subscription(sub_id)
+
+Get Subscription
+
+Get Subscription
+
+### 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::SubscriptionsApi.new
+
+sub_id = "sub_id_example" # String | Subscription ID.
+
+
+begin
+  #Get Subscription
+  result = api_instance.get_subscription(sub_id)
+  p result
+rescue ArtikCloud::ApiError => e
+  puts "Exception when calling SubscriptionsApi->get_subscription: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **sub_id** | **String**| Subscription ID. | 
+
+### Return type
+
+[**SubscriptionEnvelope**](SubscriptionEnvelope.md)
+
+### Authorization
+
+[artikcloud_oauth](../README.md#artikcloud_oauth)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+
+# **validate_subscription**
+> SubscriptionEnvelope validate_subscription(sub_id, validation_callback_request)
+
+Validate Subscription
+
+Validate Subscription
+
+### 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::SubscriptionsApi.new
+
+sub_id = "sub_id_example" # String | Subscription ID.
+
+validation_callback_request = ArtikCloud::ValidationCallbackInfo.new # ValidationCallbackInfo | Subscription validation callback request
+
+
+begin
+  #Validate Subscription
+  result = api_instance.validate_subscription(sub_id, validation_callback_request)
+  p result
+rescue ArtikCloud::ApiError => e
+  puts "Exception when calling SubscriptionsApi->validate_subscription: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **sub_id** | **String**| Subscription ID. | 
+ **validation_callback_request** | [**ValidationCallbackInfo**](ValidationCallbackInfo.md)| Subscription validation callback request | 
+
+### Return type
+
+[**SubscriptionEnvelope**](SubscriptionEnvelope.md)
+
+### Authorization
+
+[artikcloud_oauth](../README.md#artikcloud_oauth)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+