losant_rest 1.8.5 → 1.8.6

Sign up to get free protection for your applications and to get access to all the features.
Files changed (56) hide show
  1. checksums.yaml +4 -4
  2. data/docs/_schemas.md +2209 -127
  3. data/docs/application.md +4 -2
  4. data/docs/applications.md +4 -2
  5. data/docs/data.md +41 -0
  6. data/docs/me.md +4 -2
  7. data/docs/notebook.md +305 -0
  8. data/docs/notebooks.md +93 -0
  9. data/docs/org.md +8 -2
  10. data/docs/orgs.md +4 -2
  11. data/lib/losant_rest/application.rb +6 -2
  12. data/lib/losant_rest/applications.rb +6 -2
  13. data/lib/losant_rest/client.rb +10 -2
  14. data/lib/losant_rest/data.rb +47 -0
  15. data/lib/losant_rest/me.rb +6 -2
  16. data/lib/losant_rest/notebook.rb +322 -0
  17. data/lib/losant_rest/notebooks.rb +136 -0
  18. data/lib/losant_rest/org.rb +14 -2
  19. data/lib/losant_rest/orgs.rb +6 -2
  20. data/lib/losant_rest/version.rb +1 -1
  21. data/lib/losant_rest.rb +2 -0
  22. data/schemas/application.json +15 -4
  23. data/schemas/applicationApiTokenPost.json +12 -0
  24. data/schemas/applications.json +15 -4
  25. data/schemas/dataExport.json +65 -0
  26. data/schemas/deviceCredentials.json +1 -0
  27. data/schemas/edgeDeployment.json +2 -1
  28. data/schemas/edgeDeployments.json +2 -1
  29. data/schemas/event.json +4 -2
  30. data/schemas/events.json +4 -2
  31. data/schemas/file.json +2 -1
  32. data/schemas/fileUploadPostResponse.json +20 -26
  33. data/schemas/files.json +2 -1
  34. data/schemas/flow.json +1 -0
  35. data/schemas/flowPatch.json +1 -0
  36. data/schemas/flowPost.json +1 -0
  37. data/schemas/flowVersion.json +2 -0
  38. data/schemas/flowVersionPost.json +1 -0
  39. data/schemas/flowVersions.json +2 -0
  40. data/schemas/flows.json +1 -0
  41. data/schemas/flowsImportPost.json +2 -0
  42. data/schemas/flowsImportResult.json +3 -0
  43. data/schemas/githubLogin.json +12 -0
  44. data/schemas/me.json +28 -8
  45. data/schemas/notebook.json +322 -0
  46. data/schemas/notebookDataExportOptions.json +34 -0
  47. data/schemas/notebookExecutionLogs.json +125 -0
  48. data/schemas/notebookExecutionOptions.json +29 -0
  49. data/schemas/notebookPatch.json +295 -0
  50. data/schemas/notebookPost.json +298 -0
  51. data/schemas/notebooks.json +364 -0
  52. data/schemas/org.json +27 -10
  53. data/schemas/orgs.json +27 -10
  54. data/schemas/userCredentials.json +12 -0
  55. data/schemas/userPost.json +12 -0
  56. metadata +14 -2
