losant_rest 1.8.7 → 1.8.9

Sign up to get free protection for your applications and to get access to all the features.
Files changed (167) hide show
  1. checksums.yaml +4 -4
  2. data/docs/_schemas.md +38618 -21196
  3. data/docs/application.md +76 -0
  4. data/docs/auth.md +0 -36
  5. data/docs/dashboards.md +1 -1
  6. data/docs/dataTableRows.md +2 -2
  7. data/docs/device.md +1 -0
  8. data/docs/events.md +81 -0
  9. data/docs/file.md +43 -0
  10. data/docs/me.md +50 -13
  11. data/lib/losant_rest.rb +0 -4
  12. data/lib/losant_rest/application.rb +90 -0
  13. data/lib/losant_rest/application_api_token.rb +2 -0
  14. data/lib/losant_rest/application_api_tokens.rb +2 -0
  15. data/lib/losant_rest/application_certificate.rb +2 -0
  16. data/lib/losant_rest/application_certificate_authorities.rb +2 -0
  17. data/lib/losant_rest/application_certificate_authority.rb +2 -0
  18. data/lib/losant_rest/application_certificates.rb +2 -0
  19. data/lib/losant_rest/application_key.rb +2 -0
  20. data/lib/losant_rest/application_keys.rb +2 -0
  21. data/lib/losant_rest/applications.rb +2 -0
  22. data/lib/losant_rest/audit_log.rb +2 -0
  23. data/lib/losant_rest/audit_logs.rb +2 -0
  24. data/lib/losant_rest/auth.rb +2 -42
  25. data/lib/losant_rest/client.rb +2 -18
  26. data/lib/losant_rest/dashboard.rb +2 -0
  27. data/lib/losant_rest/dashboards.rb +3 -1
  28. data/lib/losant_rest/data.rb +2 -0
  29. data/lib/losant_rest/data_table.rb +2 -0
  30. data/lib/losant_rest/data_table_row.rb +2 -0
  31. data/lib/losant_rest/data_table_rows.rb +4 -2
  32. data/lib/losant_rest/data_tables.rb +2 -0
  33. data/lib/losant_rest/device.rb +4 -0
  34. data/lib/losant_rest/device_recipe.rb +2 -0
  35. data/lib/losant_rest/device_recipes.rb +2 -0
  36. data/lib/losant_rest/devices.rb +2 -0
  37. data/lib/losant_rest/edge_deployments.rb +2 -0
  38. data/lib/losant_rest/event.rb +2 -0
  39. data/lib/losant_rest/events.rb +103 -0
  40. data/lib/losant_rest/experience.rb +2 -0
  41. data/lib/losant_rest/experience_domain.rb +2 -0
  42. data/lib/losant_rest/experience_domains.rb +2 -0
  43. data/lib/losant_rest/experience_endpoint.rb +2 -0
  44. data/lib/losant_rest/experience_endpoints.rb +2 -0
  45. data/lib/losant_rest/experience_group.rb +2 -0
  46. data/lib/losant_rest/experience_groups.rb +2 -0
  47. data/lib/losant_rest/experience_slug.rb +2 -0
  48. data/lib/losant_rest/experience_slugs.rb +2 -0
  49. data/lib/losant_rest/experience_user.rb +2 -0
  50. data/lib/losant_rest/experience_users.rb +2 -0
  51. data/lib/losant_rest/experience_version.rb +2 -0
  52. data/lib/losant_rest/experience_versions.rb +2 -0
  53. data/lib/losant_rest/experience_view.rb +2 -0
  54. data/lib/losant_rest/experience_views.rb +2 -0
  55. data/lib/losant_rest/file.rb +2 -0
  56. data/lib/losant_rest/files.rb +2 -0
  57. data/lib/losant_rest/flow.rb +2 -0
  58. data/lib/losant_rest/flow_version.rb +2 -0
  59. data/lib/losant_rest/flow_versions.rb +2 -0
  60. data/lib/losant_rest/flows.rb +2 -0
  61. data/lib/losant_rest/integration.rb +2 -0
  62. data/lib/losant_rest/integrations.rb +2 -0
  63. data/lib/losant_rest/me.rb +57 -13
  64. data/lib/losant_rest/notebook.rb +2 -0
  65. data/lib/losant_rest/notebooks.rb +2 -0
  66. data/lib/losant_rest/org.rb +2 -0
  67. data/lib/losant_rest/org_invites.rb +2 -0
  68. data/lib/losant_rest/orgs.rb +2 -0
  69. data/lib/losant_rest/version.rb +1 -1
  70. data/lib/losant_rest/webhook.rb +2 -0
  71. data/lib/losant_rest/webhooks.rb +2 -0
  72. data/schemas/advancedEventQuery.json +817 -0
  73. data/schemas/{dataTableQuery.json → advancedQuery.json} +5 -4
  74. data/schemas/apiTokens.json +4 -1
  75. data/schemas/application.json +30 -1
  76. data/schemas/applicationApiTokenPost.json +5 -0
  77. data/schemas/applicationCertificate.json +29 -1
  78. data/schemas/applicationCertificateAuthorities.json +36 -3
  79. data/schemas/applicationCertificateAuthority.json +32 -2
  80. data/schemas/applicationCertificateAuthorityPatch.json +3 -1
  81. data/schemas/applicationCertificateAuthorityPost.json +3 -1
  82. data/schemas/applicationCertificatePatch.json +3 -1
  83. data/schemas/applicationCertificatePost.json +3 -1
  84. data/schemas/applicationCertificates.json +33 -2
  85. data/schemas/applicationKeys.json +4 -1
  86. data/schemas/applicationPatch.json +28 -0
  87. data/schemas/applicationPost.json +28 -0
  88. data/schemas/applications.json +34 -2
  89. data/schemas/auditLog.json +0 -3
  90. data/schemas/auditLogFilter.json +0 -3
  91. data/schemas/auditLogs.json +4 -4
  92. data/schemas/authedDevice.json +7 -0
  93. data/schemas/dashboard.json +3970 -72
  94. data/schemas/dashboardPatch.json +3969 -72
  95. data/schemas/dashboardPost.json +3969 -72
  96. data/schemas/dashboardSendReport.json +4 -0
  97. data/schemas/dashboardUpdateEvents.json +46 -0
  98. data/schemas/dashboards.json +3974 -73
  99. data/schemas/dataTableRows.json +4 -1
  100. data/schemas/dataTableRowsExport.json +11 -7
  101. data/schemas/dataTables.json +4 -1
  102. data/schemas/deviceRecipes.json +4 -1
  103. data/schemas/devices.json +4 -1
  104. data/schemas/event.json +19 -2
  105. data/schemas/eventPost.json +0 -1
  106. data/schemas/eventTagsSummary.json +28 -0
  107. data/schemas/events.json +841 -3
  108. data/schemas/eventsDeleted.json +9 -0
  109. data/schemas/eventsExport.json +830 -0
  110. data/schemas/experienceDomain.json +6 -2
  111. data/schemas/experienceDomainPatch.json +14 -10
  112. data/schemas/experienceDomainPost.json +8 -4
  113. data/schemas/experienceDomains.json +6 -2
  114. data/schemas/experienceEndpoints.json +4 -1
  115. data/schemas/experienceGroup.json +2 -2
  116. data/schemas/experienceGroupPatch.json +2 -2
  117. data/schemas/experienceGroupPost.json +2 -2
  118. data/schemas/experienceGroups.json +6 -3
  119. data/schemas/experienceSlugPatch.json +2 -2
  120. data/schemas/experienceSlugPost.json +2 -2
  121. data/schemas/experienceUsers.json +4 -1
  122. data/schemas/experienceViews.json +4 -1
  123. data/schemas/files.json +4 -1
  124. data/schemas/flow.json +4 -0
  125. data/schemas/flowPatch.json +6 -2
  126. data/schemas/flowPost.json +4 -0
  127. data/schemas/flowVersion.json +8 -0
  128. data/schemas/flowVersionPost.json +4 -0
  129. data/schemas/flowVersions.json +12 -1
  130. data/schemas/flows.json +8 -1
  131. data/schemas/flowsImportPost.json +10 -2
  132. data/schemas/flowsImportResult.json +12 -0
  133. data/schemas/githubLogin.json +6 -15
  134. data/schemas/integrations.json +4 -1
  135. data/schemas/notebooks.json +4 -1
  136. data/schemas/org.json +2 -4
  137. data/schemas/orgPatch.json +2 -1
  138. data/schemas/orgPost.json +2 -1
  139. data/schemas/orgs.json +6 -5
  140. data/schemas/passwordResetFinish.json +0 -4
  141. data/schemas/passwordResetInput.json +0 -4
  142. data/schemas/resourceTransfer.json +0 -8
  143. data/schemas/userCredentials.json +6 -15
  144. data/schemas/userPost.json +6 -15
  145. data/schemas/webhooks.json +4 -1
  146. data/test/basic_test.rb +15 -0
  147. metadata +8 -23
  148. data/docs/solution.md +0 -133
  149. data/docs/solutionUser.md +0 -139
  150. data/docs/solutionUsers.md +0 -96
  151. data/docs/solutions.md +0 -91
  152. data/lib/losant_rest/solution.rb +0 -174
  153. data/lib/losant_rest/solution_user.rb +0 -180
  154. data/lib/losant_rest/solution_users.rb +0 -138
  155. data/lib/losant_rest/solutions.rb +0 -134
  156. data/schemas/authedSolutionUser.json +0 -18
  157. data/schemas/fileUploadPostResp.json +0 -109
  158. data/schemas/solution.json +0 -76
  159. data/schemas/solutionMe.json +0 -150
  160. data/schemas/solutionPatch.json +0 -48
  161. data/schemas/solutionPost.json +0 -52
  162. data/schemas/solutionUser.json +0 -103
  163. data/schemas/solutionUserCredentials.json +0 -34
  164. data/schemas/solutionUserPatch.json +0 -74
  165. data/schemas/solutionUserPost.json +0 -80
  166. data/schemas/solutionUsers.json +0 -149
  167. data/schemas/solutions.json +0 -118
