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/experienceSlugs.json CHANGED
@@ -49,6 +49,25 @@
49
49
  "totalCount": {
50
50
  "type": "integer"
51
51
  },
52
+ "filter": {
53
+ "type": "string"
54
+ },
55
+ "filterField": {
56
+ "type": "string"
57
+ },
58
+ "sortField": {
59
+ "type": "string"
60
+ },
61
+ "sortDirection": {
62
+ "type": "string",
63
+ "enum": [
64
+ "asc",
65
+ "desc",
66
+ "ASC",
67
+ "DESC",
68
+ ""
69
+ ]
70
+ },
52
71
  "applicationId": {
53
72
  "type": "string",
54
73
  "pattern": "^[A-Fa-f\\d]{24}$"
data/schemas/experienceUsers.json CHANGED
@@ -137,8 +137,22 @@
137
137
  "pattern": "^[A-Fa-f\\d]{24}$"
138
138
  },
139
139
  "experienceGroupId": {
140
- "type": "string",
141
- "pattern": "^[A-Fa-f\\d]{24}$"
140
+ "oneOf": [
141
+ {
142
+ "type": "string",
143
+ "pattern": "^[A-Fa-f\\d]{24}$"
144
+ },
145
+ {
146
+ "type": "string",
147
+ "enum": [
148
+ "none",
149
+ "any"
150
+ ]
151
+ }
152
+ ]
153
+ },
154
+ "includeAncestorGroups": {
155
+ "type": "string"
142
156
  }
143
157
  }
144
158
  }
data/schemas/experienceVersions.json CHANGED
@@ -218,6 +218,31 @@
218
218
  "totalCount": {
219
219
  "type": "integer"
220
220
  },
221
+ "perPage": {
222
+ "type": "integer"
223
+ },
224
+ "page": {
225
+ "type": "integer"
226
+ },
227
+ "filter": {
228
+ "type": "string"
229
+ },
230
+ "filterField": {
231
+ "type": "string"
232
+ },
233
+ "sortField": {
234
+ "type": "string"
235
+ },
236
+ "sortDirection": {
237
+ "type": "string",
238
+ "enum": [
239
+ "asc",
240
+ "desc",
241
+ "ASC",
242
+ "DESC",
243
+ ""
244
+ ]
245
+ },
221
246
  "applicationId": {
222
247
  "type": "string",
223
248
  "pattern": "^[A-Fa-f\\d]{24}$"
data/schemas/experienceView.json CHANGED
@@ -46,6 +46,11 @@
46
46
  "apiToken"
47
47
  ]
48
48
  },
49
+ "version": {
50
+ "type": "string",
51
+ "minLength": 1,
52
+ "maxLength": 255
53
+ },
49
54
  "name": {
50
55
  "type": "string",
51
56
  "minLength": 1,
data/schemas/experienceViews.json CHANGED
@@ -53,6 +53,11 @@
53
53
  "apiToken"
54
54
  ]
55
55
  },
56
+ "version": {
57
+ "type": "string",
58
+ "minLength": 1,
59
+ "maxLength": 255
60
+ },
56
61
  "name": {
57
62
  "type": "string",
58
63
  "minLength": 1,
@@ -153,6 +158,11 @@
153
158
  "page",
154
159
  "component"
155
160
  ]
161
+ },
162
+ "version": {
163
+ "type": "string",
164
+ "minLength": 1,
165
+ "maxLength": 255
156
166
  }
157
167
  }
158
168
  }
