artikcloud 2.1.1 → 2.2.2
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/README.md +44 -3
- data/artikcloud.gemspec +3 -4
- data/docs/ActionOut.md +6 -0
- data/docs/CertificateData.md +9 -0
- data/docs/CertificateEnvelope.md +8 -0
- data/docs/CertificateFields.md +13 -0
- data/docs/CertificateId.md +8 -0
- data/docs/ContactInfo.md +9 -0
- data/docs/DevicePricingTier.md +16 -0
- data/docs/DevicePricingTierEnvelope.md +8 -0
- data/docs/DevicePricingTierRequest.md +8 -0
- data/docs/DevicePricingTiers.md +8 -0
- data/docs/DevicePricingTiersEnvelope.md +8 -0
- data/docs/DeviceShareInfo.md +1 -1
- data/docs/DeviceTypePricingList.md +8 -0
- data/docs/DeviceTypePricingTier.md +17 -0
- data/docs/DeviceTypePricingTiersEnvelope.md +8 -0
- data/docs/DeviceTypeUpdateInput.md +8 -0
- data/docs/DevicesSharesApi.md +235 -0
- data/docs/DevicesStatusApi.md +183 -0
- data/docs/MessageOut.md +6 -0
- data/docs/MonetizationApi.md +289 -0
- data/docs/OutputRule.md +1 -0
- data/docs/RejectedCSVRow.md +8 -0
- data/docs/RejectedCSVRowsEnvelope.md +11 -0
- data/docs/Tier.md +17 -0
- data/docs/UpgradePath.md +8 -0
- data/docs/UpgradePathEnvelope.md +8 -0
- data/docs/UpgradePathUserToken.md +10 -0
- data/docs/UpgradePathUserTokenEnvelope.md +8 -0
- data/docs/UploadIdEnvelope.md +8 -0
- data/docs/UploadStatusEnvelope.md +8 -0
- data/docs/UsersApi.md +6 -2
- data/docs/ValidityPeriod.md +9 -0
- data/docs/Whitelist.md +10 -0
- data/docs/WhitelistEnvelope.md +8 -0
- data/docs/WhitelistResultEnvelope.md +12 -0
- data/docs/WhitelistingApi.md +515 -0
- data/lib/artikcloud/api/monetization_api.rb +296 -0
- data/lib/artikcloud/api/users_api.rb +3 -0
- data/lib/artikcloud/api/whitelisting_api.rb +519 -0
- data/lib/artikcloud/models/action_out.rb +62 -1
- data/lib/artikcloud/models/certificate_data.rb +197 -0
- data/lib/artikcloud/models/certificate_envelope.rb +188 -0
- data/lib/artikcloud/models/certificate_fields.rb +237 -0
- data/lib/artikcloud/models/certificate_id.rb +188 -0
- data/lib/artikcloud/models/contact_info.rb +198 -0
- data/lib/artikcloud/models/device_pricing_tier.rb +268 -0
- data/lib/artikcloud/models/device_pricing_tier_envelope.rb +188 -0
- data/lib/artikcloud/models/device_pricing_tier_request.rb +188 -0
- data/lib/artikcloud/models/device_pricing_tiers.rb +190 -0
- data/lib/artikcloud/models/device_pricing_tiers_envelope.rb +188 -0
- data/lib/artikcloud/models/device_share_info.rb +7 -7
- data/lib/artikcloud/models/device_type_pricing_list.rb +190 -0
- data/lib/artikcloud/models/device_type_pricing_tier.rb +280 -0
- data/lib/artikcloud/models/device_type_pricing_tiers_envelope.rb +188 -0
- data/lib/artikcloud/models/device_type_update_input.rb +188 -0
- data/lib/artikcloud/models/message_out.rb +65 -1
- data/lib/artikcloud/models/output_rule.rb +46 -4
- data/lib/artikcloud/models/rejected_csv_row.rb +188 -0
- data/lib/artikcloud/models/rejected_csv_rows_envelope.rb +220 -0
- data/lib/artikcloud/models/tier.rb +278 -0
- data/lib/artikcloud/models/upgrade_path.rb +188 -0
- data/lib/artikcloud/models/upgrade_path_envelope.rb +188 -0
- data/lib/artikcloud/models/upgrade_path_user_token.rb +208 -0
- data/lib/artikcloud/models/upgrade_path_user_token_envelope.rb +187 -0
- data/lib/artikcloud/models/upload_id_envelope.rb +188 -0
- data/lib/artikcloud/models/upload_status_envelope.rb +188 -0
- data/lib/artikcloud/models/validity_period.rb +198 -0
- data/lib/artikcloud/models/whitelist.rb +208 -0
- data/lib/artikcloud/models/whitelist_envelope.rb +190 -0
- data/lib/artikcloud/models/whitelist_result_envelope.rb +230 -0
- data/lib/artikcloud/version.rb +1 -2
- data/lib/artikcloud.rb +33 -3
- data/pom.xml +1 -1
- data/spec/api/device_types_api_spec.rb +3 -15
- data/spec/api/devices_api_spec.rb +6 -22
- data/spec/api/devices_management_api_spec.rb +1 -13
- data/spec/api/export_api_spec.rb +2 -14
- data/spec/api/messages_api_spec.rb +115 -74
- data/spec/api/monetization_api_spec.rb +99 -0
- data/spec/api/registrations_api_spec.rb +1 -13
- data/spec/api/rules_api_spec.rb +3 -15
- data/spec/api/tags_api_spec.rb +0 -12
- data/spec/api/tokens_api_spec.rb +24 -14
- data/spec/api/users_api_spec.rb +119 -57
- data/spec/api/whitelisting_api_spec.rb +152 -0
- data/spec/factories/users.rb +12 -12
- data/spec/models/action_out_spec.rb +36 -0
- data/spec/models/certificate_data_spec.rb +47 -0
- data/spec/models/certificate_envelope_spec.rb +41 -0
- data/spec/models/certificate_fields_spec.rb +71 -0
- data/spec/models/certificate_id_spec.rb +41 -0
- data/spec/models/contact_info_spec.rb +47 -0
- data/spec/models/device_pricing_tier_envelope_spec.rb +41 -0
- data/spec/models/device_pricing_tier_request_spec.rb +41 -0
- data/spec/models/device_pricing_tier_spec.rb +89 -0
- data/spec/models/device_pricing_tiers_envelope_spec.rb +41 -0
- data/spec/models/device_pricing_tiers_spec.rb +41 -0
- data/spec/models/device_share_info_spec.rb +1 -1
- data/spec/models/device_type_pricing_list_spec.rb +41 -0
- data/spec/models/device_type_pricing_tier_spec.rb +95 -0
- data/spec/models/device_type_pricing_tiers_envelope_spec.rb +41 -0
- data/spec/models/device_type_update_input_spec.rb +41 -0
- data/spec/models/message_out_spec.rb +36 -0
- data/spec/models/output_rule_spec.rb +10 -0
- data/spec/models/rejected_csv_row_spec.rb +41 -0
- data/spec/models/rejected_csv_rows_envelope_spec.rb +59 -0
- data/spec/models/tier_spec.rb +95 -0
- data/spec/models/upgrade_path_envelope_spec.rb +41 -0
- data/spec/models/upgrade_path_spec.rb +41 -0
- data/spec/models/upgrade_path_user_token_envelope_spec.rb +41 -0
- data/spec/models/upgrade_path_user_token_spec.rb +53 -0
- data/spec/models/upload_id_envelope_spec.rb +41 -0
- data/spec/models/upload_status_envelope_spec.rb +41 -0
- data/spec/models/validity_period_spec.rb +47 -0
- data/spec/models/whitelist_envelope_spec.rb +41 -0
- data/spec/models/whitelist_result_envelope_spec.rb +65 -0
- data/spec/models/whitelist_spec.rb +53 -0
- metadata +121 -11
- data/docs/.DS_Store +0 -0
- data/lib/.DS_Store +0 -0
- data/lib/artikcloud/.DS_Store +0 -0
- data/lib/artikcloud/api/.DS_Store +0 -0
- data/lib/artikcloud/models/.DS_Store +0 -0
- data/spec/.DS_Store +0 -0
- data/spec/api/.DS_Store +0 -0
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA1:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: f5fb7e1aae8ccf86820a5b97bcf2e4911a241279
|
|
4
|
+
data.tar.gz: 0c7161a5c98280f561d87ac0502fcc8dc3baa719
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: f5a459b936ba10bad1c6d2741978d67fc4f081e5c8a7ae7955fdcbdac2446f55f6283415bd17b750d9bc3f4747f651d7c86d6cb0775b1f6cfced082351b3b353
|
|
7
|
+
data.tar.gz: 3df1729c32f3080235db145fec3fb194c88d18757bc4d61519f5c25025f8c5e00e21a5a63bc0bc5479a825ccb23bf5bb8d25654d8fc1b78209ae5dd97dbeb00d
|
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.
|
|
21
|
+
gem install ./artikcloud-2.2.2.gem
|
|
22
22
|
```
|
|
23
|
-
(for development, run `gem install --dev ./artikcloud-2.
|
|
23
|
+
(for development, run `gem install --dev ./artikcloud-2.2.2.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.
|
|
29
|
+
gem 'artikcloud', '~> 2.2.2'
|
|
30
30
|
|
|
31
31
|
### Install from Git
|
|
32
32
|
|
|
@@ -125,6 +125,11 @@ Class | Method | HTTP request | Description
|
|
|
125
125
|
*ArtikCloud::MessagesApi* | [**get_normalized_messages**](docs/MessagesApi.md#get_normalized_messages) | **GET** /messages | Get Normalized Messages
|
|
126
126
|
*ArtikCloud::MessagesApi* | [**send_actions**](docs/MessagesApi.md#send_actions) | **POST** /actions | Send Actions
|
|
127
127
|
*ArtikCloud::MessagesApi* | [**send_message**](docs/MessagesApi.md#send_message) | **POST** /messages | Send Message
|
|
128
|
+
*ArtikCloud::MonetizationApi* | [**create_pricing_tiers**](docs/MonetizationApi.md#create_pricing_tiers) | **POST** /pricing/devicetypes/{dtid}/pricingtiers | Define devicetype's pricing tiers.
|
|
129
|
+
*ArtikCloud::MonetizationApi* | [**get_pricing_tiers**](docs/MonetizationApi.md#get_pricing_tiers) | **GET** /pricing/devices/{did}/pricingtiers | Get a device's pricing tiers
|
|
130
|
+
*ArtikCloud::MonetizationApi* | [**get_the__pricing_tiers**](docs/MonetizationApi.md#get_the__pricing_tiers) | **GET** /pricing/devicetypes/{dtid}/pricingtiers | Get devicetype's pricing tiers.
|
|
131
|
+
*ArtikCloud::MonetizationApi* | [**get_upgrade_path**](docs/MonetizationApi.md#get_upgrade_path) | **GET** /pricing/devices/{did}/revenueshare/upgradepath | Get upgrade path
|
|
132
|
+
*ArtikCloud::MonetizationApi* | [**set_pricing_tier**](docs/MonetizationApi.md#set_pricing_tier) | **PUT** /pricing/devices/{did}/pricingtiers | Set a device's pricing tier
|
|
128
133
|
*ArtikCloud::RegistrationsApi* | [**confirm_user**](docs/RegistrationsApi.md#confirm_user) | **PUT** /devices/registrations/pin | Confirm User
|
|
129
134
|
*ArtikCloud::RegistrationsApi* | [**get_request_status_for_user**](docs/RegistrationsApi.md#get_request_status_for_user) | **GET** /devices/registrations/{requestId}/status | Get Request Status For User
|
|
130
135
|
*ArtikCloud::RegistrationsApi* | [**unregister_device**](docs/RegistrationsApi.md#unregister_device) | **DELETE** /devices/{deviceId}/registrations | Unregister Device
|
|
@@ -153,6 +158,15 @@ Class | Method | HTTP request | Description
|
|
|
153
158
|
*ArtikCloud::UsersApi* | [**get_user_rules**](docs/UsersApi.md#get_user_rules) | **GET** /users/{userId}/rules | Get User Rules
|
|
154
159
|
*ArtikCloud::UsersApi* | [**list_all_shares_for_user**](docs/UsersApi.md#list_all_shares_for_user) | **GET** /users/{userId}/shares | Get User shares
|
|
155
160
|
*ArtikCloud::UsersApi* | [**update_user_properties**](docs/UsersApi.md#update_user_properties) | **PUT** /users/{userId}/properties | Update User Application Properties
|
|
161
|
+
*ArtikCloud::WhitelistingApi* | [**delete_vdid**](docs/WhitelistingApi.md#delete_vdid) | **DELETE** /devicetypes/{dtid}/whitelist/{vdid} | Delete a vdid from the devicetype whitelist.
|
|
162
|
+
*ArtikCloud::WhitelistingApi* | [**delete_whitelist_certificate**](docs/WhitelistingApi.md#delete_whitelist_certificate) | **DELETE** /devicetypes/{dtid}/whitelist/certificates/{cid} | Delete a whitelist certificate associated with a devicetype.
|
|
163
|
+
*ArtikCloud::WhitelistingApi* | [**enable_whitelist**](docs/WhitelistingApi.md#enable_whitelist) | **PUT** /devicetypes/:dtid/whitelist/enable | Enable or disble whitelist feature of a device type
|
|
164
|
+
*ArtikCloud::WhitelistingApi* | [**get_rejected_row_list**](docs/WhitelistingApi.md#get_rejected_row_list) | **GET** /devicetypes/{dtid}/whitelist/{uploadId}/rejectedRows | Get the list of rejected rows for an uploaded CSV file.
|
|
165
|
+
*ArtikCloud::WhitelistingApi* | [**get_upload_status**](docs/WhitelistingApi.md#get_upload_status) | **GET** /devicetypes/{dtid}/whitelist/{uploadId}/status | Get the status of a uploaded CSV file.
|
|
166
|
+
*ArtikCloud::WhitelistingApi* | [**get_whitelist**](docs/WhitelistingApi.md#get_whitelist) | **GET** /devicetypes/{dtid}/whitelist | Get whitelisted vdids of a device type.
|
|
167
|
+
*ArtikCloud::WhitelistingApi* | [**get_whitelist_certificate**](docs/WhitelistingApi.md#get_whitelist_certificate) | **GET** /devicetypes/{dtid}/whitelist/certificates | Get whitelist certificate of device type.
|
|
168
|
+
*ArtikCloud::WhitelistingApi* | [**get_whitelist_status**](docs/WhitelistingApi.md#get_whitelist_status) | **GET** /devicetypes/{dtid}/whitelist/status | Get the status of whitelist feature (enabled/disabled) of a device type.
|
|
169
|
+
*ArtikCloud::WhitelistingApi* | [**upload_csv**](docs/WhitelistingApi.md#upload_csv) | **POST** /devicetypes/{dtid}/whitelist | Upload a CSV file related to the Device Type.
|
|
156
170
|
|
|
157
171
|
|
|
158
172
|
## Documentation for Models
|
|
@@ -171,11 +185,21 @@ Class | Method | HTTP request | Description
|
|
|
171
185
|
- [ArtikCloud::AggregatesHistogramResponse](docs/AggregatesHistogramResponse.md)
|
|
172
186
|
- [ArtikCloud::AggregatesResponse](docs/AggregatesResponse.md)
|
|
173
187
|
- [ArtikCloud::AppProperties](docs/AppProperties.md)
|
|
188
|
+
- [ArtikCloud::CertificateData](docs/CertificateData.md)
|
|
189
|
+
- [ArtikCloud::CertificateEnvelope](docs/CertificateEnvelope.md)
|
|
190
|
+
- [ArtikCloud::CertificateFields](docs/CertificateFields.md)
|
|
191
|
+
- [ArtikCloud::CertificateId](docs/CertificateId.md)
|
|
174
192
|
- [ArtikCloud::CheckTokenMessage](docs/CheckTokenMessage.md)
|
|
175
193
|
- [ArtikCloud::CheckTokenResponse](docs/CheckTokenResponse.md)
|
|
194
|
+
- [ArtikCloud::ContactInfo](docs/ContactInfo.md)
|
|
176
195
|
- [ArtikCloud::Device](docs/Device.md)
|
|
177
196
|
- [ArtikCloud::DeviceArray](docs/DeviceArray.md)
|
|
178
197
|
- [ArtikCloud::DeviceEnvelope](docs/DeviceEnvelope.md)
|
|
198
|
+
- [ArtikCloud::DevicePricingTier](docs/DevicePricingTier.md)
|
|
199
|
+
- [ArtikCloud::DevicePricingTierEnvelope](docs/DevicePricingTierEnvelope.md)
|
|
200
|
+
- [ArtikCloud::DevicePricingTierRequest](docs/DevicePricingTierRequest.md)
|
|
201
|
+
- [ArtikCloud::DevicePricingTiers](docs/DevicePricingTiers.md)
|
|
202
|
+
- [ArtikCloud::DevicePricingTiersEnvelope](docs/DevicePricingTiersEnvelope.md)
|
|
179
203
|
- [ArtikCloud::DeviceRegCompleteRequest](docs/DeviceRegCompleteRequest.md)
|
|
180
204
|
- [ArtikCloud::DeviceRegConfirmUserRequest](docs/DeviceRegConfirmUserRequest.md)
|
|
181
205
|
- [ArtikCloud::DeviceRegConfirmUserResponse](docs/DeviceRegConfirmUserResponse.md)
|
|
@@ -202,6 +226,10 @@ Class | Method | HTTP request | Description
|
|
|
202
226
|
- [ArtikCloud::DeviceTypeEnvelope](docs/DeviceTypeEnvelope.md)
|
|
203
227
|
- [ArtikCloud::DeviceTypeInfo](docs/DeviceTypeInfo.md)
|
|
204
228
|
- [ArtikCloud::DeviceTypeInfoEnvelope](docs/DeviceTypeInfoEnvelope.md)
|
|
229
|
+
- [ArtikCloud::DeviceTypePricingList](docs/DeviceTypePricingList.md)
|
|
230
|
+
- [ArtikCloud::DeviceTypePricingTier](docs/DeviceTypePricingTier.md)
|
|
231
|
+
- [ArtikCloud::DeviceTypePricingTiersEnvelope](docs/DeviceTypePricingTiersEnvelope.md)
|
|
232
|
+
- [ArtikCloud::DeviceTypeUpdateInput](docs/DeviceTypeUpdateInput.md)
|
|
205
233
|
- [ArtikCloud::DeviceTypesEnvelope](docs/DeviceTypesEnvelope.md)
|
|
206
234
|
- [ArtikCloud::DeviceTypesInfo](docs/DeviceTypesInfo.md)
|
|
207
235
|
- [ArtikCloud::DeviceTypesInfoEnvelope](docs/DeviceTypesInfoEnvelope.md)
|
|
@@ -249,6 +277,8 @@ Class | Method | HTTP request | Description
|
|
|
249
277
|
- [ArtikCloud::PropertiesEnvelope](docs/PropertiesEnvelope.md)
|
|
250
278
|
- [ArtikCloud::RefreshTokenResponse](docs/RefreshTokenResponse.md)
|
|
251
279
|
- [ArtikCloud::RegisterMessage](docs/RegisterMessage.md)
|
|
280
|
+
- [ArtikCloud::RejectedCSVRow](docs/RejectedCSVRow.md)
|
|
281
|
+
- [ArtikCloud::RejectedCSVRowsEnvelope](docs/RejectedCSVRowsEnvelope.md)
|
|
252
282
|
- [ArtikCloud::RuleArray](docs/RuleArray.md)
|
|
253
283
|
- [ArtikCloud::RuleCreationInfo](docs/RuleCreationInfo.md)
|
|
254
284
|
- [ArtikCloud::RuleEnvelope](docs/RuleEnvelope.md)
|
|
@@ -286,6 +316,7 @@ Class | Method | HTTP request | Description
|
|
|
286
316
|
- [ArtikCloud::TaskUpdateRequest](docs/TaskUpdateRequest.md)
|
|
287
317
|
- [ArtikCloud::TaskUpdateResponse](docs/TaskUpdateResponse.md)
|
|
288
318
|
- [ArtikCloud::TasksStatusCounts](docs/TasksStatusCounts.md)
|
|
319
|
+
- [ArtikCloud::Tier](docs/Tier.md)
|
|
289
320
|
- [ArtikCloud::Token](docs/Token.md)
|
|
290
321
|
- [ArtikCloud::TokenInfo](docs/TokenInfo.md)
|
|
291
322
|
- [ArtikCloud::TokenInfoSuccessResponse](docs/TokenInfoSuccessResponse.md)
|
|
@@ -294,10 +325,20 @@ Class | Method | HTTP request | Description
|
|
|
294
325
|
- [ArtikCloud::UnregisterDeviceResponse](docs/UnregisterDeviceResponse.md)
|
|
295
326
|
- [ArtikCloud::UnregisterDeviceResponseEnvelope](docs/UnregisterDeviceResponseEnvelope.md)
|
|
296
327
|
- [ArtikCloud::UpdateParameters](docs/UpdateParameters.md)
|
|
328
|
+
- [ArtikCloud::UpgradePath](docs/UpgradePath.md)
|
|
329
|
+
- [ArtikCloud::UpgradePathEnvelope](docs/UpgradePathEnvelope.md)
|
|
330
|
+
- [ArtikCloud::UpgradePathUserToken](docs/UpgradePathUserToken.md)
|
|
331
|
+
- [ArtikCloud::UpgradePathUserTokenEnvelope](docs/UpgradePathUserTokenEnvelope.md)
|
|
332
|
+
- [ArtikCloud::UploadIdEnvelope](docs/UploadIdEnvelope.md)
|
|
333
|
+
- [ArtikCloud::UploadStatusEnvelope](docs/UploadStatusEnvelope.md)
|
|
297
334
|
- [ArtikCloud::User](docs/User.md)
|
|
298
335
|
- [ArtikCloud::UserEnvelope](docs/UserEnvelope.md)
|
|
299
336
|
- [ArtikCloud::ValidationCallbackInfo](docs/ValidationCallbackInfo.md)
|
|
337
|
+
- [ArtikCloud::ValidityPeriod](docs/ValidityPeriod.md)
|
|
300
338
|
- [ArtikCloud::WebSocketError](docs/WebSocketError.md)
|
|
339
|
+
- [ArtikCloud::Whitelist](docs/Whitelist.md)
|
|
340
|
+
- [ArtikCloud::WhitelistEnvelope](docs/WhitelistEnvelope.md)
|
|
341
|
+
- [ArtikCloud::WhitelistResultEnvelope](docs/WhitelistResultEnvelope.md)
|
|
301
342
|
|
|
302
343
|
|
|
303
344
|
|
data/artikcloud.gemspec
CHANGED
|
@@ -3,11 +3,10 @@
|
|
|
3
3
|
=begin
|
|
4
4
|
#ARTIK Cloud API
|
|
5
5
|
|
|
6
|
-
|
|
6
|
+
A ruby wrapper for the ArtikCloud REST APIs
|
|
7
7
|
|
|
8
|
-
OpenAPI spec version: 2.0.0
|
|
9
8
|
|
|
10
|
-
|
|
9
|
+
https://github.com/artikcloud/artikcloud-ruby
|
|
11
10
|
|
|
12
11
|
=end
|
|
13
12
|
|
|
@@ -21,7 +20,7 @@ Gem::Specification.new do |s|
|
|
|
21
20
|
s.authors = ["ARTIK Cloud"]
|
|
22
21
|
s.email = [""]
|
|
23
22
|
s.homepage = "http://github.com/artikcloud/artikcloud-ruby"
|
|
24
|
-
s.summary = "
|
|
23
|
+
s.summary = "ARTIK Cloud Ruby Gem"
|
|
25
24
|
s.description = "A ruby wrapper for the ArtikCloud REST APIs"
|
|
26
25
|
# TODO uncommnet and update below with a proper license
|
|
27
26
|
#s.license = "Apache 2.0"
|
data/docs/ActionOut.md
CHANGED
|
@@ -3,6 +3,12 @@
|
|
|
3
3
|
## Properties
|
|
4
4
|
Name | Type | Description | Notes
|
|
5
5
|
------------ | ------------- | ------------- | -------------
|
|
6
|
+
**data** | [**ActionDetailsArray**](ActionDetailsArray.md) | | [optional]
|
|
7
|
+
**cid** | **String** | Confirmation ID. | [optional]
|
|
8
|
+
**ddid** | **String** | Destination Device ID. | [optional]
|
|
9
|
+
**sdid** | **String** | Source Device ID. | [optional]
|
|
10
|
+
**ts** | **Integer** | Timestamp (past, present or future). Defaults to current time if not provided. | [optional]
|
|
11
|
+
**type** | **String** | Type. | [optional] [default to "action"]
|
|
6
12
|
**mid** | **String** | Message ID. | [optional]
|
|
7
13
|
**uid** | **String** | User ID. | [optional]
|
|
8
14
|
**sdtid** | **String** | Source Device Type ID. | [optional]
|
|
@@ -0,0 +1,9 @@
|
|
|
1
|
+
# ArtikCloud::CertificateData
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
Name | Type | Description | Notes
|
|
5
|
+
------------ | ------------- | ------------- | -------------
|
|
6
|
+
**id** | [**CertificateId**](CertificateId.md) | certificate id | [optional]
|
|
7
|
+
**certificate_fields** | [**CertificateFields**](CertificateFields.md) | | [optional]
|
|
8
|
+
|
|
9
|
+
|
|
@@ -0,0 +1,13 @@
|
|
|
1
|
+
# ArtikCloud::CertificateFields
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
Name | Type | Description | Notes
|
|
5
|
+
------------ | ------------- | ------------- | -------------
|
|
6
|
+
**version** | **Integer** | version | [optional]
|
|
7
|
+
**serial_number** | **String** | serialNumber | [optional]
|
|
8
|
+
**signature_algorithm** | **String** | signatureAlgorithm | [optional]
|
|
9
|
+
**subject** | **String** | subject | [optional]
|
|
10
|
+
**issuer** | **String** | issuer | [optional]
|
|
11
|
+
**validity** | [**ValidityPeriod**](ValidityPeriod.md) | | [optional]
|
|
12
|
+
|
|
13
|
+
|
data/docs/ContactInfo.md
ADDED
|
@@ -0,0 +1,16 @@
|
|
|
1
|
+
# ArtikCloud::DevicePricingTier
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
Name | Type | Description | Notes
|
|
5
|
+
------------ | ------------- | ------------- | -------------
|
|
6
|
+
**message_limit** | **Integer** | Message Limit | [optional]
|
|
7
|
+
**cost** | **String** | Cost | [optional]
|
|
8
|
+
**name** | **String** | Name | [optional]
|
|
9
|
+
**description** | **String** | Description | [optional]
|
|
10
|
+
**active** | **BOOLEAN** | Active | [optional]
|
|
11
|
+
**interval** | **String** | Interval | [optional]
|
|
12
|
+
**ptid** | **String** | Pricing Tier ID | [optional]
|
|
13
|
+
**type** | **String** | Type | [optional]
|
|
14
|
+
**billing_interval** | **String** | Billing Interval | [optional]
|
|
15
|
+
|
|
16
|
+
|
|
@@ -0,0 +1,8 @@
|
|
|
1
|
+
# ArtikCloud::DevicePricingTiers
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
Name | Type | Description | Notes
|
|
5
|
+
------------ | ------------- | ------------- | -------------
|
|
6
|
+
**pricing_tiers** | [**Array<DevicePricingTier>**](DevicePricingTier.md) | Pricing Tiers list | [optional]
|
|
7
|
+
|
|
8
|
+
|
data/docs/DeviceShareInfo.md
CHANGED
|
@@ -0,0 +1,8 @@
|
|
|
1
|
+
# ArtikCloud::DeviceTypePricingList
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
Name | Type | Description | Notes
|
|
5
|
+
------------ | ------------- | ------------- | -------------
|
|
6
|
+
**pricing_tiers** | [**Array<DeviceTypePricingTier>**](DeviceTypePricingTier.md) | Pricing Tiers List | [optional]
|
|
7
|
+
|
|
8
|
+
|
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
# ArtikCloud::DeviceTypePricingTier
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
Name | Type | Description | Notes
|
|
5
|
+
------------ | ------------- | ------------- | -------------
|
|
6
|
+
**revenue_share_percent** | **Object** | revenue share percentage | [optional]
|
|
7
|
+
**tiers** | [**Array<Tier>**](Tier.md) | tiers | [optional]
|
|
8
|
+
**modified_on** | **Integer** | modified on | [optional]
|
|
9
|
+
**comments** | **String** | comments | [optional]
|
|
10
|
+
**dtid** | **String** | dtid | [optional]
|
|
11
|
+
**contact_info** | [**ContactInfo**](ContactInfo.md) | contact information | [optional]
|
|
12
|
+
**pt_type** | **String** | type | [optional]
|
|
13
|
+
**version** | **Integer** | version | [optional]
|
|
14
|
+
**created_on** | **Integer** | created on | [optional]
|
|
15
|
+
**status** | **String** | status | [optional]
|
|
16
|
+
|
|
17
|
+
|
|
@@ -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** /devices/{deviceId}/shares | Share a device
|
|
8
|
+
[**delete_sharing_for_device**](DevicesSharesApi.md#delete_sharing_for_device) | **DELETE** /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** /devices/{deviceId}/shares | List all shares for the given device id
|
|
10
|
+
[**get_sharing_for_device**](DevicesSharesApi.md#get_sharing_for_device) | **GET** /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
|
+
|