data/schemas/{dataTableQuery.json → advancedQuery.json} RENAMED
@@ -5,18 +5,18 @@
5
5
  "$and": {
6
6
  "type": "array",
7
7
  "items": {
8
- "$ref": "#/definitions/dataTableQuery"
8
+ "$ref": "#/definitions/advancedQuery"
9
9
  }
10
10
  },
11
11
  "$or": {
12
12
  "type": "array",
13
13
  "items": {
14
- "$ref": "#/definitions/dataTableQuery"
14
+ "$ref": "#/definitions/advancedQuery"
15
15
  }
16
16
  }
17
17
  },
18
18
  "patternProperties": {
19
- "^[0-9a-zA-Z_-]{1,255}$": {
19
+ "^[0-9a-zA-Z_-]{1,255}": {
20
20
  "oneOf": [
21
21
  {
22
22
  "type": [
@@ -89,7 +89,8 @@
89
89
  "type": "string",
90
90
  "minLength": 1
91
91
  }
92
- }
92
+ },
93
+ "additionalProperties": false
93
94
  }
94
95
  ]
95
96
  }
data/schemas/apiTokens.json CHANGED
@@ -111,7 +111,10 @@
111
111
  "type": "string",
112
112
  "enum": [
113
113
  "asc",
114
- "desc"
114
+ "desc",
115
+ "ASC",
116
+ "DESC",
117
+ ""
115
118
  ]
