losant_rest 1.9.1 → 1.10.2

Sign up to get free protection for your applications and to get access to all the features.
Files changed (166) hide show
  1. checksums.yaml +5 -5
  2. data/LICENSE +1 -1
  3. data/README.md +1 -1
  4. data/docs/_schemas.md +41608 -19945
  5. data/docs/application.md +168 -4
  6. data/docs/applicationTemplates.md +50 -0
  7. data/docs/applications.md +46 -0
  8. data/docs/auth.md +72 -0
  9. data/docs/device.md +1 -0
  10. data/docs/devices.md +89 -2
  11. data/docs/experienceEndpoint.md +43 -0
  12. data/docs/experienceEndpoints.md +1 -1
  13. data/docs/experienceView.md +43 -0
  14. data/lib/losant_rest.rb +2 -1
  15. data/lib/losant_rest/application.rb +144 -5
  16. data/lib/losant_rest/application_api_token.rb +1 -1
  17. data/lib/losant_rest/application_api_tokens.rb +1 -1
  18. data/lib/losant_rest/application_certificate.rb +1 -1
  19. data/lib/losant_rest/application_certificate_authorities.rb +1 -1
  20. data/lib/losant_rest/application_certificate_authority.rb +1 -1
  21. data/lib/losant_rest/application_certificates.rb +1 -1
  22. data/lib/losant_rest/application_key.rb +1 -1
  23. data/lib/losant_rest/application_keys.rb +1 -1
  24. data/lib/losant_rest/application_templates.rb +88 -0
  25. data/lib/losant_rest/applications.rb +1 -1
  26. data/lib/losant_rest/audit_log.rb +1 -1
  27. data/lib/losant_rest/audit_logs.rb +1 -1
  28. data/lib/losant_rest/auth.rb +85 -1
  29. data/lib/losant_rest/client.rb +7 -3
  30. data/lib/losant_rest/dashboard.rb +1 -1
  31. data/lib/losant_rest/dashboards.rb +1 -1
  32. data/lib/losant_rest/data.rb +1 -1
  33. data/lib/losant_rest/data_table.rb +1 -1
  34. data/lib/losant_rest/data_table_row.rb +1 -1
  35. data/lib/losant_rest/data_table_rows.rb +1 -1
  36. data/lib/losant_rest/data_tables.rb +1 -1
  37. data/lib/losant_rest/device.rb +3 -1
  38. data/lib/losant_rest/device_recipe.rb +1 -1
  39. data/lib/losant_rest/device_recipes.rb +1 -1
  40. data/lib/losant_rest/devices.rb +105 -3
  41. data/lib/losant_rest/edge_deployments.rb +1 -1
  42. data/lib/losant_rest/error.rb +1 -1
  43. data/lib/losant_rest/event.rb +1 -1
  44. data/lib/losant_rest/events.rb +1 -1
  45. data/lib/losant_rest/experience.rb +1 -1
  46. data/lib/losant_rest/experience_domain.rb +1 -1
  47. data/lib/losant_rest/experience_domains.rb +1 -1
  48. data/lib/losant_rest/experience_endpoint.rb +51 -1
  49. data/lib/losant_rest/experience_endpoints.rb +1 -1
  50. data/lib/losant_rest/experience_group.rb +1 -1
  51. data/lib/losant_rest/experience_groups.rb +1 -1
  52. data/lib/losant_rest/experience_slug.rb +1 -1
  53. data/lib/losant_rest/experience_slugs.rb +1 -1
  54. data/lib/losant_rest/experience_user.rb +1 -1
  55. data/lib/losant_rest/experience_users.rb +1 -1
  56. data/lib/losant_rest/experience_version.rb +1 -1
  57. data/lib/losant_rest/experience_versions.rb +1 -1
  58. data/lib/losant_rest/experience_view.rb +51 -1
  59. data/lib/losant_rest/experience_views.rb +1 -1
  60. data/lib/losant_rest/file.rb +1 -1
  61. data/lib/losant_rest/files.rb +1 -1
  62. data/lib/losant_rest/flow.rb +1 -1
  63. data/lib/losant_rest/flow_version.rb +1 -1
  64. data/lib/losant_rest/flow_versions.rb +1 -1
  65. data/lib/losant_rest/flows.rb +1 -1
  66. data/lib/losant_rest/integration.rb +1 -1
  67. data/lib/losant_rest/integrations.rb +1 -1
  68. data/lib/losant_rest/me.rb +1 -1
  69. data/lib/losant_rest/notebook.rb +1 -1
  70. data/lib/losant_rest/notebooks.rb +1 -1
  71. data/lib/losant_rest/org.rb +1 -1
  72. data/lib/losant_rest/org_invites.rb +1 -1
  73. data/lib/losant_rest/orgs.rb +1 -1
  74. data/lib/losant_rest/utils.rb +1 -1
  75. data/lib/losant_rest/version.rb +2 -2
  76. data/lib/losant_rest/webhook.rb +1 -1
  77. data/lib/losant_rest/webhooks.rb +1 -1
  78. data/schemas/advancedDeviceQuery.json +1018 -0
  79. data/schemas/advancedEventQuery.json +382 -13
  80. data/schemas/advancedQuery.json +37 -3
  81. data/schemas/application.json +10 -5
  82. data/schemas/applicationApiTokenPost.json +6 -0
  83. data/schemas/applicationCertificate.json +34 -0
  84. data/schemas/applicationCertificatePatch.json +34 -0
  85. data/schemas/applicationCertificatePost.json +34 -0
  86. data/schemas/applicationCertificates.json +34 -0
  87. data/schemas/{applicationCloneResult.json → applicationCreationByTemplateResult.json} +21 -8
  88. data/schemas/applicationExportPost.json +24 -0
  89. data/schemas/applicationExportResult.json +10 -0
  90. data/schemas/applicationKey.json +34 -0
  91. data/schemas/applicationKeyPatch.json +34 -0
  92. data/schemas/applicationKeyPost.json +34 -0
  93. data/schemas/applicationKeyPostResponse.json +34 -0
  94. data/schemas/applicationKeys.json +34 -0
  95. data/schemas/applicationPatch.json +10 -5
  96. data/schemas/applicationPost.json +14 -5
  97. data/schemas/applicationReadme.json +29 -0
  98. data/schemas/applicationReadmePatch.json +11 -0
  99. data/schemas/applicationTemplate.json +99 -0
  100. data/schemas/applicationTemplates.json +140 -0
  101. data/schemas/applications.json +10 -5
  102. data/schemas/authedDevice.json +34 -0
  103. data/schemas/dashboard.json +1228 -144
  104. data/schemas/dashboardPatch.json +1228 -144
  105. data/schemas/dashboardPost.json +1228 -144
  106. data/schemas/dashboards.json +1228 -144
  107. data/schemas/dataExport.json +11 -0
  108. data/schemas/dataTableRows.json +3 -0
  109. data/schemas/dataTableRowsExport.json +37 -3
  110. data/schemas/device.json +16 -3
  111. data/schemas/devicePatch.json +16 -3
  112. data/schemas/devicePost.json +16 -3
  113. data/schemas/deviceRecipe.json +16 -3
  114. data/schemas/deviceRecipePatch.json +16 -3
  115. data/schemas/deviceRecipePost.json +16 -3
  116. data/schemas/deviceRecipes.json +16 -3
  117. data/schemas/devices.json +19 -3
  118. data/schemas/devicesDataRemoved.json +12 -0
  119. data/schemas/devicesDeletePost.json +1034 -0
  120. data/schemas/devicesDeleted.json +12 -0
  121. data/schemas/devicesExportPost.json +1035 -0
  122. data/schemas/devicesPatch.json +1773 -7
  123. data/schemas/devicesRemoveDataPost.json +1056 -0
  124. data/schemas/devicesUpdated.json +18 -0
  125. data/schemas/events.json +1 -816
  126. data/schemas/eventsExport.json +382 -13
  127. data/schemas/experienceGroup.json +7 -0
  128. data/schemas/experienceGroupPatch.json +7 -0
  129. data/schemas/experienceGroupPost.json +7 -0
  130. data/schemas/experienceGroups.json +7 -0
  131. data/schemas/experienceLinkedResources.json +6659 -0
  132. data/schemas/flow.json +103 -1
  133. data/schemas/flowPatch.json +103 -1
  134. data/schemas/flowPost.json +103 -1
  135. data/schemas/flowVersion.json +206 -2
  136. data/schemas/flowVersionPost.json +103 -1
  137. data/schemas/flowVersions.json +206 -2
  138. data/schemas/flows.json +103 -1
  139. data/schemas/flowsImportPost.json +206 -2
  140. data/schemas/flowsImportResult.json +309 -3
  141. data/schemas/githubLogin.json +9 -0
  142. data/schemas/integration.json +4 -4
  143. data/schemas/integrationPatch.json +4 -4
  144. data/schemas/integrationPost.json +4 -4
  145. data/schemas/integrations.json +4 -4
  146. data/schemas/{applicationCloneEnqueued.json → jobEnqueuedResult.json} +0 -0
  147. data/schemas/me.json +3 -0
  148. data/schemas/multiDeviceCommand.json +1019 -0
  149. data/schemas/notebook.json +207 -35
  150. data/schemas/notebookDataExportOptions.json +4 -0
  151. data/schemas/notebookExecutionLogs.json +4 -0
  152. data/schemas/notebookExecutionOptions.json +4 -0
  153. data/schemas/notebookPatch.json +207 -35
  154. data/schemas/notebookPost.json +207 -35
  155. data/schemas/notebooks.json +207 -35
  156. data/schemas/org.json +8 -0
  157. data/schemas/orgPatch.json +9 -0
  158. data/schemas/orgs.json +8 -0
  159. data/schemas/samlResponse.json +21 -0
  160. data/schemas/ssoRequest.json +20 -0
  161. data/schemas/timeSeriesData.json +91 -12
  162. data/schemas/timeSeriesQuery.json +21 -12
  163. data/schemas/userCredentials.json +9 -0
  164. data/schemas/userPost.json +9 -0
  165. data/schemas/{validationCloneErrors.json → validationErrors.json} +9 -2
  166. metadata +24 -7
