artikcloud 2.0.8 → 2.1.0
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 +5 -2
- data/LICENSE +1 -1
- data/README.md +39 -4
- data/Rakefile +8 -0
- data/artikcloud.gemspec +5 -16
- data/docs/Device.md +2 -0
- data/docs/DeviceShareInfo.md +8 -0
- data/docs/DeviceSharing.md +11 -0
- data/docs/DeviceSharingArray.md +8 -0
- data/docs/DeviceSharingEnvelope.md +11 -0
- data/docs/DeviceSharingId.md +8 -0
- data/docs/DeviceStatus.md +9 -0
- data/docs/DeviceStatusBatch.md +11 -0
- data/docs/DeviceStatusData.md +12 -0
- data/docs/DeviceStatusPut.md +8 -0
- data/docs/DeviceStatusPutData.md +8 -0
- data/docs/DevicessharesApi.md +235 -0
- data/docs/DevicestatusApi.md +183 -0
- data/docs/NotifMessage.md +15 -0
- data/docs/NotifMessageArray.md +8 -0
- data/docs/NotifMessagesResponse.md +12 -0
- data/docs/Subscription.md +24 -0
- data/docs/SubscriptionArray.md +8 -0
- data/docs/SubscriptionEnvelope.md +8 -0
- data/docs/SubscriptionInfo.md +20 -0
- data/docs/SubscriptionsApi.md +342 -0
- data/docs/SubscriptionsEnvelope.md +11 -0
- data/docs/TaskParameters.md +2 -0
- data/docs/UpdateParameters.md +8 -0
- data/docs/UsersApi.md +67 -1
- data/docs/ValidationCallbackInfo.md +9 -0
- data/git_push.sh +0 -12
- data/lib/artikcloud.rb +24 -13
- data/lib/artikcloud/api/device_types_api.rb +7 -55
- data/lib/artikcloud/api/devices_api.rb +12 -66
- data/lib/artikcloud/api/devices_management_api.rb +16 -118
- data/lib/artikcloud/api/devicesshares_api.rb +244 -0
- data/lib/artikcloud/api/devicestatus_api.rb +190 -0
- data/lib/artikcloud/api/export_api.rb +5 -41
- data/lib/artikcloud/api/messages_api.rb +10 -76
- data/lib/artikcloud/api/registrations_api.rb +4 -34
- data/lib/artikcloud/api/rules_api.rb +5 -41
- data/lib/artikcloud/api/subscriptions_api.rb +346 -0
- data/lib/artikcloud/api/tags_api.rb +4 -34
- data/lib/artikcloud/api/tokens_api.rb +5 -33
- data/lib/artikcloud/api/users_api.rb +79 -67
- data/lib/artikcloud/api_client.rb +17 -20
- data/lib/artikcloud/api_error.rb +8 -18
- data/lib/artikcloud/configuration.rb +1 -13
- data/lib/artikcloud/models/ack_envelope.rb +4 -16
- data/lib/artikcloud/models/acknowledgement.rb +4 -16
- data/lib/artikcloud/models/action.rb +4 -16
- data/lib/artikcloud/models/action_array.rb +4 -16
- data/lib/artikcloud/models/action_details.rb +4 -16
- data/lib/artikcloud/models/action_details_array.rb +4 -16
- data/lib/artikcloud/models/action_in.rb +4 -16
- data/lib/artikcloud/models/action_out.rb +4 -16
- data/lib/artikcloud/models/actions.rb +4 -16
- data/lib/artikcloud/models/aggregate_data.rb +4 -16
- data/lib/artikcloud/models/aggregates_histogram_data.rb +4 -16
- data/lib/artikcloud/models/aggregates_histogram_response.rb +4 -16
- data/lib/artikcloud/models/aggregates_response.rb +4 -16
- data/lib/artikcloud/models/app_properties.rb +8 -16
- data/lib/artikcloud/models/check_token_message.rb +4 -16
- data/lib/artikcloud/models/check_token_response.rb +4 -16
- data/lib/artikcloud/models/device.rb +28 -20
- data/lib/artikcloud/models/device_array.rb +4 -16
- data/lib/artikcloud/models/device_envelope.rb +8 -16
- data/lib/artikcloud/models/device_reg_complete_request.rb +4 -16
- data/lib/artikcloud/models/device_reg_confirm_user_request.rb +4 -16
- data/lib/artikcloud/models/device_reg_confirm_user_response.rb +4 -16
- data/lib/artikcloud/models/device_reg_confirm_user_response_envelope.rb +4 -16
- data/lib/artikcloud/models/device_reg_status_response.rb +4 -16
- data/lib/artikcloud/models/device_reg_status_response_envelope.rb +4 -16
- data/lib/artikcloud/models/device_share_info.rb +188 -0
- data/lib/artikcloud/models/device_sharing.rb +218 -0
- data/lib/artikcloud/models/device_sharing_array.rb +189 -0
- data/lib/artikcloud/models/device_sharing_envelope.rb +214 -0
- data/lib/artikcloud/models/device_sharing_id.rb +188 -0
- data/lib/artikcloud/models/device_status.rb +196 -0
- data/lib/artikcloud/models/device_status_batch.rb +216 -0
- data/lib/artikcloud/models/device_status_data.rb +225 -0
- data/lib/artikcloud/models/device_status_put.rb +187 -0
- data/lib/artikcloud/models/device_status_put_data.rb +187 -0
- data/lib/artikcloud/models/device_task.rb +4 -16
- data/lib/artikcloud/models/device_task_update_request.rb +4 -16
- data/lib/artikcloud/models/device_task_update_response.rb +4 -16
- data/lib/artikcloud/models/device_token.rb +20 -16
- data/lib/artikcloud/models/device_token_envelope.rb +8 -16
- data/lib/artikcloud/models/device_type.rb +4 -16
- data/lib/artikcloud/models/device_type_array.rb +4 -16
- data/lib/artikcloud/models/device_type_envelope.rb +8 -16
- data/lib/artikcloud/models/device_type_info.rb +4 -16
- data/lib/artikcloud/models/device_type_info_envelope.rb +4 -16
- data/lib/artikcloud/models/device_types_envelope.rb +16 -16
- data/lib/artikcloud/models/device_types_info.rb +4 -16
- data/lib/artikcloud/models/device_types_info_envelope.rb +4 -16
- data/lib/artikcloud/models/devices_envelope.rb +16 -16
- data/lib/artikcloud/models/error_envelope.rb +4 -16
- data/lib/artikcloud/models/event_feed_data.rb +4 -16
- data/lib/artikcloud/models/export_data.rb +4 -16
- data/lib/artikcloud/models/export_data_array.rb +4 -16
- data/lib/artikcloud/models/export_history_response.rb +4 -16
- data/lib/artikcloud/models/export_normalized_messages_response.rb +4 -16
- data/lib/artikcloud/models/export_request.rb +4 -16
- data/lib/artikcloud/models/export_request_data.rb +4 -16
- data/lib/artikcloud/models/export_request_info.rb +4 -16
- data/lib/artikcloud/models/export_request_response.rb +4 -16
- data/lib/artikcloud/models/export_response.rb +4 -16
- data/lib/artikcloud/models/export_status_response.rb +4 -16
- data/lib/artikcloud/models/field_path.rb +4 -16
- data/lib/artikcloud/models/field_presence.rb +8 -16
- data/lib/artikcloud/models/field_presence_envelope.rb +32 -16
- data/lib/artikcloud/models/fields_actions.rb +4 -16
- data/lib/artikcloud/models/manifest_properties.rb +8 -16
- data/lib/artikcloud/models/manifest_properties_envelope.rb +8 -16
- data/lib/artikcloud/models/manifest_versions.rb +8 -16
- data/lib/artikcloud/models/manifest_versions_envelope.rb +8 -16
- data/lib/artikcloud/models/message.rb +4 -16
- data/lib/artikcloud/models/message_action.rb +4 -16
- data/lib/artikcloud/models/message_id.rb +4 -16
- data/lib/artikcloud/models/message_id_envelope.rb +4 -16
- data/lib/artikcloud/models/message_in.rb +4 -16
- data/lib/artikcloud/models/message_out.rb +4 -16
- data/lib/artikcloud/models/metadata_envelope.rb +4 -16
- data/lib/artikcloud/models/metadata_properties_envelope.rb +4 -16
- data/lib/artikcloud/models/metadata_query_envelope.rb +4 -16
- data/lib/artikcloud/models/non_empty_string.rb +4 -16
- data/lib/artikcloud/models/normalized_action.rb +36 -16
- data/lib/artikcloud/models/normalized_actions_envelope.rb +16 -16
- data/lib/artikcloud/models/normalized_message.rb +36 -16
- data/lib/artikcloud/models/normalized_messages_envelope.rb +16 -16
- data/lib/artikcloud/models/notif_message.rb +252 -0
- data/lib/artikcloud/models/notif_message_array.rb +189 -0
- data/lib/artikcloud/models/notif_messages_response.rb +223 -0
- data/lib/artikcloud/models/output_rule.rb +4 -16
- data/lib/artikcloud/models/presence_envelope.rb +4 -16
- data/lib/artikcloud/models/presence_model.rb +4 -16
- data/lib/artikcloud/models/properties_envelope.rb +8 -16
- data/lib/artikcloud/models/refresh_token_response.rb +4 -16
- data/lib/artikcloud/models/register_message.rb +4 -16
- data/lib/artikcloud/models/rule_array.rb +4 -16
- data/lib/artikcloud/models/rule_creation_info.rb +4 -16
- data/lib/artikcloud/models/rule_envelope.rb +4 -16
- data/lib/artikcloud/models/rule_error.rb +4 -16
- data/lib/artikcloud/models/rule_update_info.rb +4 -16
- data/lib/artikcloud/models/rule_warning_output.rb +4 -16
- data/lib/artikcloud/models/rules_envelope.rb +4 -16
- data/lib/artikcloud/models/snapshot_response.rb +4 -16
- data/lib/artikcloud/models/snapshot_responses.rb +4 -16
- data/lib/artikcloud/models/snapshots_response_envelope.rb +4 -16
- data/lib/artikcloud/models/subscription.rb +348 -0
- data/lib/artikcloud/models/subscription_array.rb +189 -0
- data/lib/artikcloud/models/subscription_envelope.rb +187 -0
- data/lib/artikcloud/models/subscription_info.rb +308 -0
- data/lib/artikcloud/models/subscriptions_envelope.rb +214 -0
- data/lib/artikcloud/models/tag.rb +4 -16
- data/lib/artikcloud/models/tag_array.rb +4 -16
- data/lib/artikcloud/models/tags_envelope.rb +4 -16
- data/lib/artikcloud/models/task.rb +4 -16
- data/lib/artikcloud/models/task_by_did.rb +4 -16
- data/lib/artikcloud/models/task_by_did_list.rb +4 -16
- data/lib/artikcloud/models/task_by_did_list_envelope.rb +4 -16
- data/lib/artikcloud/models/task_envelope.rb +4 -16
- data/lib/artikcloud/models/task_history.rb +4 -16
- data/lib/artikcloud/models/task_history_list.rb +4 -16
- data/lib/artikcloud/models/task_list.rb +4 -16
- data/lib/artikcloud/models/task_list_envelope.rb +4 -16
- data/lib/artikcloud/models/task_parameters.rb +25 -17
- data/lib/artikcloud/models/task_request.rb +4 -16
- data/lib/artikcloud/models/task_status.rb +4 -16
- data/lib/artikcloud/models/task_status_counts.rb +4 -16
- data/lib/artikcloud/models/task_statuses.rb +4 -16
- data/lib/artikcloud/models/task_statuses_envelope.rb +4 -16
- data/lib/artikcloud/models/task_statuses_history_envelope.rb +4 -16
- data/lib/artikcloud/models/task_update_request.rb +4 -16
- data/lib/artikcloud/models/task_update_response.rb +4 -16
- data/lib/artikcloud/models/tasks_status_counts.rb +4 -16
- data/lib/artikcloud/models/token.rb +4 -16
- data/lib/artikcloud/models/token_info.rb +4 -16
- data/lib/artikcloud/models/token_info_success_response.rb +4 -16
- data/lib/artikcloud/models/token_request.rb +4 -16
- data/lib/artikcloud/models/token_response.rb +4 -16
- data/lib/artikcloud/models/unregister_device_response.rb +4 -16
- data/lib/artikcloud/models/unregister_device_response_envelope.rb +4 -16
- data/lib/artikcloud/models/update_parameters.rb +188 -0
- data/lib/artikcloud/models/user.rb +28 -16
- data/lib/artikcloud/models/user_envelope.rb +8 -16
- data/lib/artikcloud/models/validation_callback_info.rb +198 -0
- data/lib/artikcloud/models/web_socket_error.rb +4 -16
- data/lib/artikcloud/version.rb +2 -14
- data/pom.xml +1 -1
- data/spec/api/devicesshares_api_spec.rb +87 -0
- data/spec/api/devicestatus_api_spec.rb +75 -0
- data/spec/api/subscriptions_api_spec.rb +112 -0
- metadata +58 -26
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA1:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: 0ed610d63d374bf43e8169c14a398906cd3b300c
|
|
4
|
+
data.tar.gz: 27c887d5037e6473897d04b0bdd7e635f6826070
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: 3649ddf610747315e100363aec1f0fddfe3ff065e035d01b4528b32f17f870f4a4763e23839cd305694302f4c56bf176a38427cfaf1706deea83d2a35acd8041
|
|
7
|
+
data.tar.gz: 69836363104febb7113f9d4c026373e1dc5980660615495a10e8d6f36e7e14bb00ffd4de87f809f8b3e00cb2e0dcf1993ac9aa4c8f2bde6c0672e9c33da05af1
|
data/Gemfile
CHANGED
data/LICENSE
CHANGED
|
@@ -186,7 +186,7 @@
|
|
|
186
186
|
same "printed page" as the copyright notice for easier
|
|
187
187
|
identification within third-party archives.
|
|
188
188
|
|
|
189
|
-
Copyright
|
|
189
|
+
Copyright 2017 Samsung Electronics Co., Ltd.
|
|
190
190
|
|
|
191
191
|
Licensed under the Apache License, Version 2.0 (the "License");
|
|
192
192
|
you may not use this file except in compliance with the License.
|
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.1.0.gem
|
|
22
22
|
```
|
|
23
|
-
(for development, run `gem install --dev ./artikcloud-2.0.
|
|
23
|
+
(for development, run `gem install --dev ./artikcloud-2.1.0.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.1.0'
|
|
30
30
|
|
|
31
31
|
### Install from Git
|
|
32
32
|
|
|
@@ -105,6 +105,13 @@ Class | Method | HTTP request | Description
|
|
|
105
105
|
*ArtikCloud::DevicesManagementApi* | [**update_server_properties**](docs/DevicesManagementApi.md#update_server_properties) | **POST** /devicemgmt/devices/{did}/serverproperties | Updates a device's server properties.
|
|
106
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
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.
|
|
108
|
+
*ArtikCloud::DevicessharesApi* | [**create_share_for_device**](docs/DevicessharesApi.md#create_share_for_device) | **POST** in/api/devices/{deviceId}/shares | Share a device
|
|
109
|
+
*ArtikCloud::DevicessharesApi* | [**delete_sharing_for_device**](docs/DevicessharesApi.md#delete_sharing_for_device) | **DELETE** in/api/devices/{deviceId}/shares/{shareId} | Delete specific share of the given device id
|
|
110
|
+
*ArtikCloud::DevicessharesApi* | [**get_all_shares_for_device**](docs/DevicessharesApi.md#get_all_shares_for_device) | **GET** in/api/devices/{deviceId}/shares | List all shares for the given device id
|
|
111
|
+
*ArtikCloud::DevicessharesApi* | [**get_sharing_for_device**](docs/DevicessharesApi.md#get_sharing_for_device) | **GET** in/api/devices/{deviceId}/shares/{shareId} | Get specific share of the given device id
|
|
112
|
+
*ArtikCloud::DevicestatusApi* | [**get_device_status**](docs/DevicestatusApi.md#get_device_status) | **GET** /devices/{deviceId}/status | Get Device Status
|
|
113
|
+
*ArtikCloud::DevicestatusApi* | [**get_devices_status**](docs/DevicestatusApi.md#get_devices_status) | **GET** /devices/status | Get Devices Status
|
|
114
|
+
*ArtikCloud::DevicestatusApi* | [**put_device_status**](docs/DevicestatusApi.md#put_device_status) | **PUT** /devices/{deviceId}/status | Update Device Status
|
|
108
115
|
*ArtikCloud::ExportApi* | [**export_request**](docs/ExportApi.md#export_request) | **POST** /messages/export | Create Export Request
|
|
109
116
|
*ArtikCloud::ExportApi* | [**get_export_history**](docs/ExportApi.md#get_export_history) | **GET** /messages/export/history | Get Export History
|
|
110
117
|
*ArtikCloud::ExportApi* | [**get_export_result**](docs/ExportApi.md#get_export_result) | **GET** /messages/export/{exportId}/result | Get Export Result
|
|
@@ -125,6 +132,12 @@ Class | Method | HTTP request | Description
|
|
|
125
132
|
*ArtikCloud::RulesApi* | [**delete_rule**](docs/RulesApi.md#delete_rule) | **DELETE** /rules/{ruleId} | Delete Rule
|
|
126
133
|
*ArtikCloud::RulesApi* | [**get_rule**](docs/RulesApi.md#get_rule) | **GET** /rules/{ruleId} | Get Rule
|
|
127
134
|
*ArtikCloud::RulesApi* | [**update_rule**](docs/RulesApi.md#update_rule) | **PUT** /rules/{ruleId} | Update Rule
|
|
135
|
+
*ArtikCloud::SubscriptionsApi* | [**create_subscription**](docs/SubscriptionsApi.md#create_subscription) | **POST** /subscriptions | Create Subscription
|
|
136
|
+
*ArtikCloud::SubscriptionsApi* | [**delete_subscription**](docs/SubscriptionsApi.md#delete_subscription) | **DELETE** /subscriptions/{subId} | Delete Subscription
|
|
137
|
+
*ArtikCloud::SubscriptionsApi* | [**get_all_subscriptions**](docs/SubscriptionsApi.md#get_all_subscriptions) | **GET** /subscriptions | Get All Subscriptions
|
|
138
|
+
*ArtikCloud::SubscriptionsApi* | [**get_messages**](docs/SubscriptionsApi.md#get_messages) | **GET** /notifications/{notifId}/messages | Get Messages
|
|
139
|
+
*ArtikCloud::SubscriptionsApi* | [**get_subscription**](docs/SubscriptionsApi.md#get_subscription) | **GET** /subscriptions/{subId} | Get Subscription
|
|
140
|
+
*ArtikCloud::SubscriptionsApi* | [**validate_subscription**](docs/SubscriptionsApi.md#validate_subscription) | **POST** /subscriptions/{subId}/validate | Validate Subscription
|
|
128
141
|
*ArtikCloud::TagsApi* | [**get_tag_categories**](docs/TagsApi.md#get_tag_categories) | **GET** /tags/categories | Get all categories
|
|
129
142
|
*ArtikCloud::TagsApi* | [**get_tag_suggestions**](docs/TagsApi.md#get_tag_suggestions) | **GET** /tags/suggestions | Get tag suggestions
|
|
130
143
|
*ArtikCloud::TagsApi* | [**get_tags_by_categories**](docs/TagsApi.md#get_tags_by_categories) | **GET** /tags | Get all tags of categories
|
|
@@ -138,6 +151,7 @@ Class | Method | HTTP request | Description
|
|
|
138
151
|
*ArtikCloud::UsersApi* | [**get_user_devices**](docs/UsersApi.md#get_user_devices) | **GET** /users/{userId}/devices | Get User Devices
|
|
139
152
|
*ArtikCloud::UsersApi* | [**get_user_properties**](docs/UsersApi.md#get_user_properties) | **GET** /users/{userId}/properties | Get User application properties
|
|
140
153
|
*ArtikCloud::UsersApi* | [**get_user_rules**](docs/UsersApi.md#get_user_rules) | **GET** /users/{userId}/rules | Get User Rules
|
|
154
|
+
*ArtikCloud::UsersApi* | [**list_all_shares_for_user**](docs/UsersApi.md#list_all_shares_for_user) | **GET** in/api/users/{userId}/shares | Get User shares
|
|
141
155
|
*ArtikCloud::UsersApi* | [**update_user_properties**](docs/UsersApi.md#update_user_properties) | **PUT** /users/{userId}/properties | Update User Application Properties
|
|
142
156
|
|
|
143
157
|
|
|
@@ -168,6 +182,16 @@ Class | Method | HTTP request | Description
|
|
|
168
182
|
- [ArtikCloud::DeviceRegConfirmUserResponseEnvelope](docs/DeviceRegConfirmUserResponseEnvelope.md)
|
|
169
183
|
- [ArtikCloud::DeviceRegStatusResponse](docs/DeviceRegStatusResponse.md)
|
|
170
184
|
- [ArtikCloud::DeviceRegStatusResponseEnvelope](docs/DeviceRegStatusResponseEnvelope.md)
|
|
185
|
+
- [ArtikCloud::DeviceShareInfo](docs/DeviceShareInfo.md)
|
|
186
|
+
- [ArtikCloud::DeviceSharing](docs/DeviceSharing.md)
|
|
187
|
+
- [ArtikCloud::DeviceSharingArray](docs/DeviceSharingArray.md)
|
|
188
|
+
- [ArtikCloud::DeviceSharingEnvelope](docs/DeviceSharingEnvelope.md)
|
|
189
|
+
- [ArtikCloud::DeviceSharingId](docs/DeviceSharingId.md)
|
|
190
|
+
- [ArtikCloud::DeviceStatus](docs/DeviceStatus.md)
|
|
191
|
+
- [ArtikCloud::DeviceStatusBatch](docs/DeviceStatusBatch.md)
|
|
192
|
+
- [ArtikCloud::DeviceStatusData](docs/DeviceStatusData.md)
|
|
193
|
+
- [ArtikCloud::DeviceStatusPut](docs/DeviceStatusPut.md)
|
|
194
|
+
- [ArtikCloud::DeviceStatusPutData](docs/DeviceStatusPutData.md)
|
|
171
195
|
- [ArtikCloud::DeviceTask](docs/DeviceTask.md)
|
|
172
196
|
- [ArtikCloud::DeviceTaskUpdateRequest](docs/DeviceTaskUpdateRequest.md)
|
|
173
197
|
- [ArtikCloud::DeviceTaskUpdateResponse](docs/DeviceTaskUpdateResponse.md)
|
|
@@ -216,6 +240,9 @@ Class | Method | HTTP request | Description
|
|
|
216
240
|
- [ArtikCloud::NormalizedActionsEnvelope](docs/NormalizedActionsEnvelope.md)
|
|
217
241
|
- [ArtikCloud::NormalizedMessage](docs/NormalizedMessage.md)
|
|
218
242
|
- [ArtikCloud::NormalizedMessagesEnvelope](docs/NormalizedMessagesEnvelope.md)
|
|
243
|
+
- [ArtikCloud::NotifMessage](docs/NotifMessage.md)
|
|
244
|
+
- [ArtikCloud::NotifMessageArray](docs/NotifMessageArray.md)
|
|
245
|
+
- [ArtikCloud::NotifMessagesResponse](docs/NotifMessagesResponse.md)
|
|
219
246
|
- [ArtikCloud::OutputRule](docs/OutputRule.md)
|
|
220
247
|
- [ArtikCloud::PresenceEnvelope](docs/PresenceEnvelope.md)
|
|
221
248
|
- [ArtikCloud::PresenceModel](docs/PresenceModel.md)
|
|
@@ -232,6 +259,11 @@ Class | Method | HTTP request | Description
|
|
|
232
259
|
- [ArtikCloud::SnapshotResponse](docs/SnapshotResponse.md)
|
|
233
260
|
- [ArtikCloud::SnapshotResponses](docs/SnapshotResponses.md)
|
|
234
261
|
- [ArtikCloud::SnapshotsResponseEnvelope](docs/SnapshotsResponseEnvelope.md)
|
|
262
|
+
- [ArtikCloud::Subscription](docs/Subscription.md)
|
|
263
|
+
- [ArtikCloud::SubscriptionArray](docs/SubscriptionArray.md)
|
|
264
|
+
- [ArtikCloud::SubscriptionEnvelope](docs/SubscriptionEnvelope.md)
|
|
265
|
+
- [ArtikCloud::SubscriptionInfo](docs/SubscriptionInfo.md)
|
|
266
|
+
- [ArtikCloud::SubscriptionsEnvelope](docs/SubscriptionsEnvelope.md)
|
|
235
267
|
- [ArtikCloud::Tag](docs/Tag.md)
|
|
236
268
|
- [ArtikCloud::TagArray](docs/TagArray.md)
|
|
237
269
|
- [ArtikCloud::TagsEnvelope](docs/TagsEnvelope.md)
|
|
@@ -261,11 +293,14 @@ Class | Method | HTTP request | Description
|
|
|
261
293
|
- [ArtikCloud::TokenResponse](docs/TokenResponse.md)
|
|
262
294
|
- [ArtikCloud::UnregisterDeviceResponse](docs/UnregisterDeviceResponse.md)
|
|
263
295
|
- [ArtikCloud::UnregisterDeviceResponseEnvelope](docs/UnregisterDeviceResponseEnvelope.md)
|
|
296
|
+
- [ArtikCloud::UpdateParameters](docs/UpdateParameters.md)
|
|
264
297
|
- [ArtikCloud::User](docs/User.md)
|
|
265
298
|
- [ArtikCloud::UserEnvelope](docs/UserEnvelope.md)
|
|
299
|
+
- [ArtikCloud::ValidationCallbackInfo](docs/ValidationCallbackInfo.md)
|
|
266
300
|
- [ArtikCloud::WebSocketError](docs/WebSocketError.md)
|
|
267
301
|
|
|
268
302
|
|
|
303
|
+
|
|
269
304
|
## Documentation for Authorization
|
|
270
305
|
|
|
271
306
|
|
|
@@ -296,4 +331,4 @@ License and Copyright
|
|
|
296
331
|
|
|
297
332
|
Licensed under the Apache License. See [LICENSE](https://github.com/artikcloud/artikcloud-ruby/blob/master/LICENSE).
|
|
298
333
|
|
|
299
|
-
Copyright (c)
|
|
334
|
+
Copyright (c) 2017 Samsung Electronics Co., Ltd.
|
data/Rakefile
ADDED
data/artikcloud.gemspec
CHANGED
|
@@ -3,24 +3,12 @@
|
|
|
3
3
|
=begin
|
|
4
4
|
#ARTIK Cloud API
|
|
5
5
|
|
|
6
|
-
#No
|
|
6
|
+
#No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
|
|
7
7
|
|
|
8
8
|
OpenAPI spec version: 2.0.0
|
|
9
9
|
|
|
10
10
|
Generated by: https://github.com/swagger-api/swagger-codegen.git
|
|
11
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
12
|
=end
|
|
25
13
|
|
|
26
14
|
$:.push File.expand_path("../lib", __FILE__)
|
|
@@ -30,12 +18,14 @@ Gem::Specification.new do |s|
|
|
|
30
18
|
s.name = "artikcloud"
|
|
31
19
|
s.version = ArtikCloud::VERSION
|
|
32
20
|
s.platform = Gem::Platform::RUBY
|
|
33
|
-
s.authors = ["
|
|
21
|
+
s.authors = ["Swagger-Codegen"]
|
|
34
22
|
s.email = [""]
|
|
35
23
|
s.homepage = "http://github.com/artikcloud/artikcloud-ruby"
|
|
36
24
|
s.summary = "ArtikCloud Ruby SDK"
|
|
37
25
|
s.description = "A ruby wrapper for the ArtikCloud REST APIs"
|
|
38
|
-
|
|
26
|
+
# TODO uncommnet and update below with a proper license
|
|
27
|
+
#s.license = "Apache 2.0"
|
|
28
|
+
s.required_ruby_version = ">= 1.9"
|
|
39
29
|
|
|
40
30
|
s.add_runtime_dependency 'typhoeus', '~> 1.0', '>= 1.0.1'
|
|
41
31
|
s.add_runtime_dependency 'json', '~> 1.8', '>= 1.8.3'
|
|
@@ -47,7 +37,6 @@ Gem::Specification.new do |s|
|
|
|
47
37
|
s.add_development_dependency 'autotest-rails-pure', '~> 4.1', '>= 4.1.2'
|
|
48
38
|
s.add_development_dependency 'autotest-growl', '~> 0.2', '>= 0.2.16'
|
|
49
39
|
s.add_development_dependency 'autotest-fsevent', '~> 0.2', '>= 0.2.11'
|
|
50
|
-
s.add_development_dependency 'factory_girl', '~> 4.8', '>= 4.8.0'
|
|
51
40
|
|
|
52
41
|
s.files = `find *`.split("\n").uniq.sort.select{|f| !f.empty? }
|
|
53
42
|
s.test_files = `find spec/*`.split("\n")
|
data/docs/Device.md
CHANGED
|
@@ -17,5 +17,7 @@ Name | Type | Description | Notes
|
|
|
17
17
|
**certificate_signature** | **String** | Certificate Signature (if any) | [optional]
|
|
18
18
|
**eid** | **String** | External ID (if any) | [optional]
|
|
19
19
|
**provider_credentials** | **Hash<String, Object>** | | [optional]
|
|
20
|
+
**shared_with_others** | **BOOLEAN** | Is shared with other users | [optional]
|
|
21
|
+
**shared_with_me** | **String** | Share id (if shared with me) | [optional]
|
|
20
22
|
|
|
21
23
|
|
|
@@ -0,0 +1,11 @@
|
|
|
1
|
+
# ArtikCloud::DeviceSharing
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
Name | Type | Description | Notes
|
|
5
|
+
------------ | ------------- | ------------- | -------------
|
|
6
|
+
**id** | **String** | Share ID | [optional]
|
|
7
|
+
**email** | **String** | Email | [optional]
|
|
8
|
+
**status** | **String** | Status | [optional]
|
|
9
|
+
**shared_on** | **Integer** | Shared on | [optional]
|
|
10
|
+
|
|
11
|
+
|
|
@@ -0,0 +1,11 @@
|
|
|
1
|
+
# ArtikCloud::DeviceSharingEnvelope
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
Name | Type | Description | Notes
|
|
5
|
+
------------ | ------------- | ------------- | -------------
|
|
6
|
+
**total** | **Integer** | | [optional]
|
|
7
|
+
**offset** | **Integer** | | [optional]
|
|
8
|
+
**data** | [**DeviceSharingArray**](DeviceSharingArray.md) | | [optional]
|
|
9
|
+
**count** | **Integer** | | [optional]
|
|
10
|
+
|
|
11
|
+
|
|
@@ -0,0 +1,11 @@
|
|
|
1
|
+
# ArtikCloud::DeviceStatusBatch
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
Name | Type | Description | Notes
|
|
5
|
+
------------ | ------------- | ------------- | -------------
|
|
6
|
+
**total** | **Integer** | | [optional]
|
|
7
|
+
**offset** | **Integer** | | [optional]
|
|
8
|
+
**data** | [**Array<DeviceStatus>**](DeviceStatus.md) | | [optional]
|
|
9
|
+
**count** | **Integer** | | [optional]
|
|
10
|
+
|
|
11
|
+
|
|
@@ -0,0 +1,12 @@
|
|
|
1
|
+
# ArtikCloud::DeviceStatusData
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
Name | Type | Description | Notes
|
|
5
|
+
------------ | ------------- | ------------- | -------------
|
|
6
|
+
**last_time_online** | **Integer** | | [optional]
|
|
7
|
+
**last_action_ts** | **Integer** | | [optional]
|
|
8
|
+
**last_message_ts** | **Integer** | | [optional]
|
|
9
|
+
**availability** | **String** | | [optional]
|
|
10
|
+
**snapshot** | **Hash<String, Object>** | | [optional]
|
|
11
|
+
|
|
12
|
+
|
|
@@ -0,0 +1,235 @@
|
|
|
1
|
+
# ArtikCloud::DevicessharesApi
|
|
2
|
+
|
|
3
|
+
All URIs are relative to *https://api.artik.cloud/v1.1*
|
|
4
|
+
|
|
5
|
+
Method | HTTP request | Description
|
|
6
|
+
------------- | ------------- | -------------
|
|
7
|
+
[**create_share_for_device**](DevicessharesApi.md#create_share_for_device) | **POST** in/api/devices/{deviceId}/shares | Share a device
|
|
8
|
+
[**delete_sharing_for_device**](DevicessharesApi.md#delete_sharing_for_device) | **DELETE** in/api/devices/{deviceId}/shares/{shareId} | Delete specific share of the given device id
|
|
9
|
+
[**get_all_shares_for_device**](DevicessharesApi.md#get_all_shares_for_device) | **GET** in/api/devices/{deviceId}/shares | List all shares for the given device id
|
|
10
|
+
[**get_sharing_for_device**](DevicessharesApi.md#get_sharing_for_device) | **GET** in/api/devices/{deviceId}/shares/{shareId} | Get specific share of the given device id
|
|
11
|
+
|
|
12
|
+
|
|
13
|
+
# **create_share_for_device**
|
|
14
|
+
> DeviceSharingId create_share_for_device(device_id, device_share_info)
|
|
15
|
+
|
|
16
|
+
Share a device
|
|
17
|
+
|
|
18
|
+
Share a device
|
|
19
|
+
|
|
20
|
+
### Example
|
|
21
|
+
```ruby
|
|
22
|
+
# load the gem
|
|
23
|
+
require 'artikcloud'
|
|
24
|
+
# setup authorization
|
|
25
|
+
ArtikCloud.configure do |config|
|
|
26
|
+
# Configure OAuth2 access token for authorization: artikcloud_oauth
|
|
27
|
+
config.access_token = 'YOUR ACCESS TOKEN'
|
|
28
|
+
end
|
|
29
|
+
|
|
30
|
+
api_instance = ArtikCloud::DevicessharesApi.new
|
|
31
|
+
|
|
32
|
+
device_id = "device_id_example" # String | Device ID.
|
|
33
|
+
|
|
34
|
+
device_share_info = ArtikCloud::DeviceShareInfo.new # DeviceShareInfo | Device object that needs to be added
|
|
35
|
+
|
|
36
|
+
|
|
37
|
+
begin
|
|
38
|
+
#Share a device
|
|
39
|
+
result = api_instance.create_share_for_device(device_id, device_share_info)
|
|
40
|
+
p result
|
|
41
|
+
rescue ArtikCloud::ApiError => e
|
|
42
|
+
puts "Exception when calling DevicessharesApi->create_share_for_device: #{e}"
|
|
43
|
+
end
|
|
44
|
+
```
|
|
45
|
+
|
|
46
|
+
### Parameters
|
|
47
|
+
|
|
48
|
+
Name | Type | Description | Notes
|
|
49
|
+
------------- | ------------- | ------------- | -------------
|
|
50
|
+
**device_id** | **String**| Device ID. |
|
|
51
|
+
**device_share_info** | [**DeviceShareInfo**](DeviceShareInfo.md)| Device object that needs to be added |
|
|
52
|
+
|
|
53
|
+
### Return type
|
|
54
|
+
|
|
55
|
+
[**DeviceSharingId**](DeviceSharingId.md)
|
|
56
|
+
|
|
57
|
+
### Authorization
|
|
58
|
+
|
|
59
|
+
[artikcloud_oauth](../README.md#artikcloud_oauth)
|
|
60
|
+
|
|
61
|
+
### HTTP request headers
|
|
62
|
+
|
|
63
|
+
- **Content-Type**: Not defined
|
|
64
|
+
- **Accept**: application/json
|
|
65
|
+
|
|
66
|
+
|
|
67
|
+
|
|
68
|
+
# **delete_sharing_for_device**
|
|
69
|
+
> DeviceSharingId delete_sharing_for_device(device_id, share_id)
|
|
70
|
+
|
|
71
|
+
Delete specific share of the given device id
|
|
72
|
+
|
|
73
|
+
Delete specific share of the given device id
|
|
74
|
+
|
|
75
|
+
### Example
|
|
76
|
+
```ruby
|
|
77
|
+
# load the gem
|
|
78
|
+
require 'artikcloud'
|
|
79
|
+
# setup authorization
|
|
80
|
+
ArtikCloud.configure do |config|
|
|
81
|
+
# Configure OAuth2 access token for authorization: artikcloud_oauth
|
|
82
|
+
config.access_token = 'YOUR ACCESS TOKEN'
|
|
83
|
+
end
|
|
84
|
+
|
|
85
|
+
api_instance = ArtikCloud::DevicessharesApi.new
|
|
86
|
+
|
|
87
|
+
device_id = "device_id_example" # String | Device ID.
|
|
88
|
+
|
|
89
|
+
share_id = "share_id_example" # String | Share ID.
|
|
90
|
+
|
|
91
|
+
|
|
92
|
+
begin
|
|
93
|
+
#Delete specific share of the given device id
|
|
94
|
+
result = api_instance.delete_sharing_for_device(device_id, share_id)
|
|
95
|
+
p result
|
|
96
|
+
rescue ArtikCloud::ApiError => e
|
|
97
|
+
puts "Exception when calling DevicessharesApi->delete_sharing_for_device: #{e}"
|
|
98
|
+
end
|
|
99
|
+
```
|
|
100
|
+
|
|
101
|
+
### Parameters
|
|
102
|
+
|
|
103
|
+
Name | Type | Description | Notes
|
|
104
|
+
------------- | ------------- | ------------- | -------------
|
|
105
|
+
**device_id** | **String**| Device ID. |
|
|
106
|
+
**share_id** | **String**| Share ID. |
|
|
107
|
+
|
|
108
|
+
### Return type
|
|
109
|
+
|
|
110
|
+
[**DeviceSharingId**](DeviceSharingId.md)
|
|
111
|
+
|
|
112
|
+
### Authorization
|
|
113
|
+
|
|
114
|
+
[artikcloud_oauth](../README.md#artikcloud_oauth)
|
|
115
|
+
|
|
116
|
+
### HTTP request headers
|
|
117
|
+
|
|
118
|
+
- **Content-Type**: Not defined
|
|
119
|
+
- **Accept**: application/json
|
|
120
|
+
|
|
121
|
+
|
|
122
|
+
|
|
123
|
+
# **get_all_shares_for_device**
|
|
124
|
+
> DeviceSharingEnvelope get_all_shares_for_device(device_id, opts)
|
|
125
|
+
|
|
126
|
+
List all shares for the given device id
|
|
127
|
+
|
|
128
|
+
List all shares for the given device id
|
|
129
|
+
|
|
130
|
+
### Example
|
|
131
|
+
```ruby
|
|
132
|
+
# load the gem
|
|
133
|
+
require 'artikcloud'
|
|
134
|
+
# setup authorization
|
|
135
|
+
ArtikCloud.configure do |config|
|
|
136
|
+
# Configure OAuth2 access token for authorization: artikcloud_oauth
|
|
137
|
+
config.access_token = 'YOUR ACCESS TOKEN'
|
|
138
|
+
end
|
|
139
|
+
|
|
140
|
+
api_instance = ArtikCloud::DevicessharesApi.new
|
|
141
|
+
|
|
142
|
+
device_id = "device_id_example" # String | Device ID.
|
|
143
|
+
|
|
144
|
+
opts = {
|
|
145
|
+
count: 56, # Integer | Desired count of items in the result set.
|
|
146
|
+
offset: 56 # Integer | Offset for pagination.
|
|
147
|
+
}
|
|
148
|
+
|
|
149
|
+
begin
|
|
150
|
+
#List all shares for the given device id
|
|
151
|
+
result = api_instance.get_all_shares_for_device(device_id, opts)
|
|
152
|
+
p result
|
|
153
|
+
rescue ArtikCloud::ApiError => e
|
|
154
|
+
puts "Exception when calling DevicessharesApi->get_all_shares_for_device: #{e}"
|
|
155
|
+
end
|
|
156
|
+
```
|
|
157
|
+
|
|
158
|
+
### Parameters
|
|
159
|
+
|
|
160
|
+
Name | Type | Description | Notes
|
|
161
|
+
------------- | ------------- | ------------- | -------------
|
|
162
|
+
**device_id** | **String**| Device ID. |
|
|
163
|
+
**count** | **Integer**| Desired count of items in the result set. | [optional]
|
|
164
|
+
**offset** | **Integer**| Offset for pagination. | [optional]
|
|
165
|
+
|
|
166
|
+
### Return type
|
|
167
|
+
|
|
168
|
+
[**DeviceSharingEnvelope**](DeviceSharingEnvelope.md)
|
|
169
|
+
|
|
170
|
+
### Authorization
|
|
171
|
+
|
|
172
|
+
[artikcloud_oauth](../README.md#artikcloud_oauth)
|
|
173
|
+
|
|
174
|
+
### HTTP request headers
|
|
175
|
+
|
|
176
|
+
- **Content-Type**: Not defined
|
|
177
|
+
- **Accept**: application/json
|
|
178
|
+
|
|
179
|
+
|
|
180
|
+
|
|
181
|
+
# **get_sharing_for_device**
|
|
182
|
+
> DeviceSharing get_sharing_for_device(device_id, share_id)
|
|
183
|
+
|
|
184
|
+
Get specific share of the given device id
|
|
185
|
+
|
|
186
|
+
Get specific share of the given device id
|
|
187
|
+
|
|
188
|
+
### Example
|
|
189
|
+
```ruby
|
|
190
|
+
# load the gem
|
|
191
|
+
require 'artikcloud'
|
|
192
|
+
# setup authorization
|
|
193
|
+
ArtikCloud.configure do |config|
|
|
194
|
+
# Configure OAuth2 access token for authorization: artikcloud_oauth
|
|
195
|
+
config.access_token = 'YOUR ACCESS TOKEN'
|
|
196
|
+
end
|
|
197
|
+
|
|
198
|
+
api_instance = ArtikCloud::DevicessharesApi.new
|
|
199
|
+
|
|
200
|
+
device_id = "device_id_example" # String | Device ID.
|
|
201
|
+
|
|
202
|
+
share_id = "share_id_example" # String | Share ID.
|
|
203
|
+
|
|
204
|
+
|
|
205
|
+
begin
|
|
206
|
+
#Get specific share of the given device id
|
|
207
|
+
result = api_instance.get_sharing_for_device(device_id, share_id)
|
|
208
|
+
p result
|
|
209
|
+
rescue ArtikCloud::ApiError => e
|
|
210
|
+
puts "Exception when calling DevicessharesApi->get_sharing_for_device: #{e}"
|
|
211
|
+
end
|
|
212
|
+
```
|
|
213
|
+
|
|
214
|
+
### Parameters
|
|
215
|
+
|
|
216
|
+
Name | Type | Description | Notes
|
|
217
|
+
------------- | ------------- | ------------- | -------------
|
|
218
|
+
**device_id** | **String**| Device ID. |
|
|
219
|
+
**share_id** | **String**| Share ID. |
|
|
220
|
+
|
|
221
|
+
### Return type
|
|
222
|
+
|
|
223
|
+
[**DeviceSharing**](DeviceSharing.md)
|
|
224
|
+
|
|
225
|
+
### Authorization
|
|
226
|
+
|
|
227
|
+
[artikcloud_oauth](../README.md#artikcloud_oauth)
|
|
228
|
+
|
|
229
|
+
### HTTP request headers
|
|
230
|
+
|
|
231
|
+
- **Content-Type**: Not defined
|
|
232
|
+
- **Accept**: application/json
|
|
233
|
+
|
|
234
|
+
|
|
235
|
+
|