artikcloud 2.0.5 → 2.0.7

data/docs/EventFeedData.md

@@ -0,0 +1,10 @@
+# ArtikCloud::EventFeedData
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**event** | **String** | Event | [optional] 
+**ts** | **Integer** | Timestamp | [optional] 
+**data** | **Hash<String, Object>** | Message Payload | [optional] 
+
+

data/docs/MetadataEnvelope.md

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

data/docs/MetadataPropertiesEnvelope.md

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

data/docs/MetadataQueryEnvelope.md

@@ -0,0 +1,11 @@
+# ArtikCloud::MetadataQueryEnvelope
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**total** | **Integer** | Number of results found | [optional] 
+**data** | **Hash<String, Object>** | Array of objects with device's metadata | [optional] 
+**offset** | **Integer** | Page starting position | [optional] 
+**count** | **Integer** | Page size | [optional] 
+
+

data/docs/MetadataRequest.md

@@ -0,0 +1,7 @@
+# ArtikCloud::MetadataRequest
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+
+

data/docs/Task.md

@@ -0,0 +1,18 @@
+# ArtikCloud::Task
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**filter** | **String** | Filter | [optional] 
+**task_type** | **String** | Task type | [optional] 
+**modified_on** | **Integer** | Modified on | [optional] 
+**dtid** | **String** | Device Type ID | [optional] 
+**status_counts** | [**TaskStatusCounts**](TaskStatusCounts.md) | Status counts | [optional] 
+**property** | **String** | Property | [optional] 
+**id** | **String** | Task ID | [optional] 
+**dids** | **Array<String>** | Device IDs | [optional] 
+**task_parameters** | [**TaskParameters**](TaskParameters.md) | Task parameters | [optional] 
+**created_on** | **Integer** | Created on | [optional] 
+**status** | **String** | Status | [optional] 
+
+

data/docs/TaskByDid.md

@@ -0,0 +1,19 @@
+# ArtikCloud::TaskByDid
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**filter** | **String** | Filter | [optional] 
+**task_type** | **String** | Task type | [optional] 
+**modified_on** | **Integer** | Modified on | [optional] 
+**dtid** | **String** | Device Type ID | [optional] 
+**status_counts** | [**TaskStatusCounts**](TaskStatusCounts.md) | Status counts | [optional] 
+**property** | **String** | Property | [optional] 
+**statuses** | [**Array<DeviceTask>**](DeviceTask.md) | Last known device task status for the specified did | [optional] 
+**id** | **String** | Task ID | [optional] 
+**dids** | **Array<String>** | Device IDs | [optional] 
+**task_parameters** | [**TaskParameters**](TaskParameters.md) | Task parameters | [optional] 
+**created_on** | **Integer** | Created on | [optional] 
+**status** | **String** | Status | [optional] 
+
+

data/docs/TaskByDidList.md

@@ -0,0 +1,8 @@
+# ArtikCloud::TaskByDidList
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**tasks** | [**Array<TaskByDid>**](TaskByDid.md) | Task list | [optional] 
+
+

data/docs/TaskByDidListEnvelope.md

@@ -0,0 +1,11 @@
+# ArtikCloud::TaskByDidListEnvelope
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**total** | **Integer** | Total number of tasks in list | [optional] 
+**data** | [**TaskByDidList**](TaskByDidList.md) | Device task list envelope | [optional] 
+**offset** | **Integer** | Offset if using pagination | [optional] 
+**count** | **Integer** | Count for current result set | [optional] 
+
+

data/docs/TaskEnvelope.md

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

data/docs/TaskHistory.md

@@ -0,0 +1,13 @@
+# ArtikCloud::TaskHistory
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**num_attempts** | **Integer** | Number of attempts | [optional] 
+**error_message** | **String** | Error Message | [optional] 
+**error_code** | **String** | Error Code | [optional] 
+**did** | **String** | Device ID | [optional] 
+**status** | **String** | Status | [optional] 
+**ts** | **Integer** | Timestamp of most recent status change | [optional] 
+
+

data/docs/TaskHistoryList.md

@@ -0,0 +1,8 @@
+# ArtikCloud::TaskHistoryList
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**history** | [**Array<TaskHistory>**](TaskHistory.md) | Status history | [optional] 
+
+

data/docs/TaskList.md

@@ -0,0 +1,8 @@
+# ArtikCloud::TaskList
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**tasks** | [**Array<Task>**](Task.md) | Task list | [optional] 
+
+

data/docs/TaskListEnvelope.md

@@ -0,0 +1,12 @@
+# ArtikCloud::TaskListEnvelope
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**total** | **Integer** | Total | [optional] 
+**data** | [**TaskList**](TaskList.md) | Envelope for task list | [optional] 
+**status_counts** | [**TasksStatusCounts**](TasksStatusCounts.md) | Status counts | [optional] 
+**offset** | **Integer** | Offset | [optional] 
+**count** | **Integer** | Count | [optional] 
+
+

data/docs/TaskParameters.md

@@ -0,0 +1,9 @@
+# ArtikCloud::TaskParameters
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**expires_after** | **Integer** | Expire time in seconds | [optional] 
+**value** | **String** | Value to write | [optional] 
+
+

data/docs/TaskRequest.md

@@ -0,0 +1,13 @@
+# ArtikCloud::TaskRequest
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**filter** | **String** | Filter | [optional] 
+**task_type** | **String** | Task type | [optional] 
+**dtid** | **String** | Device Type ID | [optional] 
+**property** | **String** | Property | [optional] 
+**dids** | **Array<String>** | Device IDs | [optional] 
+**task_parameters** | [**TaskParameters**](TaskParameters.md) | Task parameters | [optional] 
+
+

data/docs/TaskStatus.md