@@ -0,0 +1,295 @@
1
+ {
2
+ "$schema": "http://json-schema.org/draft-04/schema#",
3
+ "type": "object",
4
+ "properties": {
5
+ "name": {
6
+ "type": "string",
7
+ "minLength": 1,
8
+ "maxLength": 1024
9
+ },
10
+ "description": {
11
+ "type": "string",
12
+ "maxLength": 32767
13
+ },
14
+ "inputs": {
15
+ "type": "array",
16
+ "items": {
17
+ "maxItems": 100,
18
+ "oneOf": [
19
+ {
20
+ "type": "object",
21
+ "properties": {
22
+ "inputType": {
23
+ "type": "string",
24
+ "enum": [
25
+ "deviceData"
26
+ ]
27
+ },
28
+ "fileName": {
29
+ "type": "string",
30
+ "pattern": "^[0-9a-zA-Z_.-]{1,255}$"
31
+ },
32
+ "deviceTags": {
33
+ "type": "array",
34
+ "items": {
35
+ "type": "object",
36
+ "properties": {
37
+ "key": {
38
+ "type": "string",
39
+ "pattern": "^[0-9a-zA-Z_-]{1,255}$"
40
+ },
41
+ "value": {
42
+ "type": "string",
43
+ "minLength": 1,
44
+ "maxLength": 255
45
+ }
46
+ },
47
+ "additionalProperties": false
48
+ },
49
+ "maxItems": 100
50
+ },
51
+ "deviceIds": {
52
+ "type": "array",
53
+ "items": {
54
+ "type": "string",
55
+ "pattern": "^[A-Fa-f\\d]{24}$"
56
+ },
57
+ "maxItems": 1000
58
+ },
59
+ "attributes": {
60
+ "type": "array",
61
+ "maxItems": 100,
62
+ "items": {
63
+ "type": "string",
64
+ "pattern": "^[0-9a-zA-Z_-]{1,255}$"
65
+ }
66
+ },
67
+ "start": {
68
+ "type": "number"
69
+ },
70
+ "end": {
71
+ "type": "number"
72
+ }
73
+ },
74
+ "required": [
75
+ "inputType",
76
+ "fileName",
77
+ "start",
78
+ "end"
79
+ ],
80
+ "additionalProperties": false
81
+ },
82
+ {
83
+ "type": "object",
84
+ "properties": {
85
+ "inputType": {
86
+ "type": "string",
87
+ "enum": [
88
+ "deviceMetadata"
89
+ ]
90
+ },
91
+ "fileName": {
92
+ "type": "string",
93
+ "pattern": "^[0-9a-zA-Z_.-]{1,255}$"
94
+ },
95
+ "deviceTags": {
96
+ "type": "array",
97
+ "items": {
98
+ "type": "object",
99
+ "properties": {
100
+ "key": {
101
+ "type": "string",
102
+ "pattern": "^[0-9a-zA-Z_-]{1,255}$"
103
+ },
104
+ "value": {
105
+ "type": "string",
106
+ "minLength": 1,
107
+ "maxLength": 255
108
+ }
109
+ },
110
+ "additionalProperties": false
111
+ },
112
+ "maxItems": 100
113
+ },
114
+ "deviceIds": {
115
+ "type": "array",
116
+ "items": {
117
+ "type": "string",
118
+ "pattern": "^[A-Fa-f\\d]{24}$"
119
+ },
120
+ "maxItems": 1000
121
+ }
122
+ },
123
+ "required": [
124
+ "inputType",
125
+ "fileName"
126
+ ],
127
+ "additionalProperties": false
128
+ },
129
+ {
130
+ "type": "object",
131
+ "properties": {
132
+ "inputType": {
133
+ "type": "string",
134
+ "enum": [
135
+ "dataTable"
136
+ ]
137
+ },
138
+ "fileName": {
139
+ "type": "string",
140
+ "pattern": "^[0-9a-zA-Z_.-]{1,255}$"
141
+ },
142
+ "dataTableId": {
143
+ "type": "string",
144
+ "pattern": "^[A-Fa-f\\d]{24}$"
145
+ },
146
+ "queryJson": {
147
+ "type": "string",
148
+ "maxLength": 32767
149
+ }
150
+ },
151
+ "required": [
152
+ "inputType",
153
+ "fileName",
154
+ "dataTableId"
155
+ ],
156
+ "additionalProperties": false
157
+ },
158
+ {
159
+ "type": "object",
160
+ "properties": {
161
+ "inputType": {
162
+ "type": "string",
163
+ "enum": [
164
+ "externalUrl"
165
+ ]
166
+ },
167
+ "fileName": {
168
+ "type": "string",
169
+ "pattern": "^[0-9a-zA-Z_.-]{1,255}$"
170
+ },
171
+ "sourceUrl": {
172
+ "type": "string",
173
+ "minLength": 1,
174
+ "maxLength": 1024
175
+ }
176
+ },
177
+ "required": [
178
+ "inputType",
179
+ "fileName",
180
+ "sourceUrl"
181
+ ],
182
+ "additionalProperties": false
183
+ }
184
+ ]
185
+ }
186
+ },
187
+ "outputs": {
188
+ "type": "array",
189
+ "items": {
190
+ "maxItems": 100,
191
+ "oneOf": [
192
+ {
193
+ "type": "object",
194
+ "properties": {
195
+ "outputType": {
196
+ "type": "string",
197
+ "enum": [
198
+ "dataTable"
199
+ ]
200
+ },
201
+ "fileName": {
202
+ "type": "string",
203
+ "pattern": "^[0-9a-zA-Z_.-]{1,255}$"
204
+ },
205
+ "dataTableId": {
206
+ "type": "string",
207
+ "pattern": "^[A-Fa-f\\d]{24}$"
208
+ },
209
+ "createMissingColumns": {
210
+ "type": "boolean"
211
+ },
212
+ "truncateExistingTable": {
213
+ "type": "boolean"
214
+ }
215
+ },
216
+ "required": [
217
+ "fileName",
218
+ "outputType",
219
+ "dataTableId"
220
+ ],
221
+ "additionalProperties": false
222
+ },
223
+ {
224
+ "type": "object",
225
+ "properties": {
226
+ "outputType": {
227
+ "type": "string",
228
+ "enum": [
229
+ "file"
230
+ ]
231
+ },
232
+ "fileName": {
233
+ "type": "string",
234
+ "pattern": "^[0-9a-zA-Z_.-]{1,255}$"
235
+ },
236
+ "destinationDirectoryTemplate": {
237
+ "type": "string",
238
+ "minLength": 1,
239
+ "maxLength": 1024
240
+ },
241
+ "destinationFileNameTemplate": {
242
+ "type": "string",
243
+ "minLength": 1,
244
+ "maxLength": 1024
245
+ }
246
+ },
247
+ "required": [
248
+ "fileName",
249
+ "outputType",
250
+ "destinationFileNameTemplate"
251
+ ],
252
+ "additionalProperties": false
253
+ },
254
+ {
255
+ "type": "object",
256
+ "properties": {
257
+ "outputType": {
258
+ "type": "string",
259
+ "enum": [
260
+ "executionResult"
261
+ ]
262
+ },
263
+ "fileName": {
264
+ "type": "string",
265
+ "enum": [
266
+ "result.html",
267
+ "result.pdf",
268
+ "result.ipynb",
269
+ "result.error.log",
270
+ "result.log"
271
+ ]
272
+ },
273
+ "destinationDirectoryTemplate": {
274
+ "type": "string",
275
+ "minLength": 1,
276
+ "maxLength": 1024
277
+ },
278
+ "destinationFileNameTemplate": {
279
+ "type": "string",
280
+ "minLength": 1,
281
+ "maxLength": 1024
282
+ }
283
+ },
284
+ "required": [
285
+ "fileName",
286
+ "outputType"
287
+ ],
288
+ "additionalProperties": false
289
+ }
290
+ ]
291
+ }
292
+ }
293
+ },
294
+ "additionalProperties": false
295
+ }
@@ -0,0 +1,298 @@
1
+ {
2
+ "$schema": "http://json-schema.org/draft-04/schema#",
3
+ "type": "object",
4
+ "properties": {
5
+ "name": {
6
+ "type": "string",
7
+ "minLength": 1,
8
+ "maxLength": 1024
9
+ },
10
+ "description": {
11
+ "type": "string",
12
+ "maxLength": 32767
13
+ },
14
+ "inputs": {
15
+ "type": "array",
16
+ "items": {
17
+ "maxItems": 100,
18
+ "oneOf": [
19
+ {
20
+ "type": "object",
21
+ "properties": {
22
+ "inputType": {
23
+ "type": "string",
24
+ "enum": [
25
+ "deviceData"
26
+ ]
27
+ },
28
+ "fileName": {
29
+ "type": "string",
30
+ "pattern": "^[0-9a-zA-Z_.-]{1,255}$"
31
+ },
32
+ "deviceTags": {
33
+ "type": "array",
34
+ "items": {
35
+ "type": "object",
36
+ "properties": {
37
+ "key": {
38
+ "type": "string",
39
+ "pattern": "^[0-9a-zA-Z_-]{1,255}$"
40
+ },
41
+ "value": {
42
+ "type": "string",
43
+ "minLength": 1,
44
+ "maxLength": 255
45
+ }
46
+ },
47
+ "additionalProperties": false
48
+ },
49
+ "maxItems": 100
50
+ },
51
+ "deviceIds": {
52
+ "type": "array",
53
+ "items": {
54
+ "type": "string",
55
+ "pattern": "^[A-Fa-f\\d]{24}$"
56
+ },
57
+ "maxItems": 1000
58
+ },
59
+ "attributes": {
60
+ "type": "array",
61
+ "maxItems": 100,
62
+ "items": {
63
+ "type": "string",
64
+ "pattern": "^[0-9a-zA-Z_-]{1,255}$"
65
+ }
66
+ },
67
+ "start": {
68
+ "type": "number"
69
+ },
70
+ "end": {
71
+ "type": "number"
72
+ }
73
+ },
74
+ "required": [
75
+ "inputType",
76
+ "fileName",
77
+ "start",
78
+ "end"
79
+ ],
80
+ "additionalProperties": false
81
+ },
82
+ {
83
+ "type": "object",
84
+ "properties": {
85
+ "inputType": {
86
+ "type": "string",
87
+ "enum": [
88
+ "deviceMetadata"
89
+ ]
90
+ },
91
+ "fileName": {
92
+ "type": "string",
93
+ "pattern": "^[0-9a-zA-Z_.-]{1,255}$"
94
+ },
95
+ "deviceTags": {
96
+ "type": "array",
97
+ "items": {
98
+ "type": "object",
99
+ "properties": {
100
+ "key": {
101
+ "type": "string",
102
+ "pattern": "^[0-9a-zA-Z_-]{1,255}$"
103
+ },
104
+ "value": {
105
+ "type": "string",
106
+ "minLength": 1,
107
+ "maxLength": 255
108
+ }
109
+ },
110
+ "additionalProperties": false
111
+ },
112
+ "maxItems": 100
113
+ },
114
+ "deviceIds": {
115
+ "type": "array",
116
+ "items": {
117
+ "type": "string",
118
+ "pattern": "^[A-Fa-f\\d]{24}$"
119
+ },
120
+ "maxItems": 1000
121
+ }
122
+ },
123
+ "required": [
124
+ "inputType",
125
+ "fileName"
126
+ ],
127
+ "additionalProperties": false
128
+ },
129
+ {
130
+ "type": "object",
131
+ "properties": {
132
+ "inputType": {
133
+ "type": "string",
134
+ "enum": [
135
+ "dataTable"
136
+ ]
137
+ },
138
+ "fileName": {
139
+ "type": "string",
140
+ "pattern": "^[0-9a-zA-Z_.-]{1,255}$"
141
+ },
142
+ "dataTableId": {
143
+ "type": "string",
144
+ "pattern": "^[A-Fa-f\\d]{24}$"
145
+ },
146
+ "queryJson": {
147
+ "type": "string",
148
+ "maxLength": 32767
149
+ }
150
+ },
151
+ "required": [
152
+ "inputType",
153
+ "fileName",
154
+ "dataTableId"
155
+ ],
156
+ "additionalProperties": false
157
+ },
158
+ {
159
+ "type": "object",
160
+ "properties": {
161
+ "inputType": {
162
+ "type": "string",
163
+ "enum": [
164
+ "externalUrl"
165
+ ]
166
+ },
167
+ "fileName": {
168
+ "type": "string",
169
+ "pattern": "^[0-9a-zA-Z_.-]{1,255}$"
170
+ },
171
+ "sourceUrl": {
172
+ "type": "string",
173
+ "minLength": 1,
174
+ "maxLength": 1024
175
+ }
176
+ },
177
+ "required": [
178
+ "inputType",
179
+ "fileName",
180
+ "sourceUrl"
181
+ ],
182
+ "additionalProperties": false
183
+ }
184
+ ]
185
+ }
186
+ },
187
+ "outputs": {
188
+ "type": "array",
189
+ "items": {
190
+ "maxItems": 100,
191
+ "oneOf": [
192
+ {
193
+ "type": "object",
194
+ "properties": {
195
+ "outputType": {
196
+ "type": "string",
197
+ "enum": [
198
+ "dataTable"
199
+ ]
200
+ },
201
+ "fileName": {
202
+ "type": "string",
203
+ "pattern": "^[0-9a-zA-Z_.-]{1,255}$"
204
+ },
205
+ "dataTableId": {
206
+ "type": "string",
207
+ "pattern": "^[A-Fa-f\\d]{24}$"
208
+ },
209
+ "createMissingColumns": {
210
+ "type": "boolean"
211
+ },
212
+ "truncateExistingTable": {
213
+ "type": "boolean"
214
+ }
215
+ },
216
+ "required": [
217
+ "fileName",
218
+ "outputType",
219
+ "dataTableId"
220
+ ],
221
+ "additionalProperties": false
222
+ },
223
+ {
224
+ "type": "object",
225
+ "properties": {
226
+ "outputType": {
227
+ "type": "string",
228
+ "enum": [
229
+ "file"
230
+ ]
231
+ },
232
+ "fileName": {
233
+ "type": "string",
234
+ "pattern": "^[0-9a-zA-Z_.-]{1,255}$"
235
+ },
236
+ "destinationDirectoryTemplate": {
237
+ "type": "string",
238
+ "minLength": 1,
239
+ "maxLength": 1024
240
+ },
241
+ "destinationFileNameTemplate": {
242
+ "type": "string",
243
+ "minLength": 1,
244
+ "maxLength": 1024
245
+ }
246
+ },
247
+ "required": [
248
+ "fileName",
249
+ "outputType",
250
+ "destinationFileNameTemplate"
251
+ ],
252
+ "additionalProperties": false
253
+ },
254
+ {
255
+ "type": "object",
256
+ "properties": {
257
+ "outputType": {
258
+ "type": "string",
259
+ "enum": [
260
+ "executionResult"
261
+ ]
262
+ },
263
+ "fileName": {
264
+ "type": "string",
265
+ "enum": [
266
+ "result.html",
267
+ "result.pdf",
268
+ "result.ipynb",
269
+ "result.error.log",
270
+ "result.log"
271
+ ]
272
+ },
273
+ "destinationDirectoryTemplate": {
274
+ "type": "string",
275
+ "minLength": 1,
276
+ "maxLength": 1024
277
+ },
278
+ "destinationFileNameTemplate": {
279
+ "type": "string",
280
+ "minLength": 1,
281
+ "maxLength": 1024
282
+ }
283
+ },
284
+ "required": [
285
+ "fileName",
286
+ "outputType"
287
+ ],
288
+ "additionalProperties": false
289
+ }
290
+ ]
291
+ }
292
+ }
293
+ },
294
+ "additionalProperties": false,
295
+ "required": [
296
+ "name"
297
+ ]
298
+ }