artikcloud 2.0.0

data/docs/DevicesApi.md

@@ -0,0 +1,382 @@
+# ArtikCloud::DevicesApi
+
+All URIs are relative to *https://api.artik.cloud/v1.1*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**add_device**](DevicesApi.md#add_device) | **POST** /devices | Add Device
+[**delete_device**](DevicesApi.md#delete_device) | **DELETE** /devices/{deviceId} | Delete Device
+[**delete_device_token**](DevicesApi.md#delete_device_token) | **DELETE** /devices/{deviceId}/tokens | Delete Device Token
+[**get_device**](DevicesApi.md#get_device) | **GET** /devices/{deviceId} | Get Device
+[**get_device_token**](DevicesApi.md#get_device_token) | **GET** /devices/{deviceId}/tokens | Get Device Token
+[**update_device**](DevicesApi.md#update_device) | **PUT** /devices/{deviceId} | Update Device
+[**update_device_token**](DevicesApi.md#update_device_token) | **PUT** /devices/{deviceId}/tokens | Update Device Token
+
+
+# **add_device**
+> DeviceEnvelope add_device(device)
+
+Add Device
+
+Create a 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::DevicesApi.new
+
+device = ArtikCloud::Device.new # Device | Device to be added to the user
+
+
+begin
+  #Add Device
+  result = api_instance.add_device(device)
+  p result
+rescue ArtikCloud::ApiError => e
+  puts "Exception when calling DevicesApi->add_device: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **device** | [**Device**](Device.md)| Device to be added to the user | 
+
+### Return type
+
+[**DeviceEnvelope**](DeviceEnvelope.md)
+
+### Authorization
+
+[artikcloud_oauth](../README.md#artikcloud_oauth)
+
+### HTTP reuqest headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **delete_device**
+> DeviceEnvelope delete_device(device_id)
+
+Delete Device
+
+Deletes a 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::DevicesApi.new
+
+device_id = "device_id_example" # String | deviceId
+
+
+begin
+  #Delete Device
+  result = api_instance.delete_device(device_id)
+  p result
+rescue ArtikCloud::ApiError => e
+  puts "Exception when calling DevicesApi->delete_device: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **device_id** | **String**| deviceId | 
+
+### Return type
+
+[**DeviceEnvelope**](DeviceEnvelope.md)
+
+### Authorization
+
+[artikcloud_oauth](../README.md#artikcloud_oauth)
+
+### HTTP reuqest headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+
+# **delete_device_token**
+> DeviceTokenEnvelope delete_device_token(device_id)
+
+Delete Device Token
+
+Deletes a device's 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::DevicesApi.new
+
+device_id = "device_id_example" # String | deviceId
+
+
+begin
+  #Delete Device Token
+  result = api_instance.delete_device_token(device_id)
+  p result
+rescue ArtikCloud::ApiError => e
+  puts "Exception when calling DevicesApi->delete_device_token: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **device_id** | **String**| deviceId | 
+
+### Return type
+
+[**DeviceTokenEnvelope**](DeviceTokenEnvelope.md)
+
+### Authorization
+
+[artikcloud_oauth](../README.md#artikcloud_oauth)
+
+### HTTP reuqest headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+
+# **get_device**
+> DeviceEnvelope get_device(device_id)
+
+Get Device
+
+Retrieves a 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::DevicesApi.new
+
+device_id = "device_id_example" # String | deviceId
+
+
+begin
+  #Get Device
+  result = api_instance.get_device(device_id)
+  p result
+rescue ArtikCloud::ApiError => e
+  puts "Exception when calling DevicesApi->get_device: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **device_id** | **String**| deviceId | 
+
+### Return type
+
+[**DeviceEnvelope**](DeviceEnvelope.md)
+
+### Authorization
+
+[artikcloud_oauth](../README.md#artikcloud_oauth)
+
+### HTTP reuqest headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+
+# **get_device_token**
+> DeviceTokenEnvelope get_device_token(device_id)
+
+Get Device Token
+
+Retrieves a device's 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::DevicesApi.new
+
+device_id = "device_id_example" # String | deviceId
+
+
+begin
+  #Get Device Token
+  result = api_instance.get_device_token(device_id)
+  p result
+rescue ArtikCloud::ApiError => e
+  puts "Exception when calling DevicesApi->get_device_token: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **device_id** | **String**| deviceId | 
+
+### Return type
+
+[**DeviceTokenEnvelope**](DeviceTokenEnvelope.md)
+
+### Authorization
+
+[artikcloud_oauth](../README.md#artikcloud_oauth)
+
+### HTTP reuqest headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+
+# **update_device**
+> DeviceEnvelope update_device(device_id, device)
+
+Update Device
+
+Updates a 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::DevicesApi.new
+
+device_id = "device_id_example" # String | deviceId
+
+device = ArtikCloud::Device.new # Device | Device to be updated
+
+
+begin
+  #Update Device
+  result = api_instance.update_device(device_id, device)
+  p result
+rescue ArtikCloud::ApiError => e
+  puts "Exception when calling DevicesApi->update_device: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **device_id** | **String**| deviceId | 
+ **device** | [**Device**](Device.md)| Device to be updated | 
+
+### Return type
+
+[**DeviceEnvelope**](DeviceEnvelope.md)
+
+### Authorization
+
+[artikcloud_oauth](../README.md#artikcloud_oauth)
+
+### HTTP reuqest headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **update_device_token**
+> DeviceTokenEnvelope update_device_token(device_id)
+
+Update Device Token
+
+Updates a device's 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::DevicesApi.new
+
+device_id = "device_id_example" # String | deviceId
+
+
+begin
+  #Update Device Token
+  result = api_instance.update_device_token(device_id)
+  p result
+rescue ArtikCloud::ApiError => e
+  puts "Exception when calling DevicesApi->update_device_token: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **device_id** | **String**| deviceId | 
+
+### Return type
+
+[**DeviceTokenEnvelope**](DeviceTokenEnvelope.md)
+
+### Authorization
+
+[artikcloud_oauth](../README.md#artikcloud_oauth)
+
+### HTTP reuqest headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+

data/docs/DevicesEnvelope.md

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

data/docs/ErrorEnvelope.md

@@ -0,0 +1,8 @@
+# ArtikCloud::ErrorEnvelope
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**error** | [**WebSocketError**](WebSocketError.md) | Error Data | [optional] 
+
+

data/docs/ExportApi.md

@@ -0,0 +1,225 @@
+# ArtikCloud::ExportApi
+
+All URIs are relative to *https://api.artik.cloud/v1.1*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**export_request**](ExportApi.md#export_request) | **POST** /messages/export | Create Export Request
+[**get_export_history**](ExportApi.md#get_export_history) | **GET** /messages/export/history | Get Export History
+[**get_export_result**](ExportApi.md#get_export_result) | **GET** /messages/export/{exportId}/result | Get Export Result
+[**get_export_status**](ExportApi.md#get_export_status) | **GET** /messages/export/{exportId}/status | Check Export Status
+
+
+# **export_request**
+> ExportRequestResponse export_request(export_request_info)
+
+Create Export Request
+
+Export normalized messages. The following input combinations are supported:<br/><table><tr><th>Combination</th><th>Parameters</th><th>Description</th></tr><tr><td>Get by users</td><td>uids</td><td>Search by a list of User IDs. For each user in the list, the current authenticated user must have read access over the specified user.</td></tr><tr><td>Get by devices</td><td>sdids</td><td>Search by Source Device IDs.</td></tr><tr><td>Get by device types</td><td>uids,sdtids</td><td>Search by list of Source Device Type IDs for the given list of users.</td></tr><tr><td>Get by trial</td><td>trialId</td><td>Search by Trial ID.</td></tr><tr><td>Get by combination of parameters</td><td>uids,sdids,sdtids</td><td>Search by list of Source Device IDs. Each Device ID must belong to a Source Device Type ID and a User ID.</td></tr><tr><td>Common</td><td>startDate,endDate,order,format,url,csvHeaders</td><td>Parameters that can be used with the above combinations.</td></tr></table>
+
+### 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::ExportApi.new
+
+export_request_info = ArtikCloud::ExportRequestInfo.new # ExportRequestInfo | ExportRequest object that is passed in the body
+
+
+begin
+  #Create Export Request
+  result = api_instance.export_request(export_request_info)
+  p result
+rescue ArtikCloud::ApiError => e
+  puts "Exception when calling ExportApi->export_request: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **export_request_info** | [**ExportRequestInfo**](ExportRequestInfo.md)| ExportRequest object that is passed in the body | 
+
+### Return type
+
+[**ExportRequestResponse**](ExportRequestResponse.md)
+
+### Authorization
+
+[artikcloud_oauth](../README.md#artikcloud_oauth)
+
+### HTTP reuqest headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+
+# **get_export_history**
+> ExportHistoryResponse get_export_history(opts)
+
+Get Export History
+
+Get the history of export requests.
+
+### 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::ExportApi.new
+
+opts = { 
+  trial_id: "trial_id_example", # String | Filter by trialId.
+  count: 56, # Integer | Pagination count.
+  offset: 56 # Integer | Pagination offset.
+}
+
+begin
+  #Get Export History
+  result = api_instance.get_export_history(opts)
+  p result
+rescue ArtikCloud::ApiError => e
+  puts "Exception when calling ExportApi->get_export_history: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **trial_id** | **String**| Filter by trialId. | [optional] 
+ **count** | [**Integer**](.md)| Pagination count. | [optional] 
+ **offset** | [**Integer**](.md)| Pagination offset. | [optional] 
+
+### Return type
+
+[**ExportHistoryResponse**](ExportHistoryResponse.md)
+
+### Authorization
+
+[artikcloud_oauth](../README.md#artikcloud_oauth)
+
+### HTTP reuqest headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+
+# **get_export_result**
+> String get_export_result(export_id)
+
+Get Export Result
+
+Retrieve result of the export query in tgz format. The tar file may contain one or more files with the results.
+
+### 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::ExportApi.new
+
+export_id = "export_id_example" # String | Export ID of the export query.
+
+
+begin
+  #Get Export Result
+  result = api_instance.get_export_result(export_id)
+  p result
+rescue ArtikCloud::ApiError => e
+  puts "Exception when calling ExportApi->get_export_result: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **export_id** | **String**| Export ID of the export query. | 
+
+### Return type
+
+**String**
+
+### Authorization
+
+[artikcloud_oauth](../README.md#artikcloud_oauth)
+
+### HTTP reuqest headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+
+# **get_export_status**
+> ExportStatusResponse get_export_status(export_id)
+
+Check Export Status
+
+Check status of the export query.
+
+### 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::ExportApi.new
+
+export_id = "export_id_example" # String | Export ID of the export query.
+
+
+begin
+  #Check Export Status
+  result = api_instance.get_export_status(export_id)
+  p result
+rescue ArtikCloud::ApiError => e
+  puts "Exception when calling ExportApi->get_export_status: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **export_id** | **String**| Export ID of the export query. | 
+
+### Return type
+
+[**ExportStatusResponse**](ExportStatusResponse.md)
+
+### Authorization
+
+[artikcloud_oauth](../README.md#artikcloud_oauth)
+
+### HTTP reuqest headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+

data/docs/ExportData.md

@@ -0,0 +1,14 @@
+# ArtikCloud::ExportData
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**expiration_date** | **Integer** |  | [optional] 
+**export_id** | **String** |  | [optional] 
+**file_size** | **Integer** |  | [optional] 
+**md5** | **String** |  | [optional] 
+**request** | [**ExportRequest**](ExportRequest.md) |  | [optional] 
+**status** | **String** | Export status | [optional] 
+**total_messages** | **Integer** |  | [optional] 
+
+

data/docs/ExportDataArray.md

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

data/docs/ExportHistoryResponse.md

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

data/docs/ExportNormalizedMessagesResponse.md

@@ -0,0 +1,20 @@
+# ArtikCloud::ExportNormalizedMessagesResponse
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**csv_headers** | **BOOLEAN** |  | [optional] 
+**end_date** | **Integer** |  | [optional] 
+**export_id** | **String** |  | [optional] 
+**format** | **String** |  | [optional] 
+**order** | **String** |  | [optional] 
+**sdid** | **String** |  | [optional] 
+**sdids** | **String** |  | [optional] 
+**start_date** | **Integer** |  | [optional] 
+**stdids** | **String** |  | [optional] 
+**trial_id** | **String** |  | [optional] 
+**uid** | **String** |  | [optional] 
+**uids** | **String** |  | [optional] 
+**url** | **String** |  | [optional] 
+
+

data/docs/ExportRequest.md

@@ -0,0 +1,15 @@
+# ArtikCloud::ExportRequest
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**end_date** | **Integer** |  | [optional] 
+**format** | **String** |  | [optional] 
+**order** | **String** |  | [optional] 
+**sdids** | **String** |  | [optional] 
+**sdtids** | **String** |  | [optional] 
+**start_date** | **Integer** |  | [optional] 
+**trial_id** | **String** |  | [optional] 
+**uids** | **String** |  | [optional] 
+
+