@@ -12,6 +12,40 @@
12
12
  "description": {
13
13
  "type": "string",
14
14
  "maxLength": 32767
15
+ },
16
+ "filterType": {
17
+ "oneOf": [
18
+ {
19
+ "type": "string",
20
+ "enum": [
21
+ "all",
22
+ "whitelist",
23
+ "blacklist"
24
+ ]
25
+ },
26
+ {
27
+ "type": "string",
28
+ "enum": [
29
+ "none"
30
+ ]
31
+ }
32
+ ]
33
+ },
34
+ "pubTopics": {
35
+ "type": "array",
36
+ "items": {
37
+ "type": "string",
38
+ "minLength": 1,
39
+ "maxLength": 1024
40
+ }
41
+ },
42
+ "subTopics": {
43
+ "type": "array",
44
+ "items": {
45
+ "type": "string",
46
+ "minLength": 1,
47
+ "maxLength": 1024
48
+ }
15
49
  }
16
50
  },
17
51
  "additionalProperties": false
@@ -32,6 +32,40 @@
32
32
  "description": {
33
33
  "type": "string",
34
34
  "maxLength": 32767
35
+ },
36
+ "filterType": {
37
+ "oneOf": [
38
+ {
39
+ "type": "string",
40
+ "enum": [
41
+ "all",
42
+ "whitelist",
43
+ "blacklist"
44
+ ]
45
+ },
46
+ {
47
+ "type": "string",
48
+ "enum": [
49
+ "none"
50
+ ]
51
+ }
52
+ ]
53
+ },
54
+ "pubTopics": {
55
+ "type": "array",
56
+ "items": {
57
+ "type": "string",
58
+ "minLength": 1,
59
+ "maxLength": 1024
60
+ }
61
+ },
62
+ "subTopics": {
63
+ "type": "array",
64
+ "items": {
65
+ "type": "string",
66
+ "minLength": 1,
67
+ "maxLength": 1024
68
+ }
35
69
  }
