losant_rest 1.14.1 → 1.15.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (77) hide show
  1. checksums.yaml +4 -4
  2. data/docs/_schemas.md +4268 -1402
  3. data/docs/embeddedDeployment.md +49 -0
  4. data/docs/embeddedDeployments.md +215 -0
  5. data/docs/flow.md +2 -2
  6. data/docs/flows.md +2 -2
  7. data/lib/losant_rest/client.rb +10 -2
  8. data/lib/losant_rest/embedded_deployment.rb +81 -0
  9. data/lib/losant_rest/embedded_deployments.rb +280 -0
  10. data/lib/losant_rest/flow.rb +2 -2
  11. data/lib/losant_rest/flows.rb +2 -2
  12. data/lib/losant_rest/version.rb +1 -1
  13. data/lib/losant_rest.rb +2 -0
  14. data/schemas/apiTokenPost.json +8 -0
  15. data/schemas/application.json +32 -32
  16. data/schemas/applicationCreationByTemplateResult.json +32 -32
  17. data/schemas/applicationDashboardPost.json +8 -5
  18. data/schemas/applicationPatch.json +13 -13
  19. data/schemas/applicationPost.json +13 -13
  20. data/schemas/applicationTemplate.json +16 -16
  21. data/schemas/applicationTemplates.json +16 -16
  22. data/schemas/applications.json +32 -32
  23. data/schemas/authedDevice.json +2 -1
  24. data/schemas/dashboard.json +8 -5
  25. data/schemas/dashboardPatch.json +8 -5
  26. data/schemas/dashboardPost.json +8 -5
  27. data/schemas/dashboardSendReport.json +6 -6
  28. data/schemas/dashboards.json +8 -5
  29. data/schemas/device.json +2 -1
  30. data/schemas/deviceClassFilter.json +4 -2
  31. data/schemas/devicePatch.json +2 -1
  32. data/schemas/devicePost.json +2 -1
  33. data/schemas/deviceRecipe.json +2 -1
  34. data/schemas/deviceRecipePatch.json +2 -1
  35. data/schemas/deviceRecipePost.json +2 -1
  36. data/schemas/deviceRecipes.json +2 -1
  37. data/schemas/devices.json +4 -2
  38. data/schemas/devicesPatch.json +4 -2
  39. data/schemas/edgeDeployment.json +4 -0
  40. data/schemas/edgeDeployments.json +4 -0
  41. data/schemas/embeddedDeployment.json +179 -0
  42. data/schemas/embeddedDeploymentExport.json +44 -0
  43. data/schemas/embeddedDeploymentRelease.json +58 -0
  44. data/schemas/embeddedDeploymentRemove.json +25 -0
  45. data/schemas/embeddedDeploymentReplace.json +29 -0
  46. data/schemas/embeddedDeployments.json +212 -0
  47. data/schemas/experienceEndpoint.json +6 -8
  48. data/schemas/experienceEndpointPatch.json +6 -8
  49. data/schemas/experienceEndpointPost.json +6 -8
  50. data/schemas/experienceEndpoints.json +6 -8
  51. data/schemas/experienceLinkedResources.json +387 -57
  52. data/schemas/flow.json +127 -16
  53. data/schemas/flowPatch.json +126 -16
  54. data/schemas/flowPost.json +127 -16
  55. data/schemas/flowVersion.json +253 -33
  56. data/schemas/flowVersionPost.json +126 -16
  57. data/schemas/flowVersions.json +253 -33
  58. data/schemas/flows.json +128 -16
  59. data/schemas/flowsImportPost.json +253 -32
  60. data/schemas/flowsImportResult.json +380 -49
  61. data/schemas/githubLogin.json +8 -0
  62. data/schemas/historicalSummary.json +87 -74
  63. data/schemas/instance.json +92 -79
  64. data/schemas/instanceMember.json +6 -0
  65. data/schemas/instanceMembers.json +6 -0
  66. data/schemas/instanceOrg.json +87 -74
  67. data/schemas/instanceOrgMember.json +6 -0
  68. data/schemas/instanceOrgPatch.json +64 -26
  69. data/schemas/instanceOrgPost.json +65 -27
  70. data/schemas/instanceOrgs.json +87 -74
  71. data/schemas/instancePatch.json +2 -2
  72. data/schemas/me.json +104 -91
  73. data/schemas/org.json +115 -96
  74. data/schemas/orgs.json +115 -96
  75. data/schemas/userCredentials.json +8 -0
  76. data/schemas/userPost.json +8 -0
  77. metadata +16 -6
