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/applicationKeyPost.json CHANGED
@@ -2,42 +2,22 @@
2
2
  "$schema": "http://json-schema.org/draft-07/schema#",
3
3
  "type": "object",
4
4
  "properties": {
5
- "deviceIds": {
6
- "type": "array",
7
- "items": {
8
- "type": "string",
9
- "pattern": "^[A-Fa-f\\d]{24}$"
10
- },
11
- "maxItems": 1000
5
+ "status": {
6
+ "type": "string",
7
+ "enum": [
8
+ "active",
9
+ "inactive"
10
+ ]
12
11
  },
13
- "deviceTags": {
14
- "type": "array",
15
- "items": {
16
- "type": "object",
17
- "properties": {
18
- "key": {
19
- "type": "string",
20
- "pattern": "^[0-9a-zA-Z_-]{1,255}$"
21
- },
22
- "value": {
23
- "type": "string",
24
- "minLength": 1,
25
- "maxLength": 255
26
- }
27
- },
28
- "additionalProperties": false
29
- },
30
- "maxItems": 100
12
+ "description": {
13
+ "type": "string",
14
+ "maxLength": 32767
31
15
  },
32
16
  "name": {
33
17
  "type": "string",
34
18
  "minLength": 1,
35
19
  "maxLength": 255
36
20
  },
37
- "description": {
38
- "type": "string",
39
- "maxLength": 32767
40
- },
41
21
  "filterType": {
42
22
  "oneOf": [
43
23
  {
@@ -87,6 +67,33 @@
87
67
  "type": "string",
88
68
  "maxLength": 48
89
69
  }
70
+ },
71
+ "deviceIds": {
72
+ "type": "array",
73
+ "items": {
74
+ "type": "string",
75
+ "pattern": "^[A-Fa-f\\d]{24}$"
76
+ },
77
+ "maxItems": 1000
78
+ },
79
+ "deviceTags": {
80
+ "type": "array",
81
+ "items": {
82
+ "type": "object",
83
+ "properties": {
84
+ "key": {
85
+ "type": "string",
86
+ "pattern": "^[0-9a-zA-Z_-]{1,255}$"
87
+ },
88
+ "value": {
89
+ "type": "string",
90
+ "minLength": 1,
91
+ "maxLength": 255
92
+ }
93
+ },
94
+ "additionalProperties": false
95
+ },
96
+ "maxItems": 100
90
97
  }
91
98
  },
92
99
  "additionalProperties": false
data/schemas/applicationKeys.json CHANGED
@@ -13,10 +13,6 @@
13
13
  "type": "string",
14
14
  "pattern": "^[A-Fa-f\\d]{24}$"
15
15
  },
16
- "applicationKeyId": {
17
- "type": "string",
18
- "pattern": "^[A-Fa-f\\d]{24}$"
19
- },
20
16
  "applicationId": {
21
17
  "type": "string",
22
18
  "pattern": "^[A-Fa-f\\d]{24}$"
@@ -25,6 +21,10 @@
25
21
  "type": "string",
26
22
  "format": "date-time"
27
23
  },
24
+ "lastUpdated": {
25
+ "type": "string",
26
+ "format": "date-time"
27
+ },
28
28
  "createdById": {
29
29
  "type": "string",
30
30
  "pattern": "^[A-Fa-f\\d]{24}$"
@@ -37,10 +37,6 @@
37
37
  "apiToken"
38
38
  ]
39
39
  },
40
- "lastUpdated": {
41
- "type": "string",
42
- "format": "date-time"
43
- },
44
40
  "lastUpdatedById": {
45
41
  "type": "string",
46
42
  "pattern": "^[A-Fa-f\\d]{24}$"
@@ -53,9 +49,6 @@
53
49
  "apiToken"
54
50
  ]
55
51
  },
56
- "key": {
57
- "type": "string"
58
- },
59
52
  "status": {
60
53
  "type": "string",
61
54
  "enum": [
@@ -63,42 +56,15 @@
63
56
  "inactive"
64
57
  ]
65
58
  },
66
- "deviceIds": {
67
- "type": "array",
68
- "items": {
69
- "type": "string",
70
- "pattern": "^[A-Fa-f\\d]{24}$"
71
- },
72
- "maxItems": 1000
73
- },
74
- "deviceTags": {
75
- "type": "array",
76
- "items": {
77
- "type": "object",
78
- "properties": {
79
- "key": {
80
- "type": "string",
81
- "pattern": "^[0-9a-zA-Z_-]{1,255}$"
82
- },
83
- "value": {
84
- "type": "string",
85
- "minLength": 1,
86
- "maxLength": 255
87
- }
88
- },
89
- "additionalProperties": false
90
- },
91
- "maxItems": 100
59
+ "description": {
60
+ "type": "string",
61
+ "maxLength": 32767
92
62
  },
93
63
  "name": {
94
64
  "type": "string",
95
65
  "minLength": 1,
96
66
  "maxLength": 255
97
67
  },
98
- "description": {
99
- "type": "string",
100
- "maxLength": 32767
101
- },
102
68
  "filterType": {
103
69
  "oneOf": [
104
70
  {
@@ -148,6 +114,40 @@
148
114
  "type": "string",
149
115
  "maxLength": 48
150
116
  }
117
+ },
118
+ "applicationKeyId": {
119
+ "type": "string",
120
+ "pattern": "^[A-Fa-f\\d]{24}$"
121
+ },
122
+ "key": {
123
+ "type": "string"
124
+ },
125
+ "deviceIds": {
126
+ "type": "array",
127
+ "items": {
128
+ "type": "string",
129
+ "pattern": "^[A-Fa-f\\d]{24}$"
130
+ },
131
+ "maxItems": 1000
132
+ },
133
+ "deviceTags": {
134
+ "type": "array",
135
+ "items": {
136
+ "type": "object",
137
+ "properties": {
138
+ "key": {
139
+ "type": "string",
140
+ "pattern": "^[0-9a-zA-Z_-]{1,255}$"
141
+ },
142
+ "value": {
143
+ "type": "string",
144
+ "minLength": 1,
145
+ "maxLength": 255
146
+ }
147
+ },
148
+ "additionalProperties": false
149
+ },
150
+ "maxItems": 100
151
151
  }
152
152
  }
153
153
  }