36
70
  },
37
71
  "additionalProperties": false
@@ -65,6 +65,40 @@
65
65
  "description": {
66
66
  "type": "string",
67
67
  "maxLength": 32767
68
+ },
69
+ "filterType": {
70
+ "oneOf": [
71
+ {
72
+ "type": "string",
73
+ "enum": [
74
+ "all",
75
+ "whitelist",
76
+ "blacklist"
77
+ ]
78
+ },
79
+ {
80
+ "type": "string",
81
+ "enum": [
82
+ "none"
83
+ ]
84
+ }
85
+ ]
86
+ },
87
+ "pubTopics": {
88
+ "type": "array",
89
+ "items": {
90
+ "type": "string",
91
+ "minLength": 1,
92
+ "maxLength": 1024
93
+ }
94
+ },
95
+ "subTopics": {
96
+ "type": "array",
97
+ "items": {
98
+ "type": "string",
99
+ "minLength": 1,
100
+ "maxLength": 1024
101
+ }
68
102
  }
69
103
  }
70
104
  }
@@ -69,6 +69,40 @@
69
69
  "description": {
70
70
  "type": "string",
71
71
  "maxLength": 32767
72
+ },
73
+ "filterType": {
74
+ "oneOf": [
75
+ {
76
+ "type": "string",
77
+ "enum": [
78
+ "all",
79
+ "whitelist",
80
+ "blacklist"
81
+ ]
82
+ },
83
+ {
84
+ "type": "string",
85
+ "enum": [
86
+ "none"
87
+ ]
88
+ }
89
+ ]
90
+ },
91
+ "pubTopics": {
92
+ "type": "array",
93
+ "items": {
94
+ "type": "string",
95
+ "minLength": 1,
96
+ "maxLength": 1024
97
+ }
98
+ },
99
+ "subTopics": {
100
+ "type": "array",
101
+ "items": {
102
+ "type": "string",
103
+ "minLength": 1,
104
+ "maxLength": 1024
105
+ }
72
106
  }