data/schemas/dashboards.json CHANGED
@@ -83,7 +83,7 @@
83
83
  },
84
84
  "reportConfigs": {
85
85
  "type": "array",
86
- "max": 10,
86
+ "maxItems": 10,
87
87
  "items": {
88
88
  "type": "object",
89
89
  "properties": {
@@ -97,8 +97,8 @@
97
97
  },
98
98
  "toEmail": {
99
99
  "type": "array",
100
- "min": 1,
101
- "max": 10,
100
+ "minItems": 1,
101
+ "maxItems": 10,
102
102
  "items": {
103
103
  "type": "string",
104
104
  "format": "email",
@@ -3164,8 +3164,8 @@
3164
3164
  },
3165
3165
  "length": {
3166
3166
  "type": "integer",
3167
- "min": 1,
3168
- "max": 10
3167
+ "minimum": 1,
3168
+ "maximum": 10
3169
3169
  },
3170
3170
  "orientation": {
3171
3171
  "type": "string",
@@ -5380,6 +5380,9 @@
5380
5380
  "includeEdge": {
5381
5381
  "type": "boolean"
5382
5382
  },
5383
+ "includeEmbedded": {
5384
+ "type": "boolean"
5385
+ },
5383
5386
  "includeExperience": {
5384
5387
  "type": "boolean"
5385
5388
  },
data/schemas/device.json CHANGED
@@ -191,7 +191,8 @@
191
191
  "peripheral",
192
192
  "floating",
193
193
  "edgeCompute",
194
- "system"
194
+ "system",
195
+ "embedded"
195
196
  ]
196
197
  },
197
198
  "gatewayId": {
data/schemas/deviceClassFilter.json CHANGED
@@ -9,7 +9,8 @@
9
9
  "peripheral",
10
10
  "floating",
11
11
  "edgeCompute",
12
- "system"
12
+ "system",
13
+ "embedded"
13
14
  ]
14
15
  },
15
16
  {
@@ -22,7 +23,8 @@
22
23
  "peripheral",
23
24
  "floating",
24
25
  "edgeCompute",
25
- "system"
26
+ "system",
27
+ "embedded"
26
28
  ]
27
29
  }
28
30
  }
data/schemas/devicePatch.json CHANGED
@@ -171,7 +171,8 @@
171
171
  "peripheral",
172
172
  "floating",
173
173
  "edgeCompute",
174
- "system"
174
+ "system",
175
+ "embedded"
175
176
  ]
176
177
  },
177
178
  "gatewayId": {
data/schemas/devicePost.json CHANGED
@@ -171,7 +171,8 @@
171
171
  "peripheral",
172
172
  "floating",
173
173
  "edgeCompute",
174
- "system"
174
+ "system",
175
+ "embedded"
175
176
  ]
176
177
  },
177
178
  "gatewayId": {
data/schemas/deviceRecipe.json CHANGED
@@ -200,7 +200,8 @@
200
200
  "peripheral",
201
201
  "floating",
202
202
  "edgeCompute",
203
- "system"
203
+ "system",
204
+ "embedded"
204
205
  ]
205
206
  },
206
207
  "gatewayId": {
data/schemas/deviceRecipePatch.json CHANGED
@@ -180,7 +180,8 @@
180
180
  "peripheral",
181
181
  "floating",
182
182
  "edgeCompute",
183
- "system"
183
+ "system",
184
+ "embedded"
184
185
  ]
