artikcloud 2.0.5 → 2.0.7
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/Gemfile.lock +23 -1
- data/LICENSE +1 -2
- data/README.md +50 -4
- data/artikcloud.gemspec +29 -5
- data/docs/DeviceTask.md +13 -0
- data/docs/DeviceTaskUpdateRequest.md +8 -0
- data/docs/DeviceTaskUpdateResponse.md +8 -0
- data/docs/DeviceTypeInfo.md +14 -0
- data/docs/DeviceTypeInfoEnvelope.md +8 -0
- data/docs/DeviceTypesApi.md +61 -0
- data/docs/DeviceTypesInfo.md +14 -0
- data/docs/DeviceTypesInfoEnvelope.md +8 -0
- data/docs/DevicesManagementApi.md +870 -0
- data/docs/EventFeedData.md +10 -0
- data/docs/MetadataEnvelope.md +8 -0
- data/docs/MetadataPropertiesEnvelope.md +8 -0
- data/docs/MetadataQueryEnvelope.md +11 -0
- data/docs/MetadataRequest.md +7 -0
- data/docs/Task.md +18 -0
- data/docs/TaskByDid.md +19 -0
- data/docs/TaskByDidList.md +8 -0
- data/docs/TaskByDidListEnvelope.md +11 -0
- data/docs/TaskEnvelope.md +8 -0
- data/docs/TaskHistory.md +13 -0
- data/docs/TaskHistoryList.md +8 -0
- data/docs/TaskList.md +8 -0
- data/docs/TaskListEnvelope.md +12 -0
- data/docs/TaskParameters.md +9 -0
- data/docs/TaskRequest.md +13 -0
- data/docs/TaskStatus.md +13 -0
- data/docs/TaskStatusCounts.md +12 -0
- data/docs/TaskStatuses.md +19 -0
- data/docs/TaskStatusesEnvelope.md +11 -0
- data/docs/TaskStatusesHistoryEnvelope.md +8 -0
- data/docs/TaskUpdateRequest.md +8 -0
- data/docs/TaskUpdateResponse.md +8 -0
- data/docs/TasksStatusCounts.md +11 -0
- data/lib/artikcloud/api/device_types_api.rb +66 -0
- data/lib/artikcloud/api/devices_management_api.rb +971 -0
- data/lib/artikcloud/models/device_task.rb +250 -0
- data/lib/artikcloud/models/device_task_update_request.rb +200 -0
- data/lib/artikcloud/models/device_task_update_response.rb +200 -0
- data/lib/artikcloud/models/device_type_info.rb +260 -0
- data/lib/artikcloud/models/device_type_info_envelope.rb +199 -0
- data/lib/artikcloud/models/device_types_info.rb +260 -0
- data/lib/artikcloud/models/device_types_info_envelope.rb +199 -0
- data/lib/artikcloud/models/event_feed_data.rb +222 -0
- data/lib/artikcloud/models/metadata_envelope.rb +202 -0
- data/lib/artikcloud/models/metadata_properties_envelope.rb +201 -0
- data/lib/artikcloud/models/metadata_query_envelope.rb +232 -0
- data/lib/artikcloud/models/metadata_request.rb +190 -0
- data/lib/artikcloud/models/task.rb +302 -0
- data/lib/artikcloud/models/task_by_did.rb +314 -0
- data/lib/artikcloud/models/task_by_did_list.rb +202 -0
- data/lib/artikcloud/models/task_by_did_list_envelope.rb +230 -0
- data/lib/artikcloud/models/task_envelope.rb +200 -0
- data/lib/artikcloud/models/task_history.rb +250 -0
- data/lib/artikcloud/models/task_history_list.rb +202 -0
- data/lib/artikcloud/models/task_list.rb +202 -0
- data/lib/artikcloud/models/task_list_envelope.rb +240 -0
- data/lib/artikcloud/models/task_parameters.rb +210 -0
- data/lib/artikcloud/models/task_request.rb +252 -0
- data/lib/artikcloud/models/task_status.rb +250 -0
- data/lib/artikcloud/models/task_status_counts.rb +240 -0
- data/lib/artikcloud/models/task_statuses.rb +314 -0
- data/lib/artikcloud/models/task_statuses_envelope.rb +230 -0
- data/lib/artikcloud/models/task_statuses_history_envelope.rb +200 -0
- data/lib/artikcloud/models/task_update_request.rb +200 -0
- data/lib/artikcloud/models/task_update_response.rb +200 -0
- data/lib/artikcloud/models/tasks_status_counts.rb +230 -0
- data/lib/artikcloud/version.rb +1 -1
- data/lib/artikcloud.rb +31 -0
- data/pom.xml +1 -1
- data/spec/api/devices_api_spec.rb +7 -10
- data/spec/api/devices_management_api_spec.rb +251 -0
- data/spec/api/messages_api_spec.rb +67 -25
- data/spec/api/tokens_api_spec.rb +10 -33
- data/spec/api/users_api_spec.rb +65 -14
- data/spec/api_client_spec.rb +237 -0
- data/spec/configuration_spec.rb +53 -0
- data/spec/factories/devices.rb +32 -0
- data/spec/factories/users.rb +31 -0
- data/spec/fixtures/cassettes/DevicesApi/get_device_presence_test/should_work.yml +50 -0
- data/spec/fixtures/cassettes/MessagesApi/get_message_snapshots/should_work.yml +54 -0
- data/spec/fixtures/cassettes/MessagesApi/send_actions/should_work.yml +93 -0
- data/spec/fixtures/cassettes/MessagesApi/send_message_action_test/should_work.yml +99 -0
- data/spec/fixtures/cassettes/TokensApi/refresh_token_test/should_work.yml +43 -0
- data/spec/fixtures/cassettes/TokensApi/token_info_test/should_work.yml +38 -0
- data/spec/fixtures/cassettes/UsersApi/get_self_test/should_work.yml +53 -0
- data/spec/fixtures/cassettes/UsersApi/get_user_device_types_test/should_work.yml +55 -0
- data/spec/fixtures/cassettes/UsersApi/get_user_devices_test/should_work.yml +55 -0
- data/spec/fixtures/cassettes/UsersApi/get_user_properties_update_user_properties_and_delete_user_properties_test/should_work.yml +52 -0
- data/spec/fixtures/cassettes/UsersApi/get_user_rules_test/should_work.yml +58 -0
- data/spec/spec_helper.rb +20 -5
- metadata +142 -46
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA1:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: adf513214ae45999417241ed6960450f65e016f6
|
|
4
|
+
data.tar.gz: e4d92733cdfaceaf32a944cf5a437753d41eb404
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: a0e4baa3f2659f8c74c0d6447c398e574f8b907ffd0ca7fb6a1d92ca9b17dd7a5d2b928da9e8872581bb1d990023ac2a43e3ec738d3c344f0353b215d671ed94
|
|
7
|
+
data.tar.gz: 6dba34406bba442ffb59ded60cb4a534c337de547e592678514492be8462fb21e8b60615c6e22d32adfbb640f7478e3d0e1f47508b3ba3374f4c03329baaeba3
|
data/Gemfile.lock
CHANGED
|
@@ -9,6 +9,11 @@ GEM
|
|
|
9
9
|
remote: http://rubygems.org/
|
|
10
10
|
specs:
|
|
11
11
|
ZenTest (4.11.0)
|
|
12
|
+
activesupport (5.0.0.1)
|
|
13
|
+
concurrent-ruby (~> 1.0, >= 1.0.2)
|
|
14
|
+
i18n (~> 0.7)
|
|
15
|
+
minitest (~> 5.1)
|
|
16
|
+
tzinfo (~> 1.1)
|
|
12
17
|
addressable (2.4.0)
|
|
13
18
|
autotest (4.4.6)
|
|
14
19
|
ZenTest (>= 4.4.1)
|
|
@@ -16,14 +21,25 @@ GEM
|
|
|
16
21
|
sys-uname
|
|
17
22
|
autotest-growl (0.2.16)
|
|
18
23
|
autotest-rails-pure (4.1.2)
|
|
24
|
+
coderay (1.1.1)
|
|
25
|
+
concurrent-ruby (1.0.2)
|
|
19
26
|
crack (0.4.3)
|
|
20
27
|
safe_yaml (~> 1.0.0)
|
|
21
28
|
diff-lcs (1.2.5)
|
|
22
29
|
ethon (0.9.0)
|
|
23
30
|
ffi (>= 1.3.0)
|
|
31
|
+
factory_girl (4.7.0)
|
|
32
|
+
activesupport (>= 3.0.0)
|
|
24
33
|
ffi (1.9.10)
|
|
25
34
|
hashdiff (0.3.0)
|
|
35
|
+
i18n (0.7.0)
|
|
26
36
|
json (1.8.3)
|
|
37
|
+
method_source (0.8.2)
|
|
38
|
+
minitest (5.9.0)
|
|
39
|
+
pry (0.10.4)
|
|
40
|
+
coderay (~> 1.1.0)
|
|
41
|
+
method_source (~> 0.8.1)
|
|
42
|
+
slop (~> 3.4)
|
|
27
43
|
rspec (3.4.0)
|
|
28
44
|
rspec-core (~> 3.4.0)
|
|
29
45
|
rspec-expectations (~> 3.4.0)
|
|
@@ -38,10 +54,14 @@ GEM
|
|
|
38
54
|
rspec-support (~> 3.4.0)
|
|
39
55
|
rspec-support (3.4.1)
|
|
40
56
|
safe_yaml (1.0.4)
|
|
57
|
+
slop (3.6.0)
|
|
41
58
|
sys-uname (1.0.2)
|
|
42
59
|
ffi (>= 1.0.0)
|
|
60
|
+
thread_safe (0.3.5)
|
|
43
61
|
typhoeus (1.1.0)
|
|
44
62
|
ethon (>= 0.9.0)
|
|
63
|
+
tzinfo (1.2.2)
|
|
64
|
+
thread_safe (~> 0.1)
|
|
45
65
|
vcr (3.0.3)
|
|
46
66
|
webmock (1.24.6)
|
|
47
67
|
addressable (>= 2.3.6)
|
|
@@ -57,9 +77,11 @@ DEPENDENCIES
|
|
|
57
77
|
autotest-fsevent (~> 0.2, >= 0.2.11)
|
|
58
78
|
autotest-growl (~> 0.2, >= 0.2.16)
|
|
59
79
|
autotest-rails-pure (~> 4.1, >= 4.1.2)
|
|
80
|
+
factory_girl (~> 4.7, >= 4.7.0)
|
|
81
|
+
pry (~> 0.10, >= 0.10.3)
|
|
60
82
|
rspec (~> 3.4, >= 3.4.0)
|
|
61
83
|
vcr (~> 3.0, >= 3.0.1)
|
|
62
84
|
webmock (~> 1.24, >= 1.24.3)
|
|
63
85
|
|
|
64
86
|
BUNDLED WITH
|
|
65
|
-
1.12.
|
|
87
|
+
1.12.5
|
data/LICENSE
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
Apache License
|
|
1
|
+
Apache License
|
|
2
2
|
Version 2.0, January 2004
|
|
3
3
|
http://www.apache.org/licenses/
|
|
4
4
|
|
|
@@ -199,4 +199,3 @@ Apache License
|
|
|
199
199
|
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
200
200
|
See the License for the specific language governing permissions and
|
|
201
201
|
limitations under the License.
|
|
202
|
-
|
data/README.md
CHANGED
|
@@ -18,15 +18,15 @@ gem build artikcloud.gemspec
|
|
|
18
18
|
Then either install the gem locally:
|
|
19
19
|
|
|
20
20
|
```shell
|
|
21
|
-
gem install ./artikcloud-2.0.
|
|
21
|
+
gem install ./artikcloud-2.0.7.gem
|
|
22
22
|
```
|
|
23
|
-
(for development, run `gem install --dev ./artikcloud-2.0.
|
|
23
|
+
(for development, run `gem install --dev ./artikcloud-2.0.7.gem` to install the development dependencies)
|
|
24
24
|
|
|
25
25
|
or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
|
|
26
26
|
|
|
27
27
|
Finally add this to the Gemfile:
|
|
28
28
|
|
|
29
|
-
gem 'artikcloud', '~> 2.0.
|
|
29
|
+
gem 'artikcloud', '~> 2.0.7'
|
|
30
30
|
|
|
31
31
|
### Install from Git
|
|
32
32
|
|
|
@@ -79,6 +79,7 @@ Class | Method | HTTP request | Description
|
|
|
79
79
|
*ArtikCloud::DeviceTypesApi* | [**get_available_manifest_versions**](docs/DeviceTypesApi.md#get_available_manifest_versions) | **GET** /devicetypes/{deviceTypeId}/availablemanifestversions | Get Available Manifest Versions
|
|
80
80
|
*ArtikCloud::DeviceTypesApi* | [**get_device_type**](docs/DeviceTypesApi.md#get_device_type) | **GET** /devicetypes/{deviceTypeId} | Get Device Type
|
|
81
81
|
*ArtikCloud::DeviceTypesApi* | [**get_device_types**](docs/DeviceTypesApi.md#get_device_types) | **GET** /devicetypes | Get Device Types
|
|
82
|
+
*ArtikCloud::DeviceTypesApi* | [**get_device_types_by_application**](docs/DeviceTypesApi.md#get_device_types_by_application) | **GET** /applications/{appId}/devicetypes | Get Device Types by Application
|
|
82
83
|
*ArtikCloud::DeviceTypesApi* | [**get_latest_manifest_properties**](docs/DeviceTypesApi.md#get_latest_manifest_properties) | **GET** /devicetypes/{deviceTypeId}/manifests/latest/properties | Get Latest Manifest Properties
|
|
83
84
|
*ArtikCloud::DeviceTypesApi* | [**get_manifest_properties**](docs/DeviceTypesApi.md#get_manifest_properties) | **GET** /devicetypes/{deviceTypeId}/manifests/{version}/properties | Get manifest properties
|
|
84
85
|
*ArtikCloud::DevicesApi* | [**add_device**](docs/DevicesApi.md#add_device) | **POST** /devices | Add Device
|
|
@@ -89,6 +90,21 @@ Class | Method | HTTP request | Description
|
|
|
89
90
|
*ArtikCloud::DevicesApi* | [**get_device_token**](docs/DevicesApi.md#get_device_token) | **GET** /devices/{deviceId}/tokens | Get Device Token
|
|
90
91
|
*ArtikCloud::DevicesApi* | [**update_device**](docs/DevicesApi.md#update_device) | **PUT** /devices/{deviceId} | Update Device
|
|
91
92
|
*ArtikCloud::DevicesApi* | [**update_device_token**](docs/DevicesApi.md#update_device_token) | **PUT** /devices/{deviceId}/tokens | Update Device Token
|
|
93
|
+
*ArtikCloud::DevicesManagementApi* | [**create_tasks**](docs/DevicesManagementApi.md#create_tasks) | **POST** /devicemgmt/tasks | Create a new task for one or more devices
|
|
94
|
+
*ArtikCloud::DevicesManagementApi* | [**delete_server_properties**](docs/DevicesManagementApi.md#delete_server_properties) | **DELETE** /devicemgmt/devices/{did}/serverproperties | Deletes a device's properties.
|
|
95
|
+
*ArtikCloud::DevicesManagementApi* | [**get_all_by_did**](docs/DevicesManagementApi.md#get_all_by_did) | **GET** /devicemgmt/devices/{did}/tasks | Returns the list of tasks for a particular device id with optional status filter.
|
|
96
|
+
*ArtikCloud::DevicesManagementApi* | [**get_device_types_info**](docs/DevicesManagementApi.md#get_device_types_info) | **GET** /devicemgmt/devicetypes/{dtid} | Read a device type device management information.
|
|
97
|
+
*ArtikCloud::DevicesManagementApi* | [**get_manifest_properties**](docs/DevicesManagementApi.md#get_manifest_properties) | **GET** /devicemgmt/devicetypes/{dtid}/manifest/properties | Get a device type's device management manifest properties
|
|
98
|
+
*ArtikCloud::DevicesManagementApi* | [**get_properties**](docs/DevicesManagementApi.md#get_properties) | **GET** /devicemgmt/devices/{did}/properties | Read a device's properties.
|
|
99
|
+
*ArtikCloud::DevicesManagementApi* | [**get_statuses**](docs/DevicesManagementApi.md#get_statuses) | **GET** /devicemgmt/tasks/{tid}/statuses | Returns the details and status of a task id and the individual statuses of each device id in the list.
|
|
100
|
+
*ArtikCloud::DevicesManagementApi* | [**get_statuses_history**](docs/DevicesManagementApi.md#get_statuses_history) | **GET** /devicemgmt/tasks/{tid}/statuses/history | Returns the history of the status changes for a specific task id, or for a specific device id in that task.
|
|
101
|
+
*ArtikCloud::DevicesManagementApi* | [**get_task_by_id**](docs/DevicesManagementApi.md#get_task_by_id) | **GET** /devicemgmt/tasks/{tid} | Returns the details and global status of a specific task id.
|
|
102
|
+
*ArtikCloud::DevicesManagementApi* | [**get_tasks**](docs/DevicesManagementApi.md#get_tasks) | **GET** /devicemgmt/tasks | Returns the all the tasks for a device type.
|
|
103
|
+
*ArtikCloud::DevicesManagementApi* | [**query_properties**](docs/DevicesManagementApi.md#query_properties) | **GET** /devicemgmt/devices/properties | Query device properties across devices.
|
|
104
|
+
*ArtikCloud::DevicesManagementApi* | [**update_device_types_info**](docs/DevicesManagementApi.md#update_device_types_info) | **PUT** /devicemgmt/devicetypes/{dtid} | Updates a device type information
|
|
105
|
+
*ArtikCloud::DevicesManagementApi* | [**update_server_properties**](docs/DevicesManagementApi.md#update_server_properties) | **POST** /devicemgmt/devices/{did}/serverproperties | Updates a device's server properties.
|
|
106
|
+
*ArtikCloud::DevicesManagementApi* | [**update_task**](docs/DevicesManagementApi.md#update_task) | **PUT** /devicemgmt/tasks/{tid} | Updates a task for all devices - For now just allows changing the state to cancelled.
|
|
107
|
+
*ArtikCloud::DevicesManagementApi* | [**update_task_for_device**](docs/DevicesManagementApi.md#update_task_for_device) | **PUT** /devicemgmt/tasks/{tid}/devices/{did} | Updates a task for a specific device - For now just allows changing the state to cancelled.
|
|
92
108
|
*ArtikCloud::ExportApi* | [**export_request**](docs/ExportApi.md#export_request) | **POST** /messages/export | Create Export Request
|
|
93
109
|
*ArtikCloud::ExportApi* | [**get_export_history**](docs/ExportApi.md#get_export_history) | **GET** /messages/export/history | Get Export History
|
|
94
110
|
*ArtikCloud::ExportApi* | [**get_export_result**](docs/ExportApi.md#get_export_result) | **GET** /messages/export/{exportId}/result | Get Export Result
|
|
@@ -152,14 +168,22 @@ Class | Method | HTTP request | Description
|
|
|
152
168
|
- [ArtikCloud::DeviceRegConfirmUserResponseEnvelope](docs/DeviceRegConfirmUserResponseEnvelope.md)
|
|
153
169
|
- [ArtikCloud::DeviceRegStatusResponse](docs/DeviceRegStatusResponse.md)
|
|
154
170
|
- [ArtikCloud::DeviceRegStatusResponseEnvelope](docs/DeviceRegStatusResponseEnvelope.md)
|
|
171
|
+
- [ArtikCloud::DeviceTask](docs/DeviceTask.md)
|
|
172
|
+
- [ArtikCloud::DeviceTaskUpdateRequest](docs/DeviceTaskUpdateRequest.md)
|
|
173
|
+
- [ArtikCloud::DeviceTaskUpdateResponse](docs/DeviceTaskUpdateResponse.md)
|
|
155
174
|
- [ArtikCloud::DeviceToken](docs/DeviceToken.md)
|
|
156
175
|
- [ArtikCloud::DeviceTokenEnvelope](docs/DeviceTokenEnvelope.md)
|
|
157
176
|
- [ArtikCloud::DeviceType](docs/DeviceType.md)
|
|
158
177
|
- [ArtikCloud::DeviceTypeArray](docs/DeviceTypeArray.md)
|
|
159
178
|
- [ArtikCloud::DeviceTypeEnvelope](docs/DeviceTypeEnvelope.md)
|
|
179
|
+
- [ArtikCloud::DeviceTypeInfo](docs/DeviceTypeInfo.md)
|
|
180
|
+
- [ArtikCloud::DeviceTypeInfoEnvelope](docs/DeviceTypeInfoEnvelope.md)
|
|
160
181
|
- [ArtikCloud::DeviceTypesEnvelope](docs/DeviceTypesEnvelope.md)
|
|
182
|
+
- [ArtikCloud::DeviceTypesInfo](docs/DeviceTypesInfo.md)
|
|
183
|
+
- [ArtikCloud::DeviceTypesInfoEnvelope](docs/DeviceTypesInfoEnvelope.md)
|
|
161
184
|
- [ArtikCloud::DevicesEnvelope](docs/DevicesEnvelope.md)
|
|
162
185
|
- [ArtikCloud::ErrorEnvelope](docs/ErrorEnvelope.md)
|
|
186
|
+
- [ArtikCloud::EventFeedData](docs/EventFeedData.md)
|
|
163
187
|
- [ArtikCloud::ExportData](docs/ExportData.md)
|
|
164
188
|
- [ArtikCloud::ExportDataArray](docs/ExportDataArray.md)
|
|
165
189
|
- [ArtikCloud::ExportHistoryResponse](docs/ExportHistoryResponse.md)
|
|
@@ -184,6 +208,9 @@ Class | Method | HTTP request | Description
|
|
|
184
208
|
- [ArtikCloud::MessageIDEnvelope](docs/MessageIDEnvelope.md)
|
|
185
209
|
- [ArtikCloud::MessageIn](docs/MessageIn.md)
|
|
186
210
|
- [ArtikCloud::MessageOut](docs/MessageOut.md)
|
|
211
|
+
- [ArtikCloud::MetadataEnvelope](docs/MetadataEnvelope.md)
|
|
212
|
+
- [ArtikCloud::MetadataPropertiesEnvelope](docs/MetadataPropertiesEnvelope.md)
|
|
213
|
+
- [ArtikCloud::MetadataQueryEnvelope](docs/MetadataQueryEnvelope.md)
|
|
187
214
|
- [ArtikCloud::NonEmptyString](docs/NonEmptyString.md)
|
|
188
215
|
- [ArtikCloud::NormalizedAction](docs/NormalizedAction.md)
|
|
189
216
|
- [ArtikCloud::NormalizedActionsEnvelope](docs/NormalizedActionsEnvelope.md)
|
|
@@ -208,6 +235,25 @@ Class | Method | HTTP request | Description
|
|
|
208
235
|
- [ArtikCloud::Tag](docs/Tag.md)
|
|
209
236
|
- [ArtikCloud::TagArray](docs/TagArray.md)
|
|
210
237
|
- [ArtikCloud::TagsEnvelope](docs/TagsEnvelope.md)
|
|
238
|
+
- [ArtikCloud::Task](docs/Task.md)
|
|
239
|
+
- [ArtikCloud::TaskByDid](docs/TaskByDid.md)
|
|
240
|
+
- [ArtikCloud::TaskByDidList](docs/TaskByDidList.md)
|
|
241
|
+
- [ArtikCloud::TaskByDidListEnvelope](docs/TaskByDidListEnvelope.md)
|
|
242
|
+
- [ArtikCloud::TaskEnvelope](docs/TaskEnvelope.md)
|
|
243
|
+
- [ArtikCloud::TaskHistory](docs/TaskHistory.md)
|
|
244
|
+
- [ArtikCloud::TaskHistoryList](docs/TaskHistoryList.md)
|
|
245
|
+
- [ArtikCloud::TaskList](docs/TaskList.md)
|
|
246
|
+
- [ArtikCloud::TaskListEnvelope](docs/TaskListEnvelope.md)
|
|
247
|
+
- [ArtikCloud::TaskParameters](docs/TaskParameters.md)
|
|
248
|
+
- [ArtikCloud::TaskRequest](docs/TaskRequest.md)
|
|
249
|
+
- [ArtikCloud::TaskStatus](docs/TaskStatus.md)
|
|
250
|
+
- [ArtikCloud::TaskStatusCounts](docs/TaskStatusCounts.md)
|
|
251
|
+
- [ArtikCloud::TaskStatuses](docs/TaskStatuses.md)
|
|
252
|
+
- [ArtikCloud::TaskStatusesEnvelope](docs/TaskStatusesEnvelope.md)
|
|
253
|
+
- [ArtikCloud::TaskStatusesHistoryEnvelope](docs/TaskStatusesHistoryEnvelope.md)
|
|
254
|
+
- [ArtikCloud::TaskUpdateRequest](docs/TaskUpdateRequest.md)
|
|
255
|
+
- [ArtikCloud::TaskUpdateResponse](docs/TaskUpdateResponse.md)
|
|
256
|
+
- [ArtikCloud::TasksStatusCounts](docs/TasksStatusCounts.md)
|
|
211
257
|
- [ArtikCloud::Token](docs/Token.md)
|
|
212
258
|
- [ArtikCloud::TokenInfo](docs/TokenInfo.md)
|
|
213
259
|
- [ArtikCloud::TokenInfoSuccessResponse](docs/TokenInfoSuccessResponse.md)
|
|
@@ -228,7 +274,7 @@ Class | Method | HTTP request | Description
|
|
|
228
274
|
- **Type**: OAuth
|
|
229
275
|
- **Flow**: implicit
|
|
230
276
|
- **Authorization URL**: https://accounts.artik.cloud/authorize
|
|
231
|
-
- **Scopes**:
|
|
277
|
+
- **Scopes**:
|
|
232
278
|
- read:artikcloud: Read from ARTIK Cloud
|
|
233
279
|
- write:artikcloud: Write from ARTIK Cloud
|
|
234
280
|
|
data/artikcloud.gemspec
CHANGED
|
@@ -1,4 +1,28 @@
|
|
|
1
1
|
# -*- encoding: utf-8 -*-
|
|
2
|
+
#
|
|
3
|
+
=begin
|
|
4
|
+
#ARTIK Cloud API
|
|
5
|
+
|
|
6
|
+
#No descripton provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
|
|
7
|
+
|
|
8
|
+
OpenAPI spec version: 2.0.0
|
|
9
|
+
|
|
10
|
+
Generated by: https://github.com/swagger-api/swagger-codegen.git
|
|
11
|
+
|
|
12
|
+
Licensed under the Apache License, Version 2.0 (the "License");
|
|
13
|
+
you may not use this file except in compliance with the License.
|
|
14
|
+
You may obtain a copy of the License at
|
|
15
|
+
|
|
16
|
+
http://www.apache.org/licenses/LICENSE-2.0
|
|
17
|
+
|
|
18
|
+
Unless required by applicable law or agreed to in writing, software
|
|
19
|
+
distributed under the License is distributed on an "AS IS" BASIS,
|
|
20
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
21
|
+
See the License for the specific language governing permissions and
|
|
22
|
+
limitations under the License.
|
|
23
|
+
|
|
24
|
+
=end
|
|
25
|
+
|
|
2
26
|
$:.push File.expand_path("../lib", __FILE__)
|
|
3
27
|
require "artikcloud/version"
|
|
4
28
|
|
|
@@ -6,12 +30,12 @@ Gem::Specification.new do |s|
|
|
|
6
30
|
s.name = "artikcloud"
|
|
7
31
|
s.version = ArtikCloud::VERSION
|
|
8
32
|
s.platform = Gem::Platform::RUBY
|
|
9
|
-
s.authors = ["
|
|
10
|
-
s.email = ["
|
|
11
|
-
s.homepage = "http://github.com/artikcloud/artikcloud-ruby"
|
|
12
|
-
s.summary = "ArtikCloud Ruby
|
|
33
|
+
s.authors = ["ARTIK Cloud"]
|
|
34
|
+
s.email = [""]
|
|
35
|
+
s.homepage = "http://github.com/artikcloud/artikcloud-ruby-dev"
|
|
36
|
+
s.summary = "ArtikCloud Ruby SDK"
|
|
13
37
|
s.description = "A ruby wrapper for the ArtikCloud REST APIs"
|
|
14
|
-
s.license = "
|
|
38
|
+
s.license = "MIT"
|
|
15
39
|
|
|
16
40
|
s.add_runtime_dependency 'typhoeus', '~> 1.0', '>= 1.0.1'
|
|
17
41
|
s.add_runtime_dependency 'json', '~> 1.8', '>= 1.8.3'
|
data/docs/DeviceTask.md
ADDED
|
@@ -0,0 +1,13 @@
|
|
|
1
|
+
# ArtikCloud::DeviceTask
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
Name | Type | Description | Notes
|
|
5
|
+
------------ | ------------- | ------------- | -------------
|
|
6
|
+
**num_attempts** | **Integer** | Number of attempts | [optional]
|
|
7
|
+
**error_message** | **String** | Error Message | [optional]
|
|
8
|
+
**error_code** | **String** | Error Code | [optional]
|
|
9
|
+
**did** | **String** | Device ID | [optional]
|
|
10
|
+
**status** | **String** | Status | [optional]
|
|
11
|
+
**ts** | **Integer** | Timestamp of most recent status change | [optional]
|
|
12
|
+
|
|
13
|
+
|
|
@@ -0,0 +1,14 @@
|
|
|
1
|
+
# ArtikCloud::DeviceTypeInfo
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
Name | Type | Description | Notes
|
|
5
|
+
------------ | ------------- | ------------- | -------------
|
|
6
|
+
**device_properties_enabled** | **BOOLEAN** | Device Properties Enabled | [optional]
|
|
7
|
+
**pmax** | **Integer** | Pmax value | [optional]
|
|
8
|
+
**modified_on** | **Integer** | Modified on | [optional]
|
|
9
|
+
**dtid** | **String** | Device Type ID | [optional]
|
|
10
|
+
**pmin** | **Integer** | Pmin value | [optional]
|
|
11
|
+
**task_expires_after** | **Integer** | Default task expiration time in seconds | [optional]
|
|
12
|
+
**created_on** | **Integer** | Created on | [optional]
|
|
13
|
+
|
|
14
|
+
|
data/docs/DeviceTypesApi.md
CHANGED
|
@@ -7,6 +7,7 @@ Method | HTTP request | Description
|
|
|
7
7
|
[**get_available_manifest_versions**](DeviceTypesApi.md#get_available_manifest_versions) | **GET** /devicetypes/{deviceTypeId}/availablemanifestversions | Get Available Manifest Versions
|
|
8
8
|
[**get_device_type**](DeviceTypesApi.md#get_device_type) | **GET** /devicetypes/{deviceTypeId} | Get Device Type
|
|
9
9
|
[**get_device_types**](DeviceTypesApi.md#get_device_types) | **GET** /devicetypes | Get Device Types
|
|
10
|
+
[**get_device_types_by_application**](DeviceTypesApi.md#get_device_types_by_application) | **GET** /applications/{appId}/devicetypes | Get Device Types by Application
|
|
10
11
|
[**get_latest_manifest_properties**](DeviceTypesApi.md#get_latest_manifest_properties) | **GET** /devicetypes/{deviceTypeId}/manifests/latest/properties | Get Latest Manifest Properties
|
|
11
12
|
[**get_manifest_properties**](DeviceTypesApi.md#get_manifest_properties) | **GET** /devicetypes/{deviceTypeId}/manifests/{version}/properties | Get manifest properties
|
|
12
13
|
|
|
@@ -175,6 +176,66 @@ Name | Type | Description | Notes
|
|
|
175
176
|
|
|
176
177
|
|
|
177
178
|
|
|
179
|
+
# **get_device_types_by_application**
|
|
180
|
+
> DeviceTypesEnvelope get_device_types_by_application(app_id, opts)
|
|
181
|
+
|
|
182
|
+
Get Device Types by Application
|
|
183
|
+
|
|
184
|
+
Get Device Types by Application
|
|
185
|
+
|
|
186
|
+
### Example
|
|
187
|
+
```ruby
|
|
188
|
+
# load the gem
|
|
189
|
+
require 'artikcloud'
|
|
190
|
+
# setup authorization
|
|
191
|
+
ArtikCloud.configure do |config|
|
|
192
|
+
# Configure OAuth2 access token for authorization: artikcloud_oauth
|
|
193
|
+
config.access_token = 'YOUR ACCESS TOKEN'
|
|
194
|
+
end
|
|
195
|
+
|
|
196
|
+
api_instance = ArtikCloud::DeviceTypesApi.new
|
|
197
|
+
|
|
198
|
+
app_id = "app_id_example" # String | Application ID.
|
|
199
|
+
|
|
200
|
+
opts = {
|
|
201
|
+
product_info: true, # BOOLEAN | Flag to include the associated ProductInfo if present
|
|
202
|
+
count: 56, # Integer | Desired count of items in the result set.
|
|
203
|
+
offset: 56 # Integer | Offset for pagination.
|
|
204
|
+
}
|
|
205
|
+
|
|
206
|
+
begin
|
|
207
|
+
#Get Device Types by Application
|
|
208
|
+
result = api_instance.get_device_types_by_application(app_id, opts)
|
|
209
|
+
p result
|
|
210
|
+
rescue ArtikCloud::ApiError => e
|
|
211
|
+
puts "Exception when calling DeviceTypesApi->get_device_types_by_application: #{e}"
|
|
212
|
+
end
|
|
213
|
+
```
|
|
214
|
+
|
|
215
|
+
### Parameters
|
|
216
|
+
|
|
217
|
+
Name | Type | Description | Notes
|
|
218
|
+
------------- | ------------- | ------------- | -------------
|
|
219
|
+
**app_id** | **String**| Application ID. |
|
|
220
|
+
**product_info** | **BOOLEAN**| Flag to include the associated ProductInfo if present | [optional]
|
|
221
|
+
**count** | **Integer**| Desired count of items in the result set. | [optional]
|
|
222
|
+
**offset** | **Integer**| Offset for pagination. | [optional]
|
|
223
|
+
|
|
224
|
+
### Return type
|
|
225
|
+
|
|
226
|
+
[**DeviceTypesEnvelope**](DeviceTypesEnvelope.md)
|
|
227
|
+
|
|
228
|
+
### Authorization
|
|
229
|
+
|
|
230
|
+
[artikcloud_oauth](../README.md#artikcloud_oauth)
|
|
231
|
+
|
|
232
|
+
### HTTP request headers
|
|
233
|
+
|
|
234
|
+
- **Content-Type**: Not defined
|
|
235
|
+
- **Accept**: application/json
|
|
236
|
+
|
|
237
|
+
|
|
238
|
+
|
|
178
239
|
# **get_latest_manifest_properties**
|
|
179
240
|
> ManifestPropertiesEnvelope get_latest_manifest_properties(device_type_id)
|
|
180
241
|
|
|
@@ -0,0 +1,14 @@
|
|
|
1
|
+
# ArtikCloud::DeviceTypesInfo
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
Name | Type | Description | Notes
|
|
5
|
+
------------ | ------------- | ------------- | -------------
|
|
6
|
+
**device_properties_enabled** | **BOOLEAN** | Device Properties Enabled | [optional]
|
|
7
|
+
**pmax** | **Integer** | Pmax value | [optional]
|
|
8
|
+
**modified_on** | **Integer** | Modified on | [optional]
|
|
9
|
+
**dtid** | **String** | Device Type ID | [optional]
|
|
10
|
+
**pmin** | **Integer** | Pmin value | [optional]
|
|
11
|
+
**task_expires_after** | **Integer** | Default task expiration time in seconds | [optional]
|
|
12
|
+
**created_on** | **Integer** | Created on | [optional]
|
|
13
|
+
|
|
14
|
+
|