@@ -0,0 +1,13 @@
+# ArtikCloud::TaskStatus
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**num_attempts** | **Integer** | Number of attempts | [optional] 
+**error_message** | **String** | Error Message | [optional] 
+**error_code** | **String** | Error Code | [optional] 
+**did** | **String** | Device ID | [optional] 
+**status** | **String** | Status | [optional] 
+**ts** | **Integer** | Timestamp of most recent status change | [optional] 
+
+

data/docs/TaskStatusCounts.md

@@ -0,0 +1,12 @@
+# ArtikCloud::TaskStatusCounts
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**num_failed** | **Integer** | Number failed | [optional] 
+**num_cancelled** | **Integer** | Number cancelled | [optional] 
+**total_devices** | **Integer** | Total devices | [optional] 
+**num_completed** | **Integer** | Number completed | [optional] 
+**num_succeeded** | **Integer** | Number succeeded | [optional] 
+
+

data/docs/TaskStatuses.md

@@ -0,0 +1,19 @@
+# ArtikCloud::TaskStatuses
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**filter** | **String** | Filter | [optional] 
+**task_type** | **String** | Task type | [optional] 
+**modified_on** | **Integer** | Modified on | [optional] 
+**dtid** | **String** | Device Type ID | [optional] 
+**status_counts** | [**TaskStatusCounts**](TaskStatusCounts.md) | Status counts | [optional] 
+**property** | **String** | Property | [optional] 
+**statuses** | [**Array<TaskStatus>**](TaskStatus.md) | Statuses | [optional] 
+**id** | **String** | Task ID | [optional] 
+**dids** | **Array<String>** | Device IDs | [optional] 
+**task_parameters** | [**TaskParameters**](TaskParameters.md) | Task parameters | [optional] 
+**created_on** | **Integer** | Created on | [optional] 
+**status** | **String** | Status | [optional] 
+
+

data/docs/TaskStatusesEnvelope.md

@@ -0,0 +1,11 @@
+# ArtikCloud::TaskStatusesEnvelope
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**total** | **Integer** | Total | [optional] 
+**data** | [**TaskStatuses**](TaskStatuses.md) | Task statuses | [optional] 
+**offset** | **Integer** | Offset | [optional] 
+**count** | **Integer** | Count | [optional] 
+
+

data/docs/TaskStatusesHistoryEnvelope.md

@@ -0,0 +1,8 @@
+# ArtikCloud::TaskStatusesHistoryEnvelope
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**data** | [**TaskHistoryList**](TaskHistoryList.md) | Task statuses history | [optional] 
+
+

data/docs/TaskUpdateRequest.md

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

data/docs/TaskUpdateResponse.md

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

data/docs/TasksStatusCounts.md

@@ -0,0 +1,11 @@
+# ArtikCloud::TasksStatusCounts
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**cancelled** | **Integer** | Cancelled | [optional] 
+**complete** | **Integer** | Complete | [optional] 
+**processing** | **Integer** | Processing | [optional] 
+**requested** | **Integer** | Requested | [optional] 
+
+

data/lib/artikcloud/api/device_types_api.rb

@@ -212,6 +212,72 @@ module ArtikCloud
       return data, status_code, headers
     end
 
+    # Get Device Types by Application
+    # Get Device Types by Application
+    # @param app_id Application ID.
+    # @param [Hash] opts the optional parameters
+    # @option opts [BOOLEAN] :product_info Flag to include the associated ProductInfo if present
+    # @option opts [Integer] :count Desired count of items in the result set.
+    # @option opts [Integer] :offset Offset for pagination.
+    # @return [DeviceTypesEnvelope]
+    def get_device_types_by_application(app_id, opts = {})
+      data, _status_code, _headers = get_device_types_by_application_with_http_info(app_id, opts)
+      return data
+    end
+
+    # Get Device Types by Application
+    # Get Device Types by Application
+    # @param app_id Application ID.
+    # @param [Hash] opts the optional parameters
+    # @option opts [BOOLEAN] :product_info Flag to include the associated ProductInfo if present
+    # @option opts [Integer] :count Desired count of items in the result set.
+    # @option opts [Integer] :offset Offset for pagination.
+    # @return [Array<(DeviceTypesEnvelope, Fixnum, Hash)>] DeviceTypesEnvelope data, response status code and response headers
+    def get_device_types_by_application_with_http_info(app_id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "Calling API: DeviceTypesApi.get_device_types_by_application ..."
+      end
+      # verify the required parameter 'app_id' is set
+      fail ArgumentError, "Missing the required parameter 'app_id' when calling DeviceTypesApi.get_device_types_by_application" if app_id.nil?
+      # resource path
+      local_var_path = "/applications/{appId}/devicetypes".sub('{format}','json').sub('{' + 'appId' + '}', app_id.to_s)
+
+      # query parameters
+      query_params = {}
+      query_params[:'productInfo'] = opts[:'product_info'] if !opts[:'product_info'].nil?
+      query_params[:'count'] = opts[:'count'] if !opts[:'count'].nil?
+      query_params[:'offset'] = opts[:'offset'] if !opts[:'offset'].nil?
+
+      # header parameters
+      header_params = {}
+
+      # HTTP header 'Accept' (if needed)
+      local_header_accept = ['application/json']
+      local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result
+
+      # HTTP header 'Content-Type'
+      local_header_content_type = []
+      header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)
+
+      # form parameters
+      form_params = {}
+
+      # http body (model)
+      post_body = nil
+      auth_names = ['artikcloud_oauth']
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path,
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => 'DeviceTypesEnvelope')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: DeviceTypesApi#get_device_types_by_application\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
     # Get Latest Manifest Properties
     # Get a Device Type's manifest properties for the latest version.
     # @param device_type_id Device Type ID.