116
119
  },
117
120
  "ownerId": {
data/schemas/application.json CHANGED
@@ -35,7 +35,8 @@
35
35
  "maxLength": 255
36
36
  },
37
37
  "organizationIconColor": {
38
- "type": "string"
38
+ "type": "string",
39
+ "maxLength": 64
39
40
  },
40
41
  "name": {
41
42
  "type": "string",
@@ -224,6 +225,34 @@
224
225
  },
225
226
  "maxItems": 100
226
227
  },
228
+ "includeDevices": {
229
+ "type": "boolean",
230
+ "default": true
231
+ },
232
+ "includeEvents": {
233
+ "type": "boolean",
234
+ "default": false
235
+ },
236
+ "includeDataTables": {
237
+ "type": "boolean",
238
+ "default": false
239
+ },
240
+ "dataTablesMode": {
241
+ "type": "string",
242
+ "enum": [
243
+ "all",
244
+ "whitelist",
245
+ "blacklist"
246
+ ]
247
+ },
248
+ "dataTableIds": {
249
+ "type": "array",
250
+ "items": {
251
+ "type": "string",
252
+ "pattern": "^[A-Fa-f\\d]{24}$"
253
+ },
254
+ "maxItems": 1000
255
+ },
227
256
  "s3": {
228
257
  "type": "object",
229
258
  "properties": {
data/schemas/applicationApiTokenPost.json CHANGED
@@ -75,6 +75,8 @@
75
75
  "webhooks.*",
76
76
  "application.archiveData",
77
77
  "application.backfillArchiveData",
78
+ "application.fullEventsArchive",
79
+ "application.fullDataTablesArchive",
78
80
  "application.debug",
79
81
  "application.delete",
80
82
  "application.get",
@@ -155,10 +157,12 @@
155
157
  "event.delete",
156
158
  "event.get",
157
159
  "event.patch",
160
+ "events.delete",
158
161
  "events.get",
159
162
  "events.mostRecentBySeverity",
160
163
  "events.patch",
161
164
  "events.post",
165
+ "events.export",
162
166
  "experience.delete",
163
167
  "experience.bootstrap",
164
168
  "experienceDomain.delete",
@@ -206,6 +210,7 @@
206
210
  "file.patch",
207
211
  "file.move",
208
212
  "file.delete",
213
+ "file.upload",
209
214
  "files.get",
210
215
  "files.post",
211
216
  "flow.debug",
data/schemas/applicationCertificate.json CHANGED
@@ -61,7 +61,35 @@
61
61
  "maxItems": 100
62
62
  },
63
63
  "certificateInfo": {
64
- "$ref": "#/definitions/certificateInfo"
64
+ "type": "object",
65
+ "properties": {
66
+ "serialNumber": {
67
+ "type": "string",
68
+ "minLength": 1,
69
+ "maxLength": 1024
70
+ },
71
+ "fingerprint": {
72
+ "type": "string",
73
+ "minLength": 1,
74
+ "maxLength": 1024
75
+ },
76
+ "commonName": {
77
+ "type": "string",
78
+ "maxLength": 1024
79
+ },
80
+ "issuerName": {
81
+ "type": "string",
82
+ "maxLength": 1024
83
+ },
84
+ "notValidBefore": {
85
+ "type": "string",
86
+ "format": "date-time"
87
+ },
88
+ "notValidAfter": {
89
+ "type": "string",
90
+ "format": "date-time"
91
+ }
92
+ }
65
93
  }
66
94
  }
