artikcloud 2.0.0 → 2.0.5

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.
Files changed (144) hide show
  1. checksums.yaml +4 -4
  2. data/Gemfile.lock +12 -12
  3. data/README.md +33 -10
  4. data/artikcloud.gemspec +5 -6
  5. data/docs/Action.md +9 -0
  6. data/docs/ActionArray.md +8 -0
  7. data/docs/Actions.md +12 -0
  8. data/docs/DeviceTypesApi.md +10 -10
  9. data/docs/DevicesApi.md +68 -15
  10. data/docs/ExportApi.md +10 -10
  11. data/docs/Message.md +11 -0
  12. data/docs/MessagesApi.md +205 -27
  13. data/docs/NormalizedAction.md +16 -0
  14. data/docs/NormalizedActionsEnvelope.md +17 -0
  15. data/docs/PresenceEnvelope.md +9 -0
  16. data/docs/PresenceModel.md +9 -0
  17. data/docs/RegistrationsApi.md +6 -6
  18. data/docs/RulesApi.md +8 -8
  19. data/docs/RulesEnvelope.md +1 -1
  20. data/docs/SnapshotResponse.md +9 -0
  21. data/docs/SnapshotResponses.md +10 -0
  22. data/docs/SnapshotsResponseEnvelope.md +9 -0
  23. data/docs/TagsApi.md +7 -7
  24. data/docs/TokenInfo.md +11 -0
  25. data/docs/TokenInfoSuccessResponse.md +8 -0
  26. data/docs/TokensApi.md +54 -7
  27. data/docs/UsersApi.md +18 -20
  28. data/git_push.sh +16 -1
  29. data/lib/artikcloud/api/device_types_api.rb +52 -59
  30. data/lib/artikcloud/api/devices_api.rb +120 -76
  31. data/lib/artikcloud/api/export_api.rb +43 -45
  32. data/lib/artikcloud/api/messages_api.rb +285 -103
  33. data/lib/artikcloud/api/registrations_api.rb +34 -34
  34. data/lib/artikcloud/api/rules_api.rb +43 -48
  35. data/lib/artikcloud/api/tags_api.rb +37 -35
  36. data/lib/artikcloud/api/tokens_api.rb +85 -30
  37. data/lib/artikcloud/api/users_api.rb +83 -102
  38. data/lib/artikcloud/api_client.rb +56 -13
  39. data/lib/artikcloud/api_error.rb +13 -4
  40. data/lib/artikcloud/configuration.rb +45 -1
  41. data/lib/artikcloud/models/ack_envelope.rb +59 -24
  42. data/lib/artikcloud/models/acknowledgement.rb +65 -33
  43. data/lib/artikcloud/models/action.rb +212 -0
  44. data/lib/artikcloud/models/action_array.rb +201 -0
  45. data/lib/artikcloud/models/action_details.rb +61 -27
  46. data/lib/artikcloud/models/action_details_array.rb +59 -24
  47. data/lib/artikcloud/models/action_in.rb +69 -39
  48. data/lib/artikcloud/models/action_out.rb +67 -36
  49. data/lib/artikcloud/models/actions.rb +241 -0
  50. data/lib/artikcloud/models/aggregate_data.rb +69 -39
  51. data/lib/artikcloud/models/aggregates_histogram_data.rb +71 -42
  52. data/lib/artikcloud/models/aggregates_histogram_response.rb +71 -42
  53. data/lib/artikcloud/models/aggregates_response.rb +69 -39
  54. data/lib/artikcloud/models/app_properties.rb +64 -30
  55. data/lib/artikcloud/models/check_token_message.rb +59 -24
  56. data/lib/artikcloud/models/check_token_response.rb +59 -24
  57. data/lib/artikcloud/models/device.rb +85 -63
  58. data/lib/artikcloud/models/device_array.rb +59 -24
  59. data/lib/artikcloud/models/device_envelope.rb +60 -24
  60. data/lib/artikcloud/models/device_reg_complete_request.rb +59 -24
  61. data/lib/artikcloud/models/device_reg_confirm_user_request.rb +63 -30
  62. data/lib/artikcloud/models/device_reg_confirm_user_response.rb +59 -24
  63. data/lib/artikcloud/models/device_reg_confirm_user_response_envelope.rb +59 -24
  64. data/lib/artikcloud/models/device_reg_status_response.rb +61 -27
  65. data/lib/artikcloud/models/device_reg_status_response_envelope.rb +59 -24
  66. data/lib/artikcloud/models/device_token.rb +69 -33
  67. data/lib/artikcloud/models/device_token_envelope.rb +60 -24
  68. data/lib/artikcloud/models/device_type.rb +93 -75
  69. data/lib/artikcloud/models/device_type_array.rb +59 -24
  70. data/lib/artikcloud/models/device_type_envelope.rb +60 -24
  71. data/lib/artikcloud/models/device_types_envelope.rb +68 -33
  72. data/lib/artikcloud/models/devices_envelope.rb +68 -33
  73. data/lib/artikcloud/models/error_envelope.rb +59 -24
  74. data/lib/artikcloud/models/export_data.rb +71 -42
  75. data/lib/artikcloud/models/export_data_array.rb +59 -24
  76. data/lib/artikcloud/models/export_history_response.rb +65 -33
  77. data/lib/artikcloud/models/export_normalized_messages_response.rb +83 -60
  78. data/lib/artikcloud/models/export_request.rb +73 -45
  79. data/lib/artikcloud/models/export_request_data.rb +79 -54
  80. data/lib/artikcloud/models/export_request_info.rb +77 -51
  81. data/lib/artikcloud/models/export_request_response.rb +59 -24
  82. data/lib/artikcloud/models/export_response.rb +79 -54
  83. data/lib/artikcloud/models/export_status_response.rb +67 -36
  84. data/lib/artikcloud/models/field_path.rb +59 -24
  85. data/lib/artikcloud/models/field_presence.rb +60 -24
  86. data/lib/artikcloud/models/field_presence_envelope.rb +78 -42
  87. data/lib/artikcloud/models/fields_actions.rb +61 -27
  88. data/lib/artikcloud/models/manifest_properties.rb +60 -24
  89. data/lib/artikcloud/models/manifest_properties_envelope.rb +60 -24
  90. data/lib/artikcloud/models/manifest_versions.rb +60 -24
  91. data/lib/artikcloud/models/manifest_versions_envelope.rb +60 -24
  92. data/lib/artikcloud/models/message.rb +233 -0
  93. data/lib/artikcloud/models/message_action.rb +67 -36
  94. data/lib/artikcloud/models/message_id.rb +59 -24
  95. data/lib/artikcloud/models/message_id_envelope.rb +59 -24
  96. data/lib/artikcloud/models/message_in.rb +69 -39
  97. data/lib/artikcloud/models/message_out.rb +67 -36
  98. data/lib/artikcloud/models/non_empty_string.rb +59 -24
  99. data/lib/artikcloud/models/normalized_action.rb +279 -0
  100. data/lib/artikcloud/models/normalized_actions_envelope.rb +285 -0
  101. data/lib/artikcloud/models/normalized_message.rb +81 -45
  102. data/lib/artikcloud/models/normalized_messages_envelope.rb +80 -51
  103. data/lib/artikcloud/models/output_rule.rb +85 -63
  104. data/lib/artikcloud/models/presence_envelope.rb +208 -0
  105. data/lib/artikcloud/models/presence_model.rb +208 -0
  106. data/lib/artikcloud/models/properties_envelope.rb +60 -24
  107. data/lib/artikcloud/models/refresh_token_response.rb +65 -33
  108. data/lib/artikcloud/models/register_message.rb +67 -36
  109. data/lib/artikcloud/models/rule_array.rb +59 -24
  110. data/lib/artikcloud/models/rule_creation_info.rb +65 -33
  111. data/lib/artikcloud/models/rule_envelope.rb +59 -24
  112. data/lib/artikcloud/models/rule_error.rb +65 -33
  113. data/lib/artikcloud/models/rule_update_info.rb +65 -33
  114. data/lib/artikcloud/models/rule_warning_output.rb +61 -27
  115. data/lib/artikcloud/models/rules_envelope.rb +69 -35
  116. data/lib/artikcloud/models/snapshot_response.rb +210 -0
  117. data/lib/artikcloud/models/snapshot_responses.rb +219 -0
  118. data/lib/artikcloud/models/snapshots_response_envelope.rb +208 -0
  119. data/lib/artikcloud/models/tag.rb +61 -27
  120. data/lib/artikcloud/models/tag_array.rb +59 -24
  121. data/lib/artikcloud/models/tags_envelope.rb +59 -24
  122. data/lib/artikcloud/models/token.rb +65 -33
  123. data/lib/artikcloud/models/token_info.rb +226 -0
  124. data/lib/artikcloud/models/token_info_success_response.rb +199 -0
  125. data/lib/artikcloud/models/token_request.rb +59 -24
  126. data/lib/artikcloud/models/token_response.rb +59 -24
  127. data/lib/artikcloud/models/unregister_device_response.rb +79 -54
  128. data/lib/artikcloud/models/unregister_device_response_envelope.rb +59 -24
  129. data/lib/artikcloud/models/user.rb +77 -42
  130. data/lib/artikcloud/models/user_envelope.rb +60 -24
  131. data/lib/artikcloud/models/web_socket_error.rb +63 -30
  132. data/lib/artikcloud/version.rb +14 -5
  133. data/lib/artikcloud.rb +26 -4
  134. data/spec/api/device_types_api_spec.rb +110 -0
  135. data/spec/api/devices_api_spec.rb +143 -0
  136. data/spec/api/export_api_spec.rb +96 -0
  137. data/spec/api/messages_api_spec.rb +7 -7
  138. data/spec/api/registrations_api_spec.rb +82 -0
  139. data/spec/api/rules_api_spec.rb +96 -0
  140. data/spec/api/tags_api_spec.rb +84 -0
  141. data/spec/api/tokens_api_spec.rb +12 -21
  142. data/spec/api/users_api_spec.rb +1 -1
  143. data/spec/spec_helper.rb +1 -1
  144. metadata +60 -22