73
107
  }
74
108
  }
@@ -9,7 +9,7 @@
9
9
  },
10
10
  "description": {
11
11
  "type": "string",
12
- "maxLength": 32767
12
+ "maxLength": 1024
13
13
  },
14
14
  "endpointSlug": {
15
15
  "type": "string",
@@ -45,7 +45,7 @@
45
45
  },
46
46
  "description": {
47
47
  "type": "string",
48
- "maxLength": 32767
48
+ "maxLength": 1024
49
49
  }
50
50
  },
51
51
  "additionalProperties": false,
@@ -163,12 +163,12 @@
163
163
  },
164
164
  "accessKeyId": {
165
165
  "type": "string",
166
- "min": 16,
166
+ "min": 4,
167
167
  "max": 128
168
168
  },
169
169
  "secretAccessKey": {
170
170
  "type": "string",
171
- "min": 16,
171
+ "min": 4,
172
172
  "max": 128
173
173
  },
174
174
  "region": {
@@ -195,7 +195,7 @@
195
195
  "keyJson": {
196
196
  "type": "string",
197
197
  "maxLength": 32767,
198
- "minLength": 50
198
+ "minLength": 4
199
199
  },
200
200
  "bucket": {
201
201
  "type": "string",
@@ -236,6 +236,11 @@
236
236
  }
237
237
  },
238
238
  "additionalProperties": false
239
+ },
240
+ "blobUrlTTL": {
241
+ "type": "number",
242
+ "minimum": 3600,
243
+ "maximum": 604800
239
244
  }
240
245
  },
241
246
  "additionalProperties": false
@@ -6,6 +6,10 @@
6
6
  "type": "string",
7
7
  "pattern": "^[A-Fa-f\\d]{24}$"
8
8
  },
9
+ "applicationTemplateId": {
10
+ "type": "string",
11
+ "pattern": "^[A-Fa-f\\d]{24}$"
12
+ },
9
13
  "name": {
10
14
  "type": "string",
11
15
  "minLength": 1,
@@ -13,7 +17,7 @@
13
17
  },
14
18
  "description": {
15
19
  "type": "string",
16
- "maxLength": 32767
20
+ "maxLength": 1024
17
21
  },
18
22
  "endpointSlug": {
19
23
  "type": "string",
@@ -49,7 +53,7 @@
49
53
  },
50
54
  "description": {
51
55
  "type": "string",
52
- "maxLength": 32767
56
+ "maxLength": 1024
53
57
  }
54
58
  },
55
59
  "additionalProperties": false,
@@ -138,12 +142,12 @@
138
142
  },
139
143
  "accessKeyId": {
140
144
  "type": "string",
141
- "min": 16,
145
+ "min": 4,
142
146
  "max": 128
143
147
  },
