losant_rest 2.1.0 → 2.1.1

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 (191) hide show
  1. checksums.yaml +4 -4
  2. data/docs/_schemas.md +139101 -66992
  3. data/docs/application.md +6 -6
  4. data/docs/applicationCertificates.md +3 -2
  5. data/docs/applicationDashboard.md +1 -1
  6. data/docs/applications.md +1 -1
  7. data/docs/auth.md +1 -1
  8. data/docs/dashboard.md +1 -1
  9. data/docs/dashboards.md +1 -0
  10. data/docs/dataTableRow.md +1 -1
  11. data/docs/dataTableRows.md +3 -3
  12. data/docs/device.md +1 -1
  13. data/docs/edgeDeployments.md +3 -3
  14. data/docs/embeddedDeployments.md +3 -3
  15. data/docs/experience.md +1 -1
  16. data/docs/file.md +4 -4
  17. data/docs/files.md +1 -1
  18. data/docs/flowVersions.md +1 -1
  19. data/docs/instanceApiTokens.md +1 -1
  20. data/docs/instanceMember.md +1 -1
  21. data/docs/instanceOrg.md +1 -1
  22. data/docs/instanceOrgInvite.md +2 -2
  23. data/docs/instanceOrgInvites.md +1 -1
  24. data/docs/instanceOrgMembers.md +2 -1
  25. data/docs/instanceOrgs.md +1 -1
  26. data/docs/me.md +1 -1
  27. data/docs/notebook.md +1 -1
  28. data/docs/org.md +1 -1
  29. data/docs/privateFile.md +4 -4
  30. data/docs/privateFiles.md +1 -1
  31. data/docs/resourceJob.md +2 -2
  32. data/docs/userApiTokens.md +2 -2
  33. data/lib/platform_rest/application.rb +1 -1
  34. data/lib/platform_rest/application_certificates.rb +5 -2
  35. data/lib/platform_rest/application_dashboard.rb +1 -1
  36. data/lib/platform_rest/client.rb +2 -2
  37. data/lib/platform_rest/dashboard.rb +1 -1
  38. data/lib/platform_rest/dashboards.rb +1 -0
  39. data/lib/platform_rest/data_table_row.rb +1 -1
  40. data/lib/platform_rest/data_table_rows.rb +3 -3
  41. data/lib/platform_rest/device.rb +1 -1
  42. data/lib/platform_rest/edge_deployments.rb +3 -3
  43. data/lib/platform_rest/embedded_deployments.rb +3 -3
  44. data/lib/platform_rest/experience.rb +1 -1
  45. data/lib/platform_rest/file.rb +2 -2
  46. data/lib/platform_rest/instance_api_tokens.rb +1 -1
  47. data/lib/platform_rest/instance_member.rb +1 -1
  48. data/lib/platform_rest/instance_org.rb +1 -1
  49. data/lib/platform_rest/instance_org_invite.rb +2 -2
  50. data/lib/platform_rest/instance_org_invites.rb +2 -2
  51. data/lib/platform_rest/instance_org_members.rb +2 -1
  52. data/lib/platform_rest/instance_orgs.rb +1 -1
  53. data/lib/platform_rest/me.rb +1 -1
  54. data/lib/platform_rest/notebook.rb +1 -1
  55. data/lib/platform_rest/org.rb +1 -1
  56. data/lib/platform_rest/private_file.rb +2 -2
  57. data/lib/platform_rest/resource_job.rb +2 -2
  58. data/lib/platform_rest/user_api_tokens.rb +2 -2
  59. data/lib/platform_rest/version.rb +1 -1
  60. data/schemas/advancedApplicationCertQuery.json +1885 -0
  61. data/schemas/advancedApplicationKeyQuery.json +763 -763
  62. data/schemas/apiToken.json +10 -1
  63. data/schemas/apiTokens.json +20 -2
  64. data/schemas/application.json +15 -2
  65. data/schemas/applicationCertificate.json +90 -58
  66. data/schemas/applicationCertificateAuthorities.json +24 -0
  67. data/schemas/applicationCertificateAuthority.json +24 -0
  68. data/schemas/applicationCertificatePatch.json +32 -4
  69. data/schemas/applicationCertificatePost.json +28 -30
  70. data/schemas/applicationCertificates.json +90 -58
  71. data/schemas/applicationCreationByTemplateResult.json +15 -2
  72. data/schemas/applicationDashboardPost.json +179 -128
  73. data/schemas/applicationImportExecutions.json +3 -5
  74. data/schemas/applicationImportResult.json +674 -0
  75. data/schemas/applicationJobLog.json +129 -123
  76. data/schemas/applicationJobLogs.json +129 -123
  77. data/schemas/applicationKey.json +41 -41
  78. data/schemas/applicationKeyPatch.json +4 -4
  79. data/schemas/applicationKeyPost.json +36 -29
  80. data/schemas/applicationKeys.json +41 -41
  81. data/schemas/applicationSearchResult.json +10 -10
  82. data/schemas/applicationTemplates.json +9 -2
  83. data/schemas/applications.json +15 -2
  84. data/schemas/auditLog.json +2 -6
  85. data/schemas/auditLogs.json +2 -6
  86. data/schemas/authedDevice.json +3 -0
  87. data/schemas/credential.json +7 -0
  88. data/schemas/credentialLinkedResources.json +19724 -344
  89. data/schemas/credentialPatch.json +3 -0
  90. data/schemas/credentialPost.json +3 -0
  91. data/schemas/credentials.json +7 -0
  92. data/schemas/dashboard.json +199 -128
  93. data/schemas/dashboardBlockSuggestCodePost.json +19 -0
  94. data/schemas/dashboardPatch.json +179 -128
  95. data/schemas/dashboardPost.json +179 -128
  96. data/schemas/dashboardUpdateEventsResult.json +266 -0
  97. data/schemas/dashboards.json +199 -128
  98. data/schemas/dataTable.json +11 -0
  99. data/schemas/dataTableRowPatch.json +16 -0
  100. data/schemas/dataTableRowPost.json +39 -0
  101. data/schemas/dataTableRowPostResult.json +54 -0
  102. data/schemas/dataTables.json +11 -0
  103. data/schemas/device.json +259 -107
  104. data/schemas/deviceConnectionStatus.json +4 -0
  105. data/schemas/deviceLog.json +3 -0
  106. data/schemas/deviceRecipe.json +259 -108
  107. data/schemas/deviceRecipes.json +259 -108
  108. data/schemas/devices.json +287 -116
  109. data/schemas/edgeDeploymentRelease.json +4252 -39
  110. data/schemas/edgeDeployments.json +28 -0
  111. data/schemas/embeddedDeploymentRelease.json +2073 -0
  112. data/schemas/embeddedDeployments.json +25 -0
  113. data/schemas/error.json +14 -0
  114. data/schemas/event.json +4 -1
  115. data/schemas/eventPlusNewCount.json +4 -1
  116. data/schemas/events.json +4 -1
  117. data/schemas/experienceDomains.json +19 -0
  118. data/schemas/experienceEndpoint.json +19 -0
  119. data/schemas/experienceEndpoints.json +24 -0
  120. data/schemas/experienceLinkedResources.json +19728 -313
  121. data/schemas/experienceSlugs.json +19 -0
  122. data/schemas/experienceUsers.json +16 -2
  123. data/schemas/experienceVersions.json +25 -0
  124. data/schemas/experienceView.json +5 -0
  125. data/schemas/experienceViews.json +10 -0
  126. data/schemas/fileUploadPostResponse.json +92 -103
  127. data/schemas/files.json +5 -1
  128. data/schemas/flow.json +211 -46
  129. data/schemas/flowPatch.json +199 -46
  130. data/schemas/flowPost.json +199 -46
  131. data/schemas/flowStorageMetadata.json +2 -2
  132. data/schemas/flowVersion.json +450 -101
  133. data/schemas/flowVersionPost.json +199 -46
  134. data/schemas/flowVersions.json +9903 -113
  135. data/schemas/flows.json +9637 -46
  136. data/schemas/flowsImportPost.json +398 -92
  137. data/schemas/flowsImportResult.json +661 -147
  138. data/schemas/historicalSummaries.json +3 -2
  139. data/schemas/historicalSummary.json +3 -2
  140. data/schemas/instanceAuditLog.json +2 -6
  141. data/schemas/instanceAuditLogs.json +90 -1
  142. data/schemas/instanceCustomNode.json +41 -2
  143. data/schemas/instanceCustomNodePatch.json +59 -6
  144. data/schemas/instanceCustomNodePost.json +59 -6
  145. data/schemas/instanceCustomNodes.json +41 -2
  146. data/schemas/instanceOrg.json +4 -1
  147. data/schemas/instanceOrgInvite.json +102 -0
  148. data/schemas/instanceOrgInviteSent.json +12 -0
  149. data/schemas/instanceOrgInvites.json +145 -0
  150. data/schemas/instanceOrgMember.json +52 -0
  151. data/schemas/instanceOrgMembers.json +105 -1
  152. data/schemas/instanceOrgPost.json +1 -1
  153. data/schemas/instanceOrgs.json +5 -2
  154. data/schemas/instanceSandbox.json +5 -1
  155. data/schemas/instanceSandboxes.json +9 -1
  156. data/schemas/integration.json +38 -39
  157. data/schemas/integrationPatch.json +8 -8
  158. data/schemas/integrationPost.json +8 -8
  159. data/schemas/integrations.json +38 -39
  160. data/schemas/jobEnqueuedResult.json +1 -1
  161. data/schemas/me.json +685 -88
  162. data/schemas/notebook.json +33 -21
  163. data/schemas/notebookExecutionLogs.json +20 -0
  164. data/schemas/notebookMinuteCounts.json +1 -1
  165. data/schemas/notebookPatch.json +29 -21
  166. data/schemas/notebookPost.json +29 -21
  167. data/schemas/notebooks.json +33 -21
  168. data/schemas/notificationRule.json +4 -0
  169. data/schemas/notificationRules.json +8 -0
  170. data/schemas/org.json +14 -1
  171. data/schemas/orgInvites.json +77 -82
  172. data/schemas/orgInvitesUser.json +44 -47
  173. data/schemas/orgs.json +14 -1
  174. data/schemas/paletteResponse.json +372 -364
  175. data/schemas/periodSummaries.json +1 -1
  176. data/schemas/recentItemList.json +226 -27
  177. data/schemas/resourceJob.json +33 -9
  178. data/schemas/resourceJobExecutionLogs.json +34 -20
  179. data/schemas/resourceJobExecutionOptions.json +1 -1
  180. data/schemas/resourceJobPatch.json +9 -9
  181. data/schemas/resourceJobPost.json +9 -9
  182. data/schemas/resourceJobs.json +33 -9
  183. data/schemas/tagValuesResponse.json +1 -2
  184. data/schemas/templateKeywords.json +1 -0
  185. data/schemas/timeSeriesData.json +36 -4
  186. data/schemas/userOauthToken.json +4 -1
  187. data/schemas/userOauthTokenPost.json +1 -1
  188. data/schemas/userOauthTokens.json +4 -1
  189. data/schemas/validateContextError.json +71 -24
  190. data/schemas/validateContextSuccess.json +71 -24
  191. metadata +10 -1