data/schemas/fileUploadPostResponse.json CHANGED
@@ -1,124 +1,113 @@
1
1
  {
2
2
  "$schema": "http://json-schema.org/draft-07/schema#",
3
- "allOf": [
4
- {
5
- "title": "File Schema",
6
- "description": "Schema for a single public or private file",
3
+ "type": "object",
4
+ "properties": {
5
+ "id": {
6
+ "type": "string",
7
+ "pattern": "^[A-Fa-f\\d]{24}$"
8
+ },
9
+ "applicationId": {
10
+ "type": "string",
11
+ "pattern": "^[A-Fa-f\\d]{24}$"
12
+ },
13
+ "creationDate": {
14
+ "type": "string",
15
+ "format": "date-time"
16
+ },
17
+ "lastUpdated": {
18
+ "type": "string",
19
+ "format": "date-time"
20
+ },
21
+ "authorId": {
22
+ "type": "string",
23
+ "pattern": "^[A-Fa-f\\d]{24}$"
24
+ },
25
+ "authorType": {
26
+ "type": "string",
27
+ "enum": [
28
+ "flow",
29
+ "user",
30
+ "device",
31
+ "apiToken",
32
+ "notebook"
33
+ ]
34
+ },
35
+ "status": {
36
+ "type": "string",
37
+ "enum": [
38
+ "pending",
39
+ "moving",
40
+ "deleting",
41
+ "completed"
42
+ ]
43
+ },
44
+ "name": {
45
+ "type": "string",
46
+ "minLength": 1,
47
+ "maxLength": 1024
48
+ },
49
+ "parentDirectory": {
50
+ "type": "string",
51
+ "maxLength": 1024
52
+ },
53
+ "type": {
54
+ "type": "string",
55
+ "enum": [
56
+ "file",
57
+ "directory"
58
+ ]
59
+ },
60
+ "fileSize": {
61
+ "type": "number"
62
+ },
63
+ "s3etag": {
64
+ "type": "string"
65
+ },
66
+ "contentType": {
67
+ "type": "string",
68
+ "maxLength": 1024
69
+ },
70
+ "fileDimensions": {
7
71
  "type": "object",
8
72
  "properties": {
9
- "id": {
10
- "type": "string",
11
- "pattern": "^[A-Fa-f\\d]{24}$"
12
- },
13
- "applicationId": {
14
- "type": "string",
15
- "pattern": "^[A-Fa-f\\d]{24}$"
16
- },
17
- "creationDate": {
18
- "type": "string",
19
- "format": "date-time"
20
- },
21
- "lastUpdated": {
22
- "type": "string",
23
- "format": "date-time"
24
- },
25
- "authorId": {
26
- "type": "string",
27
- "pattern": "^[A-Fa-f\\d]{24}$"
28
- },
29
- "authorType": {
30
- "type": "string",
31
- "enum": [
32
- "flow",
33
- "user",
34
- "device",
35
- "apiToken",
36
- "notebook"
37
- ]
38
- },
39
- "status": {
40
- "type": "string",
41
- "enum": [
42
- "pending",
43
- "moving",
44
- "deleting",
45
- "completed"
46
- ]
47
- },
48
- "name": {
49
- "type": "string",
50
- "minLength": 1,
51
- "maxLength": 1024
52
- },
53
- "parentDirectory": {
54
- "type": "string",
55
- "maxLength": 1024
56
- },
57
- "type": {
58
- "type": "string",
59
- "enum": [
60
- "file",
61
- "directory"
62
- ]
63
- },
64
- "fileSize": {
73
+ "width": {
65
74
  "type": "number"
66
75
  },
67
- "s3etag": {
68
- "type": "string"
69
- },
70
- "contentType": {
71
- "type": "string",
72
- "maxLength": 1024
73
- },
74
- "fileDimensions": {
75
- "type": "object",
76
- "properties": {
77
- "width": {
78
- "type": "number"
79
- },
80
- "height": {
81
- "type": "number"
82
- }
83
- }
84
- },
85
- "moveIntoId": {
86
- "type": "string",
87
- "pattern": "^[A-Fa-f\\d]{24}$"
88
- },
89
- "url": {
90
- "type": "string"
76
+ "height": {
77
+ "type": "number"
91
78
  }
92
79
  }
93
80
  },
94
- {
81
+ "moveIntoId": {
82
+ "type": "string",
83
+ "pattern": "^[A-Fa-f\\d]{24}$"
84
+ },
85
+ "url": {
86
+ "type": "string"
87
+ },
88
+ "upload": {
95
89
  "type": "object",
96
90
  "properties": {
97
- "upload": {
91
+ "url": {
92
+ "type": "string"
93
+ },
94
+ "fields": {
98
95
  "type": "object",
96
+ "patternProperties": {
97
+ "^.*$": {
98
+ "type": "string"
99
+ }
100
+ },
99
101
  "properties": {
100
- "url": {
102
+ "key": {
101
103
  "type": "string"
102
104
  },
103
- "fields": {
104
- "type": "object",
105
- "patternProperties": {
106
- "^.*$": {
107
- "type": "string"
108
- }
109
- },
110
- "properties": {
111
- "key": {
112
- "type": "string"
113
- },
114
- "bucket": {
115
- "type": "string"
116
- }
117
- }
105
+ "bucket": {
106
+ "type": "string"
118
107
  }
119
108
  }
120
109
  }
121
110
  }
122
111
  }
123
- ]
112
+ }
124
113
  }
data/schemas/files.json CHANGED
@@ -5,7 +5,7 @@
5
5
  "items": {
6
6
  "type": "array",
7
7
  "items": {
8
- "title": "File Schema",
8
+ "title": "File",
9
9
  "description": "Schema for a single public or private file",
10
10
  "type": "object",
11
11
  "properties": {
@@ -126,6 +126,10 @@
126
126
  ""
127
127
  ]
128
128
  },
129
+ "applicationId": {
130
+ "type": "string",
131
+ "pattern": "^[A-Fa-f\\d]{24}$"
132
+ },
129
133
  "parentExists": {
130
134
  "type": "boolean"
131
135
  }