data/schemas/applicationSearchResult.json CHANGED
@@ -37,6 +37,16 @@
37
37
  ]
38
38
  },
39
39
  "flowClass": {
40
+ "type": "string",
41
+ "enum": [
42
+ "cloud",
43
+ "edge",
44
+ "embedded",
45
+ "experience",
46
+ "customNode"
47
+ ]
48
+ },
49
+ "deviceClass": {
40
50
  "type": "string",
41
51
  "enum": [
42
52
  "standalone",
@@ -48,16 +58,6 @@
48
58
  "embedded"
49
59
  ]
50
60
  },
51
- "deviceClass": {
52
- "type": "string",
53
- "enum": [
54
- "cloud",
55
- "edge",
56
- "embedded",
57
- "experience",
58
- "customNode"
59
- ]
60
- },
61
61
  "_type": {
62
62
  "type": "string",
63
63
  "enum": [
data/schemas/applicationTemplates.json CHANGED
@@ -154,8 +154,15 @@
154
154
  "type": "string"
155
155
  },
156
156
  "categoryId": {
157
- "type": "string",
158
- "pattern": "^[A-Fa-f\\d]{24}$"
157
+ "oneOf": [
158
+ {
159
+ "type": "string",
160
+ "pattern": "^[A-Fa-f\\d]{24}$"
161
+ },
162
+ {
163
+ "type": "null"
164
+ }
165
+ ]
159
166
  },
160
167
  "keywords": {
161
168
  "type": "array",
data/schemas/applications.json CHANGED
@@ -53,6 +53,15 @@
53
53
  "type": "string",
54
54
  "maxLength": 64
55
55
  },
56
+ "_currentRole": {
57
+ "type": "string",
58
+ "enum": [
59
+ "admin",
60
+ "edit",
61
+ "collaborate",
62
+ "view"
63
+ ]
64
+ },
56
65
  "name": {
57
66
  "type": "string",
58
67
  "minLength": 1,
@@ -363,7 +372,7 @@
363
372
  "type": "integer"
364
373
  },
365
374
  "minutesThisPeriod": {
366
- "type": "integer"
375
+ "type": "number"
367
376
  },
368
377
  "runsThisPeriod": {
369
378
  "type": "integer"
@@ -614,7 +623,11 @@
614
623
  },
615
624
  "additionalProperties": false
616
625
  }
617
- }
626
+ },
627
+ "required": [
628
+ "id",
629
+ "name"
630
+ ]
618
631
  }
619
632
  },
620
633
  "count": {
data/schemas/auditLog.json CHANGED
@@ -100,15 +100,11 @@
100
100
  "requestQueryParams": {
101
101
  "type": "object"
102
102
  },
103
- "requestBody": {
104
- "type": "object"
105
- },
103
+ "requestBody": {},
106
104
  "requestPathParams": {
107
105
  "type": "object"
108
106
  },
109
- "responseBody": {
110
- "type": "object"
111
- },
107
+ "responseBody": {},
112
108
  "responseStatus": {
113
109
  "type": "integer",
114
110
  "minimum": 100,
data/schemas/auditLogs.json CHANGED
@@ -107,15 +107,11 @@
107
107
  "requestQueryParams": {
108
108
  "type": "object"
109
109
  },
110
- "requestBody": {
111
- "type": "object"
112
- },
110
+ "requestBody": {},
113
111
  "requestPathParams": {
114
112
  "type": "object"
115
113
  },
116
- "responseBody": {
117
- "type": "object"
118
- },
114
+ "responseBody": {},
119
115
  "responseStatus": {
120
116
  "type": "integer",
121
117
  "minimum": 100,
data/schemas/authedDevice.json CHANGED
@@ -22,6 +22,9 @@
22
22
  "embedded"
23
23
  ]
24
24
  },
25
+ "restricted": {
26
+ "type": "boolean"
27
+ },
25
28
  "token": {
26
29
  "type": "string",
27
30
  "minLength": 1
data/schemas/credential.json CHANGED
@@ -6,6 +6,10 @@
6
6
  "type": "string",
7
7
  "pattern": "^[A-Fa-f\\d]{24}$"
8
8
  },
9
+ "credentialId": {
10
+ "type": "string",
11
+ "pattern": "^[A-Fa-f\\d]{24}$"
12
+ },
9
13
  "applicationId": {
10
14
  "type": "string",
11
15
  "pattern": "^[A-Fa-f\\d]{24}$"
@@ -385,6 +389,9 @@
385
389
  "format": "date-time"
386
390
  }
387
391
  }
392
+ },
393
+ "storeAsCertAuthority": {
394
+ "type": "boolean"
388
395
  }
389
396
  },
390
397
  "additionalProperties": false