data/docs/MessagesApi.md CHANGED
@@ -4,18 +4,21 @@ All URIs are relative to *https://api.artik.cloud/v1.1*
4
4
 
5
5
  Method | HTTP request | Description
6
6
  ------------- | ------------- | -------------
7
- [**get_aggregates_histogram**](MessagesApi.md#get_aggregates_histogram) | **GET** /messages/analytics/histogram | Get Histogram aggregates
7
+ [**get_aggregates_histogram**](MessagesApi.md#get_aggregates_histogram) | **GET** /messages/analytics/histogram | Get Normalized Message Histogram
8
8
  [**get_field_presence**](MessagesApi.md#get_field_presence) | **GET** /messages/presence | Get normalized message presence
9
9
  [**get_last_normalized_messages**](MessagesApi.md#get_last_normalized_messages) | **GET** /messages/last | Get Last Normalized Message
10
10
  [**get_message_aggregates**](MessagesApi.md#get_message_aggregates) | **GET** /messages/analytics/aggregates | Get Normalized Message Aggregates
11
+ [**get_message_snapshots**](MessagesApi.md#get_message_snapshots) | **GET** /messages/snapshots | Get Message Snapshots
12
+ [**get_normalized_actions**](MessagesApi.md#get_normalized_actions) | **GET** /actions | Get Normalized Actions
11
13
  [**get_normalized_messages**](MessagesApi.md#get_normalized_messages) | **GET** /messages | Get Normalized Messages
12
- [**send_message_action**](MessagesApi.md#send_message_action) | **POST** /messages | Send Message Action
14
+ [**send_actions**](MessagesApi.md#send_actions) | **POST** /actions | Send Actions
15
+ [**send_message**](MessagesApi.md#send_message) | **POST** /messages | Send Message
13
16
 
14
17
 
15
18
  # **get_aggregates_histogram**
16
19
  > AggregatesHistogramResponse get_aggregates_histogram(start_date, end_date, opts)
17
20
 
18
- Get Histogram aggregates
21
+ Get Normalized Message Histogram
19
22
 
20
23
  Get Histogram on normalized messages.
21
24
 
@@ -23,7 +26,7 @@ Get Histogram on normalized messages.
23
26
  ```ruby
24
27
  # load the gem
25
28
  require 'artikcloud'
26
- # setup authorization
29
+ # setup authorization
27
30
  ArtikCloud.configure do |config|
28
31
  # Configure OAuth2 access token for authorization: artikcloud_oauth
29
32
  config.access_token = 'YOUR ACCESS TOKEN'
@@ -42,7 +45,7 @@ opts = {
42
45
  }
43
46
 
44
47
  begin
45
- #Get Histogram aggregates
48
+ #Get Normalized Message Histogram
46
49
  result = api_instance.get_aggregates_histogram(start_date, end_date, opts)
47
50
  p result
48
51
  rescue ArtikCloud::ApiError => e
@@ -68,7 +71,7 @@ Name | Type | Description | Notes
68
71
 
69
72
  [artikcloud_oauth](../README.md#artikcloud_oauth)
70
73
 
71
- ### HTTP reuqest headers
74
+ ### HTTP request headers
72
75
 
73
76
  - **Content-Type**: Not defined
74
77
  - **Accept**: application/json
@@ -86,7 +89,7 @@ Get normalized message presence.
86
89
  ```ruby
87
90
  # load the gem
88
91
  require 'artikcloud'
89
- # setup authorization
92
+ # setup authorization
90
93
  ArtikCloud.configure do |config|
91
94
  # Configure OAuth2 access token for authorization: artikcloud_oauth
92
95
  config.access_token = 'YOUR ACCESS TOKEN'
@@ -132,7 +135,7 @@ Name | Type | Description | Notes
132
135
 
133
136
  [artikcloud_oauth](../README.md#artikcloud_oauth)
134
137
 
135
- ### HTTP reuqest headers
138
+ ### HTTP request headers
136
139
 
137
140
  - **Content-Type**: Not defined
138
141
  - **Accept**: application/json
@@ -150,7 +153,7 @@ Get last messages normalized.
150
153
  ```ruby
151
154
  # load the gem
152
155
  require 'artikcloud'
153
- # setup authorization
156
+ # setup authorization
154
157
  ArtikCloud.configure do |config|
155
158
  # Configure OAuth2 access token for authorization: artikcloud_oauth
156
159
  config.access_token = 'YOUR ACCESS TOKEN'
@@ -189,7 +192,7 @@ Name | Type | Description | Notes
189
192
 
190
193
  [artikcloud_oauth](../README.md#artikcloud_oauth)
191
194
 
192
- ### HTTP reuqest headers
195
+ ### HTTP request headers
193
196
 
194
197
  - **Content-Type**: Not defined
195
198
  - **Accept**: application/json
@@ -207,7 +210,7 @@ Get Aggregates on normalized messages.
207
210
  ```ruby
208
211
  # load the gem
209
212
  require 'artikcloud'
210
- # setup authorization
213
+ # setup authorization
211
214
  ArtikCloud.configure do |config|
212
215
  # Configure OAuth2 access token for authorization: artikcloud_oauth
213
216
  config.access_token = 'YOUR ACCESS TOKEN'
@@ -250,7 +253,130 @@ Name | Type | Description | Notes
250
253
 
251
254
  [artikcloud_oauth](../README.md#artikcloud_oauth)
252
255
 
253
- ### HTTP reuqest headers
256
+ ### HTTP request headers
257
+
258
+ - **Content-Type**: Not defined
259
+ - **Accept**: application/json
260
+
261
+
262
+
263
+ # **get_message_snapshots**
264
+ > SnapshotResponses get_message_snapshots(sdids, opts)
265
+
266
+ Get Message Snapshots
267
+
268
+ Get message snapshots.
269
+
270
+ ### Example
271
+ ```ruby
272
+ # load the gem
273
+ require 'artikcloud'
274
+ # setup authorization
275
+ ArtikCloud.configure do |config|
276
+ # Configure OAuth2 access token for authorization: artikcloud_oauth
277
+ config.access_token = 'YOUR ACCESS TOKEN'
278
+ end
279
+
280
+ api_instance = ArtikCloud::MessagesApi.new
281
+
282
+ sdids = "sdids_example" # String | Device IDs for which the snapshots are requested. Max 100 device ids per call.
283
+
284
+ opts = {
285
+ include_timestamp: true # BOOLEAN | Indicates whether to return timestamps of the last update for each field.
286
+ }
287
+
288
+ begin
289
+ #Get Message Snapshots
290
+ result = api_instance.get_message_snapshots(sdids, opts)
291
+ p result
292
+ rescue ArtikCloud::ApiError => e
293
+ puts "Exception when calling MessagesApi->get_message_snapshots: #{e}"
294
+ end
295
+ ```
296
+
297
+ ### Parameters
298
+
299
+ Name | Type | Description | Notes
300
+ ------------- | ------------- | ------------- | -------------
301
+ **sdids** | **String**| Device IDs for which the snapshots are requested. Max 100 device ids per call. |
302
+ **include_timestamp** | **BOOLEAN**| Indicates whether to return timestamps of the last update for each field. | [optional]
303
+
304
+ ### Return type
305
+
306
+ [**SnapshotResponses**](SnapshotResponses.md)
307
+
308
+ ### Authorization
309
+
310
+ [artikcloud_oauth](../README.md#artikcloud_oauth)
311
+
312
+ ### HTTP request headers
313
+
314
+ - **Content-Type**: Not defined
315
+ - **Accept**: application/json
316
+
317
+
318
+
319
+ # **get_normalized_actions**
320
+ > NormalizedActionsEnvelope get_normalized_actions(opts)
321
+
322
+ Get Normalized Actions
323
+
324
+ Get the actions normalized
325
+
326
+ ### Example
327
+ ```ruby
328
+ # load the gem
329
+ require 'artikcloud'
330
+ # setup authorization
331
+ ArtikCloud.configure do |config|
332
+ # Configure OAuth2 access token for authorization: artikcloud_oauth
333
+ config.access_token = 'YOUR ACCESS TOKEN'
334
+ end
335
+
336
+ api_instance = ArtikCloud::MessagesApi.new
337
+
338
+ opts = {
339
+ uid: "uid_example", # String | User ID. If not specified, assume that of the current authenticated user. If specified, it must be that of a user for which the current authenticated user has read access to.
340
+ ddid: "ddid_example", # String | Destination device ID of the actions being searched.
341
+ mid: "mid_example", # String | The message ID being searched.
342
+ offset: "offset_example", # String | A string that represents the starting item, should be the value of 'next' field received in the last response. (required for pagination)
343
+ count: 56, # Integer | count
344
+ start_date: 789, # Integer | startDate
345
+ end_date: 789, # Integer | endDate
346
+ order: "order_example" # String | Desired sort order: 'asc' or 'desc'
347
+ }
348
+
349
+ begin
350
+ #Get Normalized Actions
351
+ result = api_instance.get_normalized_actions(opts)
352
+ p result
353
+ rescue ArtikCloud::ApiError => e
354
+ puts "Exception when calling MessagesApi->get_normalized_actions: #{e}"
355
+ end
356
+ ```
357
+
358
+ ### Parameters
359
+
360
+ Name | Type | Description | Notes
361
+ ------------- | ------------- | ------------- | -------------
362
+ **uid** | **String**| User ID. If not specified, assume that of the current authenticated user. If specified, it must be that of a user for which the current authenticated user has read access to. | [optional]
363
+ **ddid** | **String**| Destination device ID of the actions being searched. | [optional]
364
+ **mid** | **String**| The message ID being searched. | [optional]
365
+ **offset** | **String**| A string that represents the starting item, should be the value of 'next' field received in the last response. (required for pagination) | [optional]
366
+ **count** | **Integer**| count | [optional]
367
+ **start_date** | **Integer**| startDate | [optional]
368
+ **end_date** | **Integer**| endDate | [optional]
369
+ **order** | **String**| Desired sort order: 'asc' or 'desc' | [optional]
370
+
371
+ ### Return type
372
+
373
+ [**NormalizedActionsEnvelope**](NormalizedActionsEnvelope.md)
374
+
375
+ ### Authorization
376
+
377
+ [artikcloud_oauth](../README.md#artikcloud_oauth)
378
+
379
+ ### HTTP request headers
254
380
 
255
381
  - **Content-Type**: Not defined
256
382
  - **Accept**: application/json
@@ -268,7 +394,7 @@ Get the messages normalized
268
394
  ```ruby
269
395
  # load the gem
270
396
  require 'artikcloud'
271
- # setup authorization
397
+ # setup authorization
272
398
  ArtikCloud.configure do |config|
273
399
  # Configure OAuth2 access token for authorization: artikcloud_oauth
274
400
  config.access_token = 'YOUR ACCESS TOKEN'
@@ -279,7 +405,7 @@ api_instance = ArtikCloud::MessagesApi.new
279
405
  opts = {
280
406
  uid: "uid_example", # String | User ID. If not specified, assume that of the current authenticated user. If specified, it must be that of a user for which the current authenticated user has read access to.
281
407
  sdid: "sdid_example", # String | Source device ID of the messages being searched.
282
- mid: "mid_example", # String | The SAMI message ID being searched.
408
+ mid: "mid_example", # String | The message ID being searched.
283
409
  field_presence: "field_presence_example", # String | String representing a field from the specified device ID.
284
410
  filter: "filter_example", # String | Filter.
285
411
  offset: "offset_example", # String | A string that represents the starting item, should be the value of 'next' field received in the last response. (required for pagination)
@@ -304,7 +430,7 @@ Name | Type | Description | Notes
304
430
  ------------- | ------------- | ------------- | -------------
305
431
  **uid** | **String**| User ID. If not specified, assume that of the current authenticated user. If specified, it must be that of a user for which the current authenticated user has read access to. | [optional]
306
432
  **sdid** | **String**| Source device ID of the messages being searched. | [optional]
307
- **mid** | **String**| The SAMI message ID being searched. | [optional]
433
+ **mid** | **String**| The message ID being searched. | [optional]
308
434
  **field_presence** | **String**| String representing a field from the specified device ID. | [optional]
309
435
  **filter** | **String**| Filter. | [optional]
310
436
  **offset** | **String**| A string that represents the starting item, should be the value of 'next' field received in the last response. (required for pagination) | [optional]
@@ -321,25 +447,77 @@ Name | Type | Description | Notes
321
447
 
322
448
  [artikcloud_oauth](../README.md#artikcloud_oauth)
323
449
 
324
- ### HTTP reuqest headers
450
+ ### HTTP request headers
451
+
452
+ - **Content-Type**: Not defined
453
+ - **Accept**: application/json
454
+
455
+
456
+
457
+ # **send_actions**
458
+ > MessageIDEnvelope send_actions(data)
459
+
460
+ Send Actions
461
+
462
+ Send Actions
463
+
464
+ ### Example
465
+ ```ruby
466
+ # load the gem
467
+ require 'artikcloud'
468
+ # setup authorization
469
+ ArtikCloud.configure do |config|
470
+ # Configure OAuth2 access token for authorization: artikcloud_oauth
471
+ config.access_token = 'YOUR ACCESS TOKEN'
472
+ end
473
+
474
+ api_instance = ArtikCloud::MessagesApi.new
475
+
476
+ data = ArtikCloud::Actions.new # Actions | Actions that are passed in the body
477
+
478
+
479
+ begin
480
+ #Send Actions
481
+ result = api_instance.send_actions(data)
482
+ p result
483
+ rescue ArtikCloud::ApiError => e
484
+ puts "Exception when calling MessagesApi->send_actions: #{e}"
485
+ end
486
+ ```
487
+
488
+ ### Parameters
489
+
490
+ Name | Type | Description | Notes
491
+ ------------- | ------------- | ------------- | -------------
492
+ **data** | [**Actions**](Actions.md)| Actions that are passed in the body |
493
+
494
+ ### Return type
495
+
496
+ [**MessageIDEnvelope**](MessageIDEnvelope.md)
497
+
498
+ ### Authorization
499
+
500
+ [artikcloud_oauth](../README.md#artikcloud_oauth)
501
+
502
+ ### HTTP request headers
325
503
 
326
504
  - **Content-Type**: Not defined
327
505
  - **Accept**: application/json
328
506
 
329
507
 
330
508
 
331
- # **send_message_action**
332
- > MessageIDEnvelope send_message_action(data)
509
+ # **send_message**
510
+ > MessageIDEnvelope send_message(data)
333
511
 
334
- Send Message Action
512
+ Send Message
335
513
 
336
- Send a message or an Action:<br/><table><tr><th>Combination</th><th>Parameters</th><th>Description</th></tr><tr><td>Send Message</td><td>sdid, type=message</td><td>Send a message from a Source Device</td></tr><tr><td>Send Action</td><td>ddid, type=action</td><td>Send an action to a Destination Device</td></tr><tr><td>Common</td><td>data, ts, token</td><td>Parameters that can be used with the above combinations.</td></tr></table>
514
+ Send a message
337
515
 
338
516
  ### Example
339
517
  ```ruby
340
518
  # load the gem
341
519
  require 'artikcloud'
342
- # setup authorization
520
+ # setup authorization
343
521
  ArtikCloud.configure do |config|
344
522
  # Configure OAuth2 access token for authorization: artikcloud_oauth
345
523
  config.access_token = 'YOUR ACCESS TOKEN'
@@ -347,15 +525,15 @@ end
347
525
 
348
526
  api_instance = ArtikCloud::MessagesApi.new
349
527
 
350
- data = ArtikCloud::MessageAction.new # MessageAction | Message or Action object that is passed in the body
528
+ data = ArtikCloud::Message.new # Message | Message object that is passed in the body
351
529
 
352
530
 
353
531
  begin
354
- #Send Message Action
355
- result = api_instance.send_message_action(data)
532
+ #Send Message
533
+ result = api_instance.send_message(data)
356
534
  p result
357
535
  rescue ArtikCloud::ApiError => e
358
- puts "Exception when calling MessagesApi->send_message_action: #{e}"
536
+ puts "Exception when calling MessagesApi->send_message: #{e}"
359
537
  end
360
538
  ```
361
539
 
@@ -363,7 +541,7 @@ end
363
541
 
364
542
  Name | Type | Description | Notes
365
543
  ------------- | ------------- | ------------- | -------------
366
- **data** | [**MessageAction**](MessageAction.md)| Message or Action object that is passed in the body |
544
+ **data** | [**Message**](Message.md)| Message object that is passed in the body |
367
545
 
368
546
  ### Return type
369
547
 
@@ -373,7 +551,7 @@ Name | Type | Description | Notes
373
551
 
374
552
  [artikcloud_oauth](../README.md#artikcloud_oauth)
375
553
 
376
- ### HTTP reuqest headers
554
+ ### HTTP request headers
377
555
 
378
556
  - **Content-Type**: Not defined
379
557
  - **Accept**: application/json
@@ -0,0 +1,16 @@
1
+ # ArtikCloud::NormalizedAction
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **cts** | **Integer** | |
7
+ **ts** | **Integer** | |
8
+ **mid** | **String** | |
9
+ **sdid** | **String** | | [optional]
10
+ **ddid** | **String** | |
11
+ **ddtid** | **String** | |
12
+ **uid** | **String** | |
13
+ **mv** | **Integer** | |
14
+ **data** | [**ActionArray**](ActionArray.md) | |
15
+
16
+
@@ -0,0 +1,17 @@
1
+ # ArtikCloud::NormalizedActionsEnvelope
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **ddids** | **String** | | [optional]
7
+ **ddid** | **String** | | [optional]
8
+ **uid** | **String** | | [optional]
9
+ **start_date** | **Integer** | | [optional]
10
+ **end_date** | **Integer** | | [optional]
11
+ **order** | **String** | | [optional]
12
+ **_next** | **String** | | [optional]
13
+ **count** | **Integer** | |
14
+ **size** | **Integer** | |
15
+ **data** | [**Array&lt;NormalizedAction&gt;**](NormalizedAction.md) | |
16
+
17
+
@@ -0,0 +1,9 @@
1
+ # ArtikCloud::PresenceEnvelope
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **data** | [**PresenceModel**](PresenceModel.md) | | [optional]
7
+ **sdid** | **String** | | [optional]
8
+
9
+
@@ -0,0 +1,9 @@
1
+ # ArtikCloud::PresenceModel
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **connected** | **BOOLEAN** | | [optional]
7
+ **last_seen_on** | **Integer** | | [optional]
8
+
9
+
@@ -20,7 +20,7 @@ This call updates the registration request issued earlier by associating it with
20
20
  ```ruby
21
21
  # load the gem
22
22
  require 'artikcloud'
23
- # setup authorization
23
+ # setup authorization
24
24
  ArtikCloud.configure do |config|
25
25
  # Configure OAuth2 access token for authorization: artikcloud_oauth
26
26
  config.access_token = 'YOUR ACCESS TOKEN'
@@ -54,7 +54,7 @@ Name | Type | Description | Notes
54
54
 
55
55
  [artikcloud_oauth](../README.md#artikcloud_oauth)
56
56
 
57
- ### HTTP reuqest headers
57
+ ### HTTP request headers
58
58
 
59
59
  - **Content-Type**: Not defined
60
60
  - **Accept**: application/json
@@ -72,7 +72,7 @@ This call checks the status of the request so users can poll and know when regis
72
72
  ```ruby
73
73
  # load the gem
74
74
  require 'artikcloud'
75
- # setup authorization
75
+ # setup authorization
76
76
  ArtikCloud.configure do |config|
77
77
  # Configure OAuth2 access token for authorization: artikcloud_oauth
78
78
  config.access_token = 'YOUR ACCESS TOKEN'
@@ -106,7 +106,7 @@ Name | Type | Description | Notes
106
106
 
107
107
  [artikcloud_oauth](../README.md#artikcloud_oauth)
108
108
 
109
- ### HTTP reuqest headers
109
+ ### HTTP request headers
110
110
 
111
111
  - **Content-Type**: Not defined
112
112
  - **Accept**: application/json
@@ -124,7 +124,7 @@ This call clears any associations from the secure device registration.
124
124
  ```ruby
125
125
  # load the gem
126
126
  require 'artikcloud'
127
- # setup authorization
127
+ # setup authorization
128
128
  ArtikCloud.configure do |config|
129
129
  # Configure OAuth2 access token for authorization: artikcloud_oauth
130
130
  config.access_token = 'YOUR ACCESS TOKEN'
@@ -158,7 +158,7 @@ Name | Type | Description | Notes
158
158
 
159
159
  [artikcloud_oauth](../README.md#artikcloud_oauth)
160
160
 
161
- ### HTTP reuqest headers
161
+ ### HTTP request headers
162
162
 
163
163
  - **Content-Type**: Not defined
164
164
  - **Accept**: application/json
data/docs/RulesApi.md CHANGED
@@ -21,7 +21,7 @@ Create a new Rule
21
21
  ```ruby
22
22
  # load the gem
23
23
  require 'artikcloud'
24
- # setup authorization
24
+ # setup authorization
25
25
  ArtikCloud.configure do |config|
26
26
  # Configure OAuth2 access token for authorization: artikcloud_oauth
27
27
  config.access_token = 'YOUR ACCESS TOKEN'
@@ -58,7 +58,7 @@ Name | Type | Description | Notes
58
58
 
59
59
  [artikcloud_oauth](../README.md#artikcloud_oauth)
60
60
 
61
- ### HTTP reuqest headers
61
+ ### HTTP request headers
62
62
 
63
63
  - **Content-Type**: Not defined
64
64
  - **Accept**: application/json
@@ -76,7 +76,7 @@ Delete a Rule
76
76
  ```ruby
77
77
  # load the gem
78
78
  require 'artikcloud'
79
- # setup authorization
79
+ # setup authorization
80
80
  ArtikCloud.configure do |config|
81
81
  # Configure OAuth2 access token for authorization: artikcloud_oauth
82
82
  config.access_token = 'YOUR ACCESS TOKEN'
@@ -110,7 +110,7 @@ Name | Type | Description | Notes
110
110
 
111
111
  [artikcloud_oauth](../README.md#artikcloud_oauth)
112
112
 
113
- ### HTTP reuqest headers
113
+ ### HTTP request headers
114
114
 
115
115
  - **Content-Type**: Not defined
116
116
  - **Accept**: application/json
@@ -128,7 +128,7 @@ Get a rule using the Rule ID
128
128
  ```ruby
129
129
  # load the gem
130
130
  require 'artikcloud'
131
- # setup authorization
131
+ # setup authorization
132
132
  ArtikCloud.configure do |config|
133
133
  # Configure OAuth2 access token for authorization: artikcloud_oauth
134
134
  config.access_token = 'YOUR ACCESS TOKEN'
@@ -162,7 +162,7 @@ Name | Type | Description | Notes
162
162
 
163
163
  [artikcloud_oauth](../README.md#artikcloud_oauth)
164
164
 
165
- ### HTTP reuqest headers
165
+ ### HTTP request headers
166
166
 
167
167
  - **Content-Type**: Not defined
168
168
  - **Accept**: application/json
@@ -180,7 +180,7 @@ Update an existing Rule
180
180
  ```ruby
181
181
  # load the gem
182
182
  require 'artikcloud'
183
- # setup authorization
183
+ # setup authorization
184
184
  ArtikCloud.configure do |config|
185
185
  # Configure OAuth2 access token for authorization: artikcloud_oauth
186
186
  config.access_token = 'YOUR ACCESS TOKEN'
@@ -217,7 +217,7 @@ Name | Type | Description | Notes
217
217
 
218
218
  [artikcloud_oauth](../README.md#artikcloud_oauth)
219
219
 
220
- ### HTTP reuqest headers
220
+ ### HTTP request headers
221
221
 
222
222
  - **Content-Type**: Not defined
223
223
  - **Accept**: application/json
@@ -4,7 +4,7 @@
4
4
  Name | Type | Description | Notes
5
5
  ------------ | ------------- | ------------- | -------------
6
6
  **count** | **Integer** | | [optional]
7
- **data** | [**RuleArray**](RuleArray.md) | | [optional]
7
+ **data** | [**Array&lt;OutputRule&gt;**](OutputRule.md) | | [optional]
8
8
  **offset** | **Integer** | | [optional]
9
9
  **total** | **Integer** | | [optional]
10
10
 
@@ -0,0 +1,9 @@
1
+ # ArtikCloud::SnapshotResponse
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **data** | **Hash&lt;String, Object&gt;** | | [optional]
7
+ **sdid** | **String** | | [optional]
8
+
9
+
@@ -0,0 +1,10 @@
1
+ # ArtikCloud::SnapshotResponses
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **sdids** | **String** | | [optional]
7
+ **size** | **Integer** | | [optional]
8
+ **data** | [**Array&lt;SnapshotResponse&gt;**](SnapshotResponse.md) | | [optional]
9
+
10
+
@@ -0,0 +1,9 @@
1
+ # ArtikCloud::SnapshotsResponseEnvelope
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **data** | [**SnapshotResponses**](SnapshotResponses.md) | | [optional]
7
+ **sdid** | **String** | | [optional]
8
+
9
+
data/docs/TagsApi.md CHANGED
@@ -20,7 +20,7 @@ Get all tags marked as categories
20
20
  ```ruby
21
21
  # load the gem
22
22
  require 'artikcloud'
23
- # setup authorization
23
+ # setup authorization
24
24
  ArtikCloud.configure do |config|
25
25
  # Configure OAuth2 access token for authorization: artikcloud_oauth
26
26
  config.access_token = 'YOUR ACCESS TOKEN'
@@ -48,7 +48,7 @@ This endpoint does not need any parameter.
48
48
 
49
49
  [artikcloud_oauth](../README.md#artikcloud_oauth)
50
50
 
51
- ### HTTP reuqest headers
51
+ ### HTTP request headers
52
52
 
53
53
  - **Content-Type**: Not defined
54
54
  - **Accept**: application/json
@@ -66,7 +66,7 @@ Get tag suggestions for applications, device types that have been most used with
66
66
  ```ruby
67
67
  # load the gem
68
68
  require 'artikcloud'
69
- # setup authorization
69
+ # setup authorization
70
70
  ArtikCloud.configure do |config|
71
71
  # Configure OAuth2 access token for authorization: artikcloud_oauth
72
72
  config.access_token = 'YOUR ACCESS TOKEN'
@@ -97,7 +97,7 @@ Name | Type | Description | Notes
97
97
  **entity_type** | **String**| Entity type name. | [optional]
98
98
  **tags** | **String**| Comma separated list of tags. | [optional]
99
99
  **name** | **String**| Name of tags used for type ahead. | [optional]
100
- **count** | [**Integer**](.md)| Number of results to return. Max 10. | [optional]
100
+ **count** | **Integer**| Number of results to return. Max 10. | [optional]
101
101
 
102
102
  ### Return type
103
103
 
@@ -107,7 +107,7 @@ Name | Type | Description | Notes
107
107
 
108
108
  [artikcloud_oauth](../README.md#artikcloud_oauth)
109
109
 
110
- ### HTTP reuqest headers
110
+ ### HTTP request headers
111
111
 
112
112
  - **Content-Type**: Not defined
113
113
  - **Accept**: application/json
@@ -125,7 +125,7 @@ Get all tags related to the list of categories
125
125
  ```ruby
126
126
  # load the gem
127
127
  require 'artikcloud'
128
- # setup authorization
128
+ # setup authorization
129
129
  ArtikCloud.configure do |config|
130
130
  # Configure OAuth2 access token for authorization: artikcloud_oauth
131
131
  config.access_token = 'YOUR ACCESS TOKEN'
@@ -160,7 +160,7 @@ Name | Type | Description | Notes
160
160
 
161
161
  [artikcloud_oauth](../README.md#artikcloud_oauth)
162
162
 
163
- ### HTTP reuqest headers
163
+ ### HTTP request headers
164
164
 
165
165
  - **Content-Type**: Not defined
166
166
  - **Accept**: application/json
data/docs/TokenInfo.md ADDED
@@ -0,0 +1,11 @@
1
+ # ArtikCloud::TokenInfo
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **client_id** | **String** | | [optional]
7
+ **device_id** | **String** | | [optional]
8
+ **expires_in** | **Integer** | | [optional]
9
+ **user_id** | **String** | | [optional]
10
+
11
+
@@ -0,0 +1,8 @@
1
+ # ArtikCloud::TokenInfoSuccessResponse
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **data** | [**TokenInfo**](TokenInfo.md) | | [optional]
7
+
8
+