data/schemas/dashboardUpdateEventsResult.json ADDED
@@ -0,0 +1,266 @@
1
+ {
2
+ "$schema": "http://json-schema.org/draft-07/schema#",
3
+ "oneOf": [
4
+ {
5
+ "title": "Event",
6
+ "description": "Schema for a single Event",
7
+ "type": "object",
8
+ "properties": {
9
+ "id": {
10
+ "type": "string",
11
+ "pattern": "^[A-Fa-f\\d]{24}$"
12
+ },
13
+ "eventId": {
14
+ "type": "string",
15
+ "pattern": "^[A-Fa-f\\d]{24}$"
16
+ },
17
+ "applicationId": {
18
+ "type": "string",
19
+ "pattern": "^[A-Fa-f\\d]{24}$"
20
+ },
21
+ "creationDate": {
22
+ "type": "string",
23
+ "format": "date-time"
24
+ },
25
+ "lastUpdated": {
26
+ "type": "string",
27
+ "format": "date-time"
28
+ },
29
+ "sourceType": {
30
+ "type": "string",
31
+ "enum": [
32
+ "flow",
33
+ "user",
34
+ "device",
35
+ "apiToken",
36
+ "experienceUser",
37
+ "public"
38
+ ]
39
+ },
40
+ "sourceId": {
41
+ "type": "string",
42
+ "pattern": "^[A-Fa-f\\d]{24}$"
43
+ },
44
+ "sourceName": {
45
+ "type": "string",
46
+ "minLength": 1,
47
+ "maxLength": 255
48
+ },
49
+ "level": {
50
+ "type": "string",
51
+ "enum": [
52
+ "info",
53
+ "warning",
54
+ "error",
55
+ "critical"
56
+ ]
57
+ },
58
+ "state": {
59
+ "type": "string",
60
+ "enum": [
61
+ "new",
62
+ "acknowledged",
63
+ "resolved"
64
+ ]
65
+ },
66
+ "subject": {
67
+ "type": "string",
68
+ "minLength": 1,
69
+ "maxLength": 255
70
+ },
71
+ "message": {
72
+ "type": "string",
73
+ "maxLength": 32767
74
+ },
75
+ "data": {},
76
+ "deviceId": {
77
+ "type": "string",
78
+ "pattern": "^[A-Fa-f\\d]{24}$"
79
+ },
80
+ "deviceName": {
81
+ "type": "string",
82
+ "minLength": 1,
83
+ "maxLength": 255
84
+ },
85
+ "disableTagChangeTracking": {
86
+ "type": "boolean"
87
+ },
88
+ "eventTags": {
89
+ "type": "object",
90
+ "patternProperties": {
91
+ "^[0-9a-zA-Z_-]{1,255}$": {
92
+ "type": "string",
93
+ "minLength": 1,
94
+ "maxLength": 255
95
+ }
96
+ },
97
+ "additionalProperties": false
98
+ },
99
+ "updates": {
100
+ "maxItems": 100,
101
+ "type": "array",
102
+ "items": {
103
+ "type": "object",
104
+ "properties": {
105
+ "sourceType": {
106
+ "type": "string",
107
+ "enum": [
108
+ "flow",
109
+ "user",
110
+ "device",
111
+ "apiToken",
112
+ "experienceUser",
113
+ "public"
114
+ ]
115
+ },
116
+ "sourceId": {
117
+ "type": "string",
118
+ "pattern": "^[A-Fa-f\\d]{24}$"
119
+ },
120
+ "sourceName": {
121
+ "type": "string",
122
+ "minLength": 1,
123
+ "maxLength": 255
124
+ },
125
+ "creationDate": {
126
+ "type": "string",
127
+ "format": "date-time"
128
+ },
129
+ "comment": {
130
+ "type": "string",
131
+ "maxLength": 32767
132
+ },
133
+ "data": {},
134
+ "state": {
135
+ "type": "string",
136
+ "enum": [
137
+ "new",
138
+ "acknowledged",
139
+ "resolved"
140
+ ]
141
+ },
142
+ "stateChange": {
143
+ "type": "object",
144
+ "properties": {
145
+ "old": {
146
+ "type": "string",
147
+ "enum": [
148
+ "new",
149
+ "acknowledged",
150
+ "resolved"
151
+ ]
152
+ },
153
+ "new": {
154
+ "type": "string",
155
+ "enum": [
156
+ "new",
157
+ "acknowledged",
158
+ "resolved"
159
+ ]
160
+ }
161
+ }
162
+ },
163
+ "levelChange": {
164
+ "type": "object",
165
+ "properties": {
166
+ "old": {
167
+ "type": "string",
168
+ "enum": [
169
+ "info",
170
+ "warning",
171
+ "error",
172
+ "critical"
173
+ ]
174
+ },
175
+ "new": {
176
+ "type": "string",
177
+ "enum": [
178
+ "info",
179
+ "warning",
180
+ "error",
181
+ "critical"
182
+ ]
183
+ }
184
+ }
185
+ },
186
+ "subjectChange": {
187
+ "type": "object",
188
+ "properties": {
189
+ "old": {
190
+ "type": "string",
191
+ "minLength": 1,
192
+ "maxLength": 255
193
+ },
194
+ "new": {
195
+ "type": "string",
196
+ "minLength": 1,
197
+ "maxLength": 255
198
+ }
199
+ }
200
+ },
201
+ "deviceIdChange": {
202
+ "type": "object",
203
+ "properties": {
204
+ "old": {
205
+ "type": "string",
206
+ "pattern": "^[A-Fa-f\\d]{24}$"
207
+ },
208
+ "oldDeviceName": {
209
+ "type": "string",
210
+ "minLength": 1,
211
+ "maxLength": 255
212
+ },
213
+ "new": {
214
+ "type": "string",
215
+ "pattern": "^[A-Fa-f\\d]{24}$"
216
+ },
217
+ "newDeviceName": {
218
+ "type": "string",
219
+ "minLength": 1,
220
+ "maxLength": 255
221
+ }
222
+ }
223
+ },
224
+ "tagsChange": {
225
+ "type": "object",
226
+ "patternProperties": {
227
+ "^[0-9a-zA-Z_-]{1,255}$": {
228
+ "type": "object",
229
+ "properties": {
230
+ "old": {
231
+ "type": "string",
232
+ "minLength": 1,
233
+ "maxLength": 255
234
+ },
235
+ "new": {
236
+ "type": "string",
237
+ "minLength": 1,
238
+ "maxLength": 255
239
+ }
240
+ }
241
+ }
242
+ }
243
+ }
244
+ }
245
+ }
246
+ }
247
+ },
248
+ "required": [
249
+ "id"
250
+ ]
251
+ },
252
+ {
253
+ "title": "Success",
254
+ "description": "Schema for reporting a successful operation",
255
+ "type": "object",
256
+ "properties": {
257
+ "success": {
258
+ "type": "boolean",
259
+ "enum": [
260
+ true
261
+ ]
262
+ }
263
+ }
264
+ }
265
+ ]
266
+ }