185
186
  },
186
187
  "gatewayId": {
data/schemas/deviceRecipePost.json CHANGED
@@ -180,7 +180,8 @@
180
180
  "peripheral",
181
181
  "floating",
182
182
  "edgeCompute",
183
- "system"
183
+ "system",
184
+ "embedded"
184
185
  ]
185
186
  },
186
187
  "gatewayId": {
data/schemas/deviceRecipes.json CHANGED
@@ -207,7 +207,8 @@
207
207
  "peripheral",
208
208
  "floating",
209
209
  "edgeCompute",
210
- "system"
210
+ "system",
211
+ "embedded"
211
212
  ]
212
213
  },
213
214
  "gatewayId": {
data/schemas/devices.json CHANGED
@@ -198,7 +198,8 @@
198
198
  "peripheral",
199
199
  "floating",
200
200
  "edgeCompute",
201
- "system"
201
+ "system",
202
+ "embedded"
202
203
  ]
203
204
  },
204
205
  "gatewayId": {
@@ -290,7 +291,8 @@
290
291
  "peripheral",
291
292
  "floating",
292
293
  "edgeCompute",
293
- "system"
294
+ "system",
295
+ "embedded"
294
296
  ]
295
297
  },
296
298
  "tagFilter": {
data/schemas/devicesPatch.json CHANGED
@@ -176,7 +176,8 @@
176
176
  "peripheral",
177
177
  "floating",
178
178
  "edgeCompute",
179
- "system"
179
+ "system",
180
+ "embedded"
180
181
  ]
181
182
  },
182
183
  "gatewayId": {
@@ -1597,7 +1598,8 @@
1597
1598
  "peripheral",
1598
1599
  "floating",
1599
1600
  "edgeCompute",
1600
- "system"
1601
+ "system",
1602
+ "embedded"
1601
1603
  ]
1602
1604
  }
1603
1605
  },
data/schemas/edgeDeployment.json CHANGED
@@ -48,6 +48,10 @@
48
48
  "minLength": 1,
49
49
  "maxLength": 255
50
50
  },
51
+ "fileName": {
52
+ "type": "string",
53
+ "pattern": "^(?!\\.{1,2}$)[0-9a-zA-Z_.-]{1,255}$"
54
+ },
51
55
  "creationDate": {
52
56
  "type": "string",
53
57
  "format": "date-time"
data/schemas/edgeDeployments.json CHANGED
@@ -55,6 +55,10 @@
55
55
  "minLength": 1,
56
56
  "maxLength": 255
57
57
  },