144
148
  "secretAccessKey": {
145
149
  "type": "string",
146
- "min": 16,
150
+ "min": 4,
147
151
  "max": 128
148
152
  },
149
153
  "region": {
@@ -170,7 +174,7 @@
170
174
  "keyJson": {
171
175
  "type": "string",
172
176
  "maxLength": 32767,
173
- "minLength": 50
177
+ "minLength": 4
174
178
  },
175
179
  "bucket": {
176
180
  "type": "string",
@@ -211,6 +215,11 @@
211
215
  }
212
216
  },
213
217
  "additionalProperties": false
218
+ },
219
+ "blobUrlTTL": {
220
+ "type": "number",
221
+ "minimum": 3600,
222
+ "maximum": 604800
214
223
  }
215
224
  },
216
225
  "additionalProperties": false,
@@ -0,0 +1,29 @@
1
+ {
2
+ "$schema": "http://json-schema.org/draft-04/schema#",
3
+ "type": "object",
4
+ "properties": {
5
+ "applicationId": {
6
+ "type": "string",
7
+ "pattern": "^[A-Fa-f\\d]{24}$"
8
+ },
9
+ "lastUpdated": {
10
+ "type": "string",
11
+ "format": "date-time"
12
+ },
13
+ "lastUpdatedById": {
14
+ "type": "string",
15
+ "pattern": "^[A-Fa-f\\d]{24}$"
16
+ },
17
+ "lastUpdatedByType": {
18
+ "type": "string",
19
+ "enum": [
20
+ "flow",
21
+ "user",
22
+ "apiToken"
23
+ ]
24
+ },
25
+ "content": {
26
+ "type": "string"
27
+ }
28
+ }
29
+ }
@@ -0,0 +1,11 @@
1
+ {
2
+ "$schema": "http://json-schema.org/draft-04/schema#",
3
+ "type": "object",
4
+ "properties": {
5
+ "content": {
6
+ "type": "string",
7
+ "maxLength": 131072
8
+ }
9
+ },
10
+ "additionalProperties": false
11
+ }
@@ -0,0 +1,99 @@
1
+ {
2
+ "$schema": "http://json-schema.org/draft-04/schema#",
3
+ "type": "object",
4
+ "properties": {
5
+ "id": {
6
+ "type": "string",
7
+ "pattern": "^[A-Fa-f\\d]{24}$"
8
+ },
9
+ "creationDate": {
10
+ "type": "string",
11
+ "format": "date-time"
12
+ },
13
+ "lastUpdated": {
14
+ "type": "string",
15
+ "format": "date-time"
16
+ },
17
+ "name": {
18
+ "type": "string",
19
+ "minLength": 1,
20
+ "maxLength": 255
21
+ },
22
+ "description": {
23
+ "type": "string",
24
+ "maxLength": 1024
25
+ },
26
+ "public": {
27
+ "type": "boolean"
28
+ },
29
+ "authorName": {
30
+ "type": "string",
31
+ "maxLength": 255
32
+ },
33
+ "imageUrl": {
34
+ "type": "string",
35
+ "maxLength": 1024
36
+ },
37
+ "authorUrl": {
38
+ "type": "string",
39
+ "maxLength": 1024
40
+ },
41
+ "templateUrl": {
42
+ "type": "string",
43
+ "maxLength": 1024
44
+ },
45
+ "summary": {
46
+ "type": "object",
47
+ "properties": {
48
+ "applicationCertificateAuthorityCount": {
49
+ "type": "number"
50
+ },
51
+ "dashboardCount": {
52
+ "type": "number"
53
+ },
54
+ "deviceCount": {
55
+ "type": "number"
56
+ },
57
+ "deviceRecipeCount": {
58
+ "type": "number"
59
+ },
60
+ "dataTableCount": {
61
+ "type": "number"
62
+ },
63
+ "experienceGroupCount": {
64
+ "type": "number"
65
+ },
66
+ "experienceUserCount": {
67
+ "type": "number"
68
+ },
69
+ "experienceVersionCount": {
70
+ "type": "number"
71
+ },
72
+ "experienceViewCount": {
73
+ "type": "number"
74
+ },
75
+ "experienceEndpointCount": {
76
+ "type": "number"
77
+ },
78
+ "fileCount": {
79
+ "type": "number"
80
+ },
81
+ "flowCount": {
82
+ "type": "number"
83
+ },
84
+ "integrationCount": {
85
+ "type": "number"
86
+ },
87
+ "notebookCount": {
88
+ "type": "number"
89
+ },
90
+ "dataTableCsvSize": {
91
+ "type": "number"
92
+ },
93
+ "webhookCount": {
94
+ "type": "number"
95
+ }
96
+ }
97
+ }
98
+ }
99
+ }
@@ -0,0 +1,140 @@
1
+ {
2
+ "$schema": "http://json-schema.org/draft-04/schema#",
3
+ "type": "object",
4
+ "properties": {
5
+ "items": {
6
+ "type": "array",
7
+ "items": {
8
+ "title": "Application Template",
9
+ "description": "Schema for a single Application Template",
10
+ "type": "object",
11
+ "properties": {
12
+ "id": {
13
+ "type": "string",
14
+ "pattern": "^[A-Fa-f\\d]{24}$"
15
+ },
16
+ "creationDate": {
17
+ "type": "string",
18
+ "format": "date-time"
19
+ },
20
+ "lastUpdated": {
21
+ "type": "string",
22
+ "format": "date-time"
23
+ },
24
+ "name": {
25
+ "type": "string",
26
+ "minLength": 1,
27
+ "maxLength": 255
28
+ },
29
+ "description": {
30
+ "type": "string",
31
+ "maxLength": 1024
32
+ },
33
+ "public": {
34
+ "type": "boolean"
35
+ },
36
+ "authorName": {
37
+ "type": "string",
38
+ "maxLength": 255
39
+ },
40
+ "imageUrl": {
41
+ "type": "string",
42
+ "maxLength": 1024
43
+ },
44
+ "authorUrl": {
45
+ "type": "string",
46
+ "maxLength": 1024
47
+ },
48
+ "templateUrl": {
49
+ "type": "string",
50
+ "maxLength": 1024
51
+ },
52
+ "summary": {
53
+ "type": "object",
54
+ "properties": {
55
+ "applicationCertificateAuthorityCount": {
56
+ "type": "number"
57
+ },
58
+ "dashboardCount": {
59
+ "type": "number"
60
+ },
61
+ "deviceCount": {
62
+ "type": "number"
63
+ },
64
+ "deviceRecipeCount": {
65
+ "type": "number"
66
+ },
67
+ "dataTableCount": {
68
+ "type": "number"
69
+ },
70
+ "experienceGroupCount": {
71
+ "type": "number"
72
+ },
73
+ "experienceUserCount": {
74
+ "type": "number"
75
+ },
76
+ "experienceVersionCount": {
77
+ "type": "number"
78
+ },
79
+ "experienceViewCount": {
80
+ "type": "number"
81
+ },
82
+ "experienceEndpointCount": {
83
+ "type": "number"
84
+ },
85
+ "fileCount": {
86
+ "type": "number"
87
+ },
88
+ "flowCount": {
89
+ "type": "number"
90
+ },
91
+ "integrationCount": {
92
+ "type": "number"
93
+ },
94
+ "notebookCount": {
95
+ "type": "number"
96
+ },
97
+ "dataTableCsvSize": {
98
+ "type": "number"
99
+ },
100
+ "webhookCount": {
101
+ "type": "number"
102
+ }
103
+ }
104
+ }
105
+ }
106
+ }
107
+ },
108
+ "count": {
109
+ "type": "integer"
110
+ },
111
+ "totalCount": {
112
+ "type": "integer"
113
+ },
114
+ "perPage": {
115
+ "type": "integer"
116
+ },
117
+ "page": {
118
+ "type": "integer"
119
+ },
120
+ "filter": {
121
+ "type": "string"
122
+ },
123
+ "filterField": {
124
+ "type": "string"
125
+ },
126
+ "sortField": {
127
+ "type": "string"
128
+ },
129
+ "sortDirection": {
130
+ "type": "string",
131
+ "enum": [
132
+ "asc",
133
+ "desc",
134
+ "ASC",
135
+ "DESC",
136
+ ""
137
+ ]
138
+ }
139
+ }
140
+ }