67
95
  }
data/schemas/applicationCertificateAuthorities.json CHANGED
@@ -46,12 +46,42 @@
46
46
  "maxLength": 32767
47
47
  },
48
48
  "caBundle": {
49
- "$ref": "#/definitions/common/certificateString"
49
+ "type": "string",
50
+ "maxLength": 32767,
51
+ "minLength": 50
50
52
  },
51
53
  "caInfo": {
52
54
  "type": "array",
53
55
  "items": {
54
- "$ref": "#/definitions/certificateInfo"
56
+ "type": "object",
57
+ "properties": {
58
+ "serialNumber": {
59
+ "type": "string",
60
+ "minLength": 1,
61
+ "maxLength": 1024
62
+ },
63
+ "fingerprint": {
64
+ "type": "string",
65
+ "minLength": 1,
66
+ "maxLength": 1024
67
+ },
68
+ "commonName": {
69
+ "type": "string",
70
+ "maxLength": 1024
71
+ },
72
+ "issuerName": {
73
+ "type": "string",
74
+ "maxLength": 1024
75
+ },
76
+ "notValidBefore": {
77
+ "type": "string",
78
+ "format": "date-time"
79
+ },
80
+ "notValidAfter": {
81
+ "type": "string",
82
+ "format": "date-time"
83
+ }
84
+ }
55
85
  }
56
86
  }
57
87
  }
@@ -82,7 +112,10 @@
82
112
  "type": "string",
83
113
  "enum": [
84
114
  "asc",
85
- "desc"
115
+ "desc",
116
+ "ASC",
117
+ "DESC",
118
+ ""
86
119
  ]