58
+ "fileName": {
59
+ "type": "string",
60
+ "pattern": "^(?!\\.{1,2}$)[0-9a-zA-Z_.-]{1,255}$"
61
+ },
58
62
  "creationDate": {
59
63
  "type": "string",
60
64
  "format": "date-time"
data/schemas/embeddedDeployment.json ADDED
@@ -0,0 +1,179 @@
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
+ "embeddedDeploymentId": {
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
+ "deviceId": {
26
+ "type": "string",
27
+ "pattern": "^[A-Fa-f\\d]{24}$"
28
+ },
29
+ "deviceName": {
30
+ "type": "string",
31
+ "minLength": 1,
32
+ "maxLength": 255
33
+ },
34
+ "deviceConnectionInfo": {
35
+ "type": "object",
36
+ "properties": {
37
+ "time": {
38
+ "type": "string",
39
+ "format": "date-time"
40
+ },
41
+ "connected": {
42
+ "enum": [
43
+ 1,
44
+ 0,
45
+ null
46
+ ]
47
+ }
48
+ }
49
+ },
50
+ "flows": {
51
+ "type": "object",
52
+ "patternProperties": {
53
+ "^[A-Fa-f\\d]{24}$": {
54
+ "type": "object",
55
+ "properties": {
56
+ "flowName": {
57
+ "type": "string",
58
+ "minLength": 1,
59
+ "maxLength": 255
60
+ },
61
+ "currentVersion": {
62
+ "type": [
63
+ "string",
64
+ "null"
65
+ ],
66
+ "minLength": 1,
67
+ "maxLength": 255
68
+ },
69
+ "desiredVersion": {
70
+ "type": [
71
+ "string",
72
+ "null"
73
+ ],
74
+ "minLength": 1,
75
+ "maxLength": 255
76
+ }
77
+ }
78
+ }
79
+ },
80
+ "additionalProperties": false
81
+ },
82
+ "currentBundleVersion": {
83
+ "type": [
84
+ "string",
85
+ "null"
86
+ ],
87
+ "minLength": 1,
88
+ "maxLength": 255
89
+ },
90
+ "desiredBundleVersion": {
91
+ "type": [
92
+ "string",
93
+ "null"
94
+ ],
95
+ "minLength": 1,
96
+ "maxLength": 255
97
+ },
98
+ "unknownBundle": {
99
+ "type": "boolean"
100
+ },
101
+ "logs": {
102
+ "type": "array",
103
+ "items": {
104
+ "type": "object",
105
+ "properties": {
106
+ "sourceType": {
107
+ "type": "string",
108
+ "enum": [
109
+ "flow",
110
+ "user",
111
+ "device",
112
+ "apiToken",
113
+ "notebook"
114
+ ]
115
+ },
116
+ "sourceId": {
117
+ "type": "string",
118
+ "pattern": "^[A-Fa-f\\d]{24}$"
119
+ },
120
+ "date": {
121
+ "type": "string",
122
+ "format": "date-time"
123
+ },
124
+ "changeType": {
125
+ "type": "string",
126
+ "enum": [
127
+ "current",
128
+ "desired"
129
+ ]
130
+ },
131
+ "updateType": {
132
+ "type": "string",
133
+ "enum": [
134
+ "newFlow",
135
+ "replaceFlow",
136
+ "removeFlow",
137
+ "clear",
138
+ "globals",
139
+ "device",
140
+ "unknownBundle",
141
+ "knownBundle"
142
+ ]
143
+ },
144
+ "updateFlowId": {
145
+ "type": "string",
146
+ "pattern": "^[A-Fa-f\\d]{24}$"
147
+ },
148
+ "desiredVersion": {
149
+ "type": [
150
+ "string",
151
+ "null"
152
+ ],
153
+ "minLength": 1,
154
+ "maxLength": 255
155
+ },
156
+ "newBundle": {
157
+ "type": [
158
+ "string",
159
+ "null"
160
+ ],
161
+ "minLength": 1,
162
+ "maxLength": 255
163
+ },
164
+ "attemptedBundle": {
165
+ "type": [
166
+ "string",
167
+ "null"
168
+ ],
169
+ "minLength": 1,
170
+ "maxLength": 255
171
+ },
172
+ "error": {
173
+ "type": "string"
174
+ }
175
+ }
176
+ }
177
+ }
178
+ }
179
+ }
data/schemas/embeddedDeploymentExport.json ADDED
@@ -0,0 +1,44 @@
1
+ {
2
+ "$schema": "http://json-schema.org/draft-04/schema#",
3
+ "type": "object",
4
+ "properties": {
5
+ "email": {
6
+ "type": "string",
7
+ "format": "email",
8
+ "maxLength": 1024
9
+ },
10
+ "embeddedDeploymentId": {
11
+ "type": "string",
12
+ "pattern": "^[A-Fa-f\\d]{24}$"
13
+ },
14
+ "deviceId": {
15
+ "type": "string",
16
+ "pattern": "^[A-Fa-f\\d]{24}$"
17
+ },
18
+ "traceLevel": {
19
+ "enum": [
20
+ 0,
21
+ 1,
22
+ 2
23
+ ]
24
+ },
25
+ "disableDebugMessage": {
26
+ "type": "boolean"
27
+ },
28
+ "stackSize": {
29
+ "type": "integer",
30
+ "minimum": 1600,
31
+ "maximum": 2147483648
32
+ },
33
+ "debugSymbols": {
34
+ "type": "boolean"
35
+ },
36
+ "exportMemory": {
37
+ "type": "boolean"
38
+ },
39
+ "gzip": {
40
+ "type": "boolean"
41
+ }
42
+ },
43
+ "additionalProperties": false
44
+ }
data/schemas/embeddedDeploymentRelease.json ADDED
@@ -0,0 +1,58 @@
1
+ {
2
+ "$schema": "http://json-schema.org/draft-04/schema#",
3
+ "type": "object",
4
+ "properties": {
5
+ "flowId": {
6
+ "type": "string",
7
+ "pattern": "^[A-Fa-f\\d]{24}$"
8
+ },
9
+ "version": {
10
+ "type": [
11
+ "string",
12
+ "null"
13
+ ],
14
+ "minLength": 1,
15
+ "maxLength": 255
16
+ },
17
+ "deviceIds": {
18
+ "type": "array",
19
+ "items": {
20
+ "type": "string",
21
+ "pattern": "^[A-Fa-f\\d]{24}$"
22
+ },
23
+ "maxItems": 1000
24
+ },
25
+ "deviceTags": {
26
+ "type": "array",
27
+ "items": {
28
+ "type": "object",
29
+ "properties": {
30
+ "key": {
31
+ "type": "string",
32
+ "pattern": "^[0-9a-zA-Z_-]{1,255}$"
33
+ },
34
+ "value": {
35
+ "type": "string",
36
+ "minLength": 1,
37
+ "maxLength": 255
38
+ }
39
+ },
40
+ "additionalProperties": false
41
+ },
42
+ "maxItems": 100
43
+ },
44
+ "releaseTag": {
45
+ "type": [
46
+ "string",
47
+ "null"
48
+ ],
49
+ "minLength": 1,
50
+ "maxLength": 255
51
+ }
52
+ },
53
+ "additionalProperties": false,
54
+ "required": [
55
+ "flowId",
56
+ "version"
57
+ ]
58
+ }
data/schemas/embeddedDeploymentRemove.json ADDED
@@ -0,0 +1,25 @@
1
+ {
2
+ "$schema": "http://json-schema.org/draft-04/schema#",
3
+ "type": "object",
4
+ "properties": {
5
+ "flowId": {
6
+ "type": [
7
+ "string",
8
+ "null"
9
+ ],
10
+ "pattern": "^[A-Fa-f\\d]{24}$"
11
+ },
12
+ "deviceId": {
13
+ "type": [
14
+ "string",
15
+ "null"
16
+ ],
17
+ "pattern": "^[A-Fa-f\\d]{24}$"
18
+ }
19
+ },
20
+ "additionalProperties": false,
21
+ "required": [
22
+ "flowId",
23
+ "deviceId"
24
+ ]
25
+ }
data/schemas/embeddedDeploymentReplace.json ADDED
@@ -0,0 +1,29 @@
1
+ {
2
+ "$schema": "http://json-schema.org/draft-04/schema#",
3
+ "type": "object",
4
+ "properties": {
5
+ "flowId": {
6
+ "type": "string",
7
+ "pattern": "^[A-Fa-f\\d]{24}$"
8
+ },
9
+ "oldVersion": {
10
+ "type": "string",
11
+ "minLength": 1,
12
+ "maxLength": 255
13
+ },
14
+ "newVersion": {
15
+ "type": [
16
+ "string",
17
+ "null"
18
+ ],
19
+ "minLength": 1,
20
+ "maxLength": 255
21
+ }
22
+ },
23
+ "additionalProperties": false,
24
+ "required": [
25
+ "flowId",
26
+ "oldVersion",
27
+ "newVersion"
28
+ ]
29
+ }