87
120
  },
88
121
  "applicationId": {
data/schemas/applicationCertificateAuthority.json CHANGED
@@ -39,12 +39,42 @@
39
39
  "maxLength": 32767
40
40
  },
41
41
  "caBundle": {
42
- "$ref": "#/definitions/common/certificateString"
42
+ "type": "string",
43
+ "maxLength": 32767,
44
+ "minLength": 50
43
45
  },
44
46
  "caInfo": {
45
47
  "type": "array",
46
48
  "items": {
47
- "$ref": "#/definitions/certificateInfo"
49
+ "type": "object",
50
+ "properties": {
51
+ "serialNumber": {
52
+ "type": "string",
53
+ "minLength": 1,
54
+ "maxLength": 1024
55
+ },
56
+ "fingerprint": {
57
+ "type": "string",
58
+ "minLength": 1,
59
+ "maxLength": 1024
60
+ },
61
+ "commonName": {
62
+ "type": "string",
63
+ "maxLength": 1024
64
+ },
65
+ "issuerName": {
66
+ "type": "string",
67
+ "maxLength": 1024
68
+ },
69
+ "notValidBefore": {
70
+ "type": "string",
71
+ "format": "date-time"
72
+ },
73
+ "notValidAfter": {
74
+ "type": "string",
75
+ "format": "date-time"
76
+ }
77
+ }
48
78
  }
49
79
  }
50
80
  }
data/schemas/applicationCertificateAuthorityPatch.json CHANGED
@@ -19,7 +19,9 @@
19
19
  "maxLength": 32767
20
20
  },
21
21
  "caBundle": {
22
- "$ref": "#/definitions/common/certificateString"
22
+ "type": "string",
23
+ "maxLength": 32767,
24
+ "minLength": 50
23
25
  }
24
26
  },
25
27
  "additionalProperties": false
data/schemas/applicationCertificateAuthorityPost.json CHANGED
@@ -19,7 +19,9 @@
19
19
  "maxLength": 32767
20
20
  },
21
21
  "caBundle": {
22
- "$ref": "#/definitions/common/certificateString"
22
+ "type": "string",
23
+ "maxLength": 32767,
24
+ "minLength": 50
23
25
  }
24
26
  },
25
27
  "required": [
data/schemas/applicationCertificatePatch.json CHANGED
@@ -14,7 +14,9 @@
14
14
  "maxLength": 32767
15
15
  },
16
16
  "certificate": {
17
- "$ref": "#/definitions/common/certificateString"
17
+ "type": "string",
18
+ "maxLength": 32767,
19
+ "minLength": 50
18
20
  }
19
21
  },
20
22
  "additionalProperties": false
data/schemas/applicationCertificatePost.json CHANGED
@@ -41,7 +41,9 @@
41
41
  "maxItems": 100
42
42
  },
43
43
  "certificate": {
44
- "$ref": "#/definitions/common/certificateString"
44
+ "type": "string",
45
+ "maxLength": 32767,
46
+ "minLength": 50
45
47
  }
46
48
  },
47
49
  "required": [
data/schemas/applicationCertificates.json CHANGED
@@ -68,7 +68,35 @@
68
68
  "maxItems": 100
69
69
  },
70
70
  "certificateInfo": {
71
- "$ref": "#/definitions/certificateInfo"
71
+ "type": "object",
72
+ "properties": {
73
+ "serialNumber": {
74
+ "type": "string",
75
+ "minLength": 1,
76
+ "maxLength": 1024
77
+ },
78
+ "fingerprint": {
79
+ "type": "string",
80
+ "minLength": 1,
81
+ "maxLength": 1024
82
+ },
83
+ "commonName": {
84
+ "type": "string",
85
+ "maxLength": 1024
86
+ },
87
+ "issuerName": {
88
+ "type": "string",
89
+ "maxLength": 1024
90
+ },
91
+ "notValidBefore": {
92
+ "type": "string",
93
+ "format": "date-time"
94
+ },
95
+ "notValidAfter": {
96
+ "type": "string",
97
+ "format": "date-time"
98
+ }
99
+ }
72
100
  }
73
101
  }
74
102
  }
@@ -98,7 +126,10 @@
98
126
  "type": "string",
99
127
  "enum": [
100
128
  "asc",
101
- "desc"
129
+ "desc",
130
+ "ASC",
131
+ "DESC",
132
+ ""
102
133
  ]
103
134
  },
104
135
  "applicationId": {
data/schemas/applicationKeys.json CHANGED
@@ -98,7 +98,10 @@
98
98
  "type": "string",
99
99
  "enum": [
100
100
  "asc",
101
- "desc"
101
+ "desc",
102
+ "ASC",
103
+ "DESC",
104
+ ""
102
105
  ]
103
106
  },
104
107
  "applicationId": {
data/schemas/applicationPatch.json CHANGED
@@ -122,6 +122,34 @@
122
122
  },
123
123
  "maxItems": 100
124
124
  },
125
+ "includeDevices": {
126
+ "type": "boolean",
127
+ "default": true
128
+ },
129
+ "includeEvents": {
130
+ "type": "boolean",
131
+ "default": false
132
+ },
133
+ "includeDataTables": {
134
+ "type": "boolean",
135
+ "default": false
136
+ },
137
+ "dataTablesMode": {
138
+ "type": "string",
139
+ "enum": [
140
+ "all",
141
+ "whitelist",
142
+ "blacklist"
143
+ ]
144
+ },
145
+ "dataTableIds": {
146
+ "type": "array",
147
+ "items": {
148
+ "type": "string",
149
+ "pattern": "^[A-Fa-f\\d]{24}$"
150
+ },
151
+ "maxItems": 1000
152
+ },
125
153
  "s3": {
126
154
  "type": "object",
127
155
  "properties": {
data/schemas/applicationPost.json CHANGED
@@ -97,6 +97,34 @@
97
97
  },
98
98
  "maxItems": 100
99
99
  },
100
+ "includeDevices": {
101
+ "type": "boolean",
102
+ "default": true
103
+ },
104
+ "includeEvents": {
105
+ "type": "boolean",
106
+ "default": false
107
+ },
108
+ "includeDataTables": {
109
+ "type": "boolean",
110
+ "default": false
111
+ },
112
+ "dataTablesMode": {
113
+ "type": "string",
114
+ "enum": [
115
+ "all",
116
+ "whitelist",
117
+ "blacklist"
118
+ ]
119
+ },
120
+ "dataTableIds": {
121
+ "type": "array",
122
+ "items": {
123
+ "type": "string",
124
+ "pattern": "^[A-Fa-f\\d]{24}$"
125
+ },
126
+ "maxItems": 1000
127
+ },
100
128
  "s3": {
101
129
  "type": "object",
102
130
  "properties": {
data/schemas/applications.json CHANGED
@@ -42,7 +42,8 @@
42
42
  "maxLength": 255
43
43
  },
44
44
  "organizationIconColor": {
45
- "type": "string"
45
+ "type": "string",
46
+ "maxLength": 64
46
47
  },
47
48
  "name": {
48
49
  "type": "string",
@@ -231,6 +232,34 @@
231
232
  },
232
233
  "maxItems": 100
233
234
  },
235
+ "includeDevices": {
236
+ "type": "boolean",
237
+ "default": true
238
+ },
239
+ "includeEvents": {
240
+ "type": "boolean",
241
+ "default": false
242
+ },
243
+ "includeDataTables": {
244
+ "type": "boolean",
245
+ "default": false
246
+ },
247
+ "dataTablesMode": {
248
+ "type": "string",
249
+ "enum": [
250
+ "all",
251
+ "whitelist",
252
+ "blacklist"
253
+ ]
254
+ },
255
+ "dataTableIds": {
256
+ "type": "array",
257
+ "items": {
258
+ "type": "string",
259
+ "pattern": "^[A-Fa-f\\d]{24}$"
260
+ },
261
+ "maxItems": 1000
262
+ },
234
263
  "s3": {
235
264
  "type": "object",
236
265
  "properties": {
@@ -317,7 +346,10 @@
317
346
  "type": "string",
318
347
  "enum": [
319
348
  "asc",
320
- "desc"
349
+ "desc",
350
+ "ASC",
351
+ "DESC",
352
+ ""
321
353
  ]
322
354
  }
323
355
  }