losant_rest 1.15.2 → 1.16.2

Sign up to get free protection for your applications and to get access to all the features.
Files changed (94) hide show
  1. checksums.yaml +4 -4
  2. data/docs/_schemas.md +7912 -2208
  3. data/docs/application.md +3 -4
  4. data/docs/applicationDashboard.md +43 -0
  5. data/docs/applications.md +3 -2
  6. data/docs/flows.md +38 -0
  7. data/docs/instanceCustomNode.md +222 -0
  8. data/docs/instanceCustomNodes.md +91 -0
  9. data/docs/instanceSandbox.md +135 -0
  10. data/docs/instanceSandboxes.md +53 -0
  11. data/lib/losant_rest/application_dashboard.rb +49 -0
  12. data/lib/losant_rest/client.rb +18 -2
  13. data/lib/losant_rest/flows.rb +44 -0
  14. data/lib/losant_rest/instance_custom_node.rb +282 -0
  15. data/lib/losant_rest/instance_custom_nodes.rb +136 -0
  16. data/lib/losant_rest/instance_sandbox.rb +181 -0
  17. data/lib/losant_rest/instance_sandboxes.rb +94 -0
  18. data/lib/losant_rest/version.rb +1 -1
  19. data/lib/losant_rest.rb +4 -0
  20. data/schemas/apiTokenPost.json +18 -1
  21. data/schemas/application.json +1 -1
  22. data/schemas/applicationApplyTemplatePatch.json +5 -0
  23. data/schemas/applicationClonePost.json +5 -0
  24. data/schemas/applicationCreationByTemplateResult.json +1 -1
  25. data/schemas/applicationDashboardPost.json +165 -3
  26. data/schemas/applicationExportPost.json +5 -0
  27. data/schemas/applicationImportOptions.json +43 -0
  28. data/schemas/applicationPatch.json +1 -1
  29. data/schemas/applicationPost.json +1 -1
  30. data/schemas/applicationSearchResult.json +2 -1
  31. data/schemas/applicationTemplateCategories.json +11 -0
  32. data/schemas/applicationTemplateCategory.json +11 -0
  33. data/schemas/applications.json +1 -1
  34. data/schemas/dashboard.json +165 -3
  35. data/schemas/dashboardPatch.json +165 -3
  36. data/schemas/dashboardPost.json +165 -3
  37. data/schemas/dashboardSendReport.json +23 -3
  38. data/schemas/dashboards.json +165 -3
  39. data/schemas/dataExport.json +1 -0
  40. data/schemas/devicesDeletePost.json +5 -0
  41. data/schemas/devicesExportPayloadCountPost.json +1 -0
  42. data/schemas/devicesExportPost.json +1 -0
  43. data/schemas/devicesPatch.json +5 -0
  44. data/schemas/embeddedDeploymentExport.json +5 -0
  45. data/schemas/eventsExport.json +1 -0
  46. data/schemas/experienceBootstrapOptions.json +1 -1
  47. data/schemas/experienceLinkedResources.json +20 -5
  48. data/schemas/experienceSlug.json +1 -1
  49. data/schemas/experienceSlugPatch.json +1 -1
  50. data/schemas/experienceSlugPost.json +1 -1
  51. data/schemas/experienceSlugs.json +1 -1
  52. data/schemas/experienceUser.json +2 -1
  53. data/schemas/experienceUsers.json +2 -1
  54. data/schemas/flow.json +18 -0
  55. data/schemas/flowPatch.json +19 -0
  56. data/schemas/flowPost.json +19 -0
  57. data/schemas/flowVersion.json +2 -5
  58. data/schemas/flowVersionPost.json +1 -0
  59. data/schemas/flowVersions.json +2 -5
  60. data/schemas/flowVersionsDeletePost.json +5 -0
  61. data/schemas/flows.json +18 -0
  62. data/schemas/flowsImportPost.json +29 -2
  63. data/schemas/flowsImportResult.json +20 -5
  64. data/schemas/githubLogin.json +18 -1
  65. data/schemas/importIntoApplicationOptions.json +52 -0
  66. data/schemas/importNewApplicationOptions.json +44 -0
  67. data/schemas/instance.json +1 -0
  68. data/schemas/instanceCustomNode.json +589 -0
  69. data/schemas/instanceCustomNodePatch.json +674 -0
  70. data/schemas/instanceCustomNodePost.json +679 -0
  71. data/schemas/instanceCustomNodes.json +634 -0
  72. data/schemas/instanceMember.json +2 -1
  73. data/schemas/instanceMembers.json +2 -1
  74. data/schemas/instanceOrg.json +38 -0
  75. data/schemas/instanceOrgMember.json +2 -1
  76. data/schemas/instanceOrgPatch.json +29 -0
  77. data/schemas/instanceOrgPost.json +29 -0
  78. data/schemas/instanceOrgs.json +38 -0
  79. data/schemas/instancePatch.json +1 -0
  80. data/schemas/instanceReportOptionsPost.json +1 -0
  81. data/schemas/instanceSandbox.json +423 -0
  82. data/schemas/instanceSandboxes.json +48 -0
  83. data/schemas/integration.json +29 -1
  84. data/schemas/integrationPatch.json +29 -1
  85. data/schemas/integrationPost.json +29 -1
  86. data/schemas/integrations.json +29 -1
  87. data/schemas/me.json +2 -1
  88. data/schemas/notebookDataExportOptions.json +5 -0
  89. data/schemas/org.json +19 -1
  90. data/schemas/orgs.json +19 -1
  91. data/schemas/paletteResponse.json +785 -0
  92. data/schemas/userCredentials.json +18 -1
  93. data/schemas/userPost.json +18 -1
  94. metadata +20 -2
data/schemas/instanceOrg.json CHANGED
@@ -2,6 +2,14 @@
2
2
  "$schema": "http://json-schema.org/draft-04/schema#",
3
3
  "type": "object",
4
4
  "properties": {
5
+ "creationDate": {
6
+ "type": "string",
7
+ "format": "date-time"
8
+ },
9
+ "lastUpdated": {
10
+ "type": "string",
11
+ "format": "date-time"
12
+ },
5
13
  "name": {
6
14
  "type": "string",
7
15
  "minLength": 1,
@@ -137,6 +145,36 @@
137
145
  "format": "date-time"
138
146
  }
139
147
  ]
148
+ },
149
+ "isReadOnly": {
150
+ "type": "boolean"
151
+ },
152
+ "tags": {
153
+ "type": "array",
154
+ "items": {
155
+ "type": "object",
156
+ "properties": {
157
+ "key": {
158
+ "type": "string",
159
+ "pattern": "^[0-9a-zA-Z_-]{1,255}$"
160
+ },
161
+ "value": {
162
+ "type": "string",
163
+ "minLength": 1,
164
+ "maxLength": 255
165
+ }
166
+ },
167
+ "required": [
168
+ "key",
169
+ "value"
170
+ ],
171
+ "additionalProperties": false
172
+ },
173
+ "maxItems": 100
174
+ },
175
+ "referralId": {
176
+ "type": "string",
177
+ "maxLength": 1024
140
178
  }
141
179
  },
142
180
  "additionalProperties": false,
data/schemas/instanceOrgMember.json CHANGED
@@ -37,7 +37,8 @@
37
37
  },
38
38
  "avatarUrl": {
39
39
  "type": "string",
40
- "format": "url"
40
+ "format": "uri",
41
+ "maxLength": 1024
41
42
  },
42
43
  "twoFactorAuthEnabled": {
43
44
  "type": "boolean"
data/schemas/instanceOrgPatch.json CHANGED
@@ -154,6 +154,35 @@
154
154
  "type": "boolean"
155
155
  }
156
156
  ]
157
+ },
158
+ "isReadOnly": {
159
+ "type": "boolean"
160
+ },
161
+ "tags": {
162
+ "type": "array",
163
+ "items": {
164
+ "type": "object",
165
+ "properties": {
166
+ "key": {
167
+ "type": "string",
168
+ "pattern": "^[0-9a-zA-Z_-]{1,255}$"
169
+ },
170
+ "value": {
171
+ "type": "string",
172
+ "minLength": 1,
173
+ "maxLength": 255
174
+ }
175
+ },
176
+ "required": [
177
+ "key",
178
+ "value"
179
+ ],
180
+ "additionalProperties": false
181
+ },
182
+ "maxItems": 100
183
+ },
184
+ "referralId": {
185
+ "ref": "#/definitions/common/optMedStr"
157
186
  }
158
187
  },
159
188
  "additionalProperties": false
data/schemas/instanceOrgPost.json CHANGED
@@ -320,6 +320,35 @@
320
320
  "type": "boolean"
321
321
  }
322
322
  ]
323
+ },
324
+ "isReadOnly": {
325
+ "type": "boolean"
326
+ },
327
+ "tags": {
328
+ "type": "array",
329
+ "items": {
330
+ "type": "object",
331
+ "properties": {
332
+ "key": {
333
+ "type": "string",
334
+ "pattern": "^[0-9a-zA-Z_-]{1,255}$"
335
+ },
336
+ "value": {
337
+ "type": "string",
338
+ "minLength": 1,
339
+ "maxLength": 255
340
+ }
341
+ },
342
+ "required": [
343
+ "key",
344
+ "value"
345
+ ],
346
+ "additionalProperties": false
347
+ },
348
+ "maxItems": 100
349
+ },
350
+ "referralId": {
351
+ "ref": "#/definitions/common/optMedStr"
323
352
  }
324
353
  },
325
354
  "additionalProperties": false,
data/schemas/instanceOrgs.json CHANGED
@@ -9,6 +9,14 @@
9
9
  "description": "Schema for the body of an Organization owned by an instance",
10
10
  "type": "object",
11
11
  "properties": {
12
+ "creationDate": {
13
+ "type": "string",
14
+ "format": "date-time"
15
+ },
16
+ "lastUpdated": {
17
+ "type": "string",
18
+ "format": "date-time"
19
+ },
12
20
  "name": {
13
21
  "type": "string",
14
22
  "minLength": 1,
@@ -144,6 +152,36 @@
144
152
  "format": "date-time"
145
153
  }
146
154
  ]
155
+ },
156
+ "isReadOnly": {
157
+ "type": "boolean"
158
+ },
159
+ "tags": {
160
+ "type": "array",
161
+ "items": {
162
+ "type": "object",
163
+ "properties": {
164
+ "key": {
165
+ "type": "string",
166
+ "pattern": "^[0-9a-zA-Z_-]{1,255}$"
167
+ },
168
+ "value": {
169
+ "type": "string",
170
+ "minLength": 1,
171
+ "maxLength": 255
172
+ }
173
+ },
174
+ "required": [
175
+ "key",
176
+ "value"
177
+ ],
178
+ "additionalProperties": false
179
+ },
180
+ "maxItems": 100
181
+ },
182
+ "referralId": {
183
+ "type": "string",
184
+ "maxLength": 1024
147
185
  }
148
186
  },
149
187
  "additionalProperties": false,
data/schemas/instancePatch.json CHANGED
@@ -31,6 +31,7 @@
31
31
  },
32
32
  "callbackUrl": {
33
33
  "type": "string",
34
+ "format": "uri",
34
35
  "maxLength": 1024
35
36
  },
36
37
  "resourceGroupBy": {
data/schemas/instanceReportOptionsPost.json CHANGED
@@ -9,6 +9,7 @@
9
9
  },
10
10
  "callbackUrl": {
11
11
  "type": "string",
12
+ "format": "uri",
12
13
  "maxLength": 1024
13
14
  },
14
15
  "resourceGroupBy": {
data/schemas/instanceSandbox.json ADDED
@@ -0,0 +1,423 @@
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
+ "instanceSandboxId": {
10
+ "type": "string",
11
+ "pattern": "^[A-Fa-f\\d]{24}$"
12
+ },
13
+ "instanceId": {
14
+ "type": "string",
15
+ "pattern": "^[A-Fa-f\\d]{24}$"
16
+ },
17
+ "creationDate": {
18
+ "type": "string",
19
+ "format": "date-time"
20
+ },
21
+ "permanentDeletion": {
22
+ "type": "string",
23
+ "format": "date-time"
24
+ },
25
+ "dataDeletion": {
26
+ "type": "string",
27
+ "format": "date-time"
28
+ },
29
+ "lastUpdated": {
30
+ "type": "string",
31
+ "format": "date-time"
32
+ },
33
+ "lastSuccessfulLogin": {
34
+ "type": "string",
35
+ "format": "date-time"
36
+ },
37
+ "lastFailedLogin": {
38
+ "type": "string",
39
+ "format": "date-time"
40
+ },
41
+ "failedLoginCount": {
42
+ "type": "number"
43
+ },
44
+ "passwordLastUpdated": {
45
+ "type": "string",
46
+ "format": "date-time"
47
+ },
48
+ "email": {
49
+ "type": "string",
50
+ "format": "email",
51
+ "maxLength": 1024
52
+ },
53
+ "firstName": {
54
+ "type": "string",
55
+ "minLength": 1,
56
+ "maxLength": 1024
57
+ },
58
+ "lastName": {
59
+ "type": "string",
60
+ "maxLength": 1024
61
+ },
62
+ "companyName": {
63
+ "type": "string",
64
+ "maxLength": 1024
65
+ },
66
+ "title": {
67
+ "type": "string",
68
+ "maxLength": 1024
69
+ },
70
+ "phoneNumber": {
71
+ "type": "string",
72
+ "maxLength": 1024
73
+ },
74
+ "location": {
75
+ "type": "string",
76
+ "maxLength": 1024
77
+ },
78
+ "url": {
79
+ "type": "string",
80
+ "maxLength": 1024
81
+ },
82
+ "tokenCutoff": {
83
+ "type": "string",
84
+ "format": "date-time"
85
+ },
86
+ "emailVerified": {
87
+ "type": "boolean"
88
+ },
89
+ "needsToVerifyEmail": {
90
+ "type": "boolean"
91
+ },
92
+ "twoFactorAuthEnabled": {
93
+ "type": "boolean"
94
+ },
95
+ "fullName": {
96
+ "type": "string"
97
+ },
98
+ "githubName": {
99
+ "type": "string"
100
+ },
101
+ "avatarUrl": {
102
+ "type": "string",
103
+ "format": "uri",
104
+ "maxLength": 1024
105
+ },
106
+ "limits": {
107
+ "type": "object",
108
+ "properties": {
109
+ "apitoken": {
110
+ "type": "integer"
111
+ },
112
+ "application": {
113
+ "type": "integer"
114
+ },
115
+ "applicationkey": {
116
+ "type": "integer"
117
+ },
118
+ "dashboard": {
119
+ "type": "integer"
120
+ },
121
+ "datatable": {
122
+ "type": "integer"
123
+ },
124
+ "device": {
125
+ "type": "integer"
126
+ },
127
+ "devicerecipe": {
128
+ "type": "integer"
129
+ },
130
+ "experiencedomain": {
131
+ "type": "integer"
132
+ },
133
+ "experienceendpoint": {
134
+ "type": "integer"
135
+ },
136
+ "experiencegroup": {
137
+ "type": "integer"
138
+ },
139
+ "experienceslug": {
140
+ "type": "integer"
141
+ },
142
+ "experienceuser": {
143
+ "type": "integer"
144
+ },
145
+ "experienceversion": {
146
+ "type": "integer"
147
+ },
148
+ "experienceview": {
149
+ "type": "integer"
150
+ },
151
+ "file": {
152
+ "type": "integer"
153
+ },
154
+ "flow": {
155
+ "type": "integer"
156
+ },
157
+ "integration": {
158
+ "type": "integer"
159
+ },
160
+ "notebook": {
161
+ "type": "integer"
162
+ },
163
+ "webhook": {
164
+ "type": "integer"
165
+ },
166
+ "dataTTL": {
167
+ "type": "integer"
168
+ },
169
+ "payload": {
170
+ "type": "integer"
171
+ },
172
+ "storage": {
173
+ "type": "integer"
174
+ },
175
+ "notebookMinutesPerRun": {
176
+ "type": "integer"
177
+ },
178
+ "notebookMinutesPerMonth": {
179
+ "type": "integer"
180
+ },
181
+ "notebookInParallel": {
182
+ "type": "integer"
183
+ },
184
+ "experienceFlowSlots": {
185
+ "type": "integer"
186
+ },
187
+ "applicationFlowSlots": {
188
+ "type": "integer"
189
+ }
190
+ },
191
+ "additionalProperties": false
192
+ },
193
+ "summary": {
194
+ "type": "object",
195
+ "properties": {
196
+ "apiTokenCount": {
197
+ "type": "integer"
198
+ },
199
+ "appCount": {
200
+ "type": "integer"
201
+ },
202
+ "dashCount": {
203
+ "type": "integer"
204
+ },
205
+ "dataTableCount": {
206
+ "type": "integer"
207
+ },
208
+ "deviceCount": {
209
+ "type": "integer"
210
+ },
211
+ "deviceRecipeCount": {
212
+ "type": "integer"
213
+ },
214
+ "experienceEndpointCount": {
215
+ "type": "integer"
216
+ },
217
+ "experienceGroupCount": {
218
+ "type": "integer"
219
+ },
220
+ "experienceSlugCount": {
221
+ "type": "integer"
222
+ },
223
+ "experienceUserCount": {
224
+ "type": "integer"
225
+ },
226
+ "experienceVersionCount": {
227
+ "type": "integer"
228
+ },
229
+ "experienceViewCount": {
230
+ "type": "integer"
231
+ },
232
+ "fileCount": {
233
+ "type": "integer"
234
+ },
235
+ "flowCount": {
236
+ "type": "integer"
237
+ },
238
+ "integrationCount": {
239
+ "type": "integer"
240
+ },
241
+ "keyCount": {
242
+ "type": "integer"
243
+ },
244
+ "orgCount": {
245
+ "type": "integer"
246
+ },
247
+ "payloadCount": {
248
+ "title": "Payload Stats",
249
+ "description": "Schema for the result of a payload stats request",
250
+ "type": "object",
251
+ "properties": {
252
+ "dataTable": {
253
+ "type": "object",
254
+ "patternProperties": {
255
+ ".*": {
256
+ "type": "number"
257
+ }
258
+ }
259
+ },
260
+ "deviceCommand": {
261
+ "type": "object",
262
+ "patternProperties": {
263
+ ".*": {
264
+ "type": "number"
265
+ }
266
+ }
267
+ },
268
+ "deviceConnect": {
269
+ "type": "object",
270
+ "patternProperties": {
271
+ ".*": {
272
+ "type": "number"
273
+ }
274
+ }
275
+ },
276
+ "deviceDisconnect": {
277
+ "type": "object",
278
+ "patternProperties": {
279
+ ".*": {
280
+ "type": "number"
281
+ }
282
+ }
283
+ },
284
+ "deviceState": {
285
+ "type": "object",
286
+ "patternProperties": {
287
+ ".*": {
288
+ "type": "number"
289
+ }
290
+ }
291
+ },
292
+ "endpoint": {
293
+ "type": "object",
294
+ "patternProperties": {
295
+ ".*": {
296
+ "type": "number"
297
+ }
298
+ }
299
+ },
300
+ "event": {
301
+ "type": "object",
302
+ "patternProperties": {
303
+ ".*": {
304
+ "type": "number"
305
+ }
306
+ }
307
+ },
308
+ "flowError": {
309
+ "type": "object",
310
+ "patternProperties": {
311
+ ".*": {
312
+ "type": "number"
313
+ }
314
+ }
315
+ },
316
+ "integration": {
317
+ "type": "object",
318
+ "patternProperties": {
319
+ ".*": {
320
+ "type": "number"
321
+ }
322
+ }
323
+ },
324
+ "mqttIn": {
325
+ "type": "object",
326
+ "patternProperties": {
327
+ ".*": {
328
+ "type": "number"
329
+ }
330
+ }
331
+ },
332
+ "mqttOut": {
333
+ "type": "object",
334
+ "patternProperties": {
335
+ ".*": {
336
+ "type": "number"
337
+ }
338
+ }
339
+ },
340
+ "notebook": {
341
+ "type": "object",
342
+ "patternProperties": {
343
+ ".*": {
344
+ "type": "number"
345
+ }
346
+ }
347
+ },
348
+ "timer": {
349
+ "type": "object",
350
+ "patternProperties": {
351
+ ".*": {
352
+ "type": "number"
353
+ }
354
+ }
355
+ },
356
+ "virtualButton": {
357
+ "type": "object",
358
+ "patternProperties": {
359
+ ".*": {
360
+ "type": "number"
361
+ }
362
+ }
363
+ },
364
+ "webhook": {
365
+ "type": "object",
366
+ "patternProperties": {
367
+ ".*": {
368
+ "type": "number"
369
+ }
370
+ }
371
+ }
372
+ }
373
+ },
374
+ "storageStats": {
375
+ "type": "object",
376
+ "properties": {
377
+ "count": {
378
+ "type": "integer"
379
+ },
380
+ "size": {
381
+ "type": "integer"
382
+ }
383
+ }
384
+ },
385
+ "webhookCount": {
386
+ "type": "integer"
387
+ }
388
+ }
389
+ },
390
+ "currentPeriodStart": {
391
+ "type": "string",
392
+ "format": "date-time"
393
+ },
394
+ "currentPeriodEnd": {
395
+ "type": "string",
396
+ "format": "date-time"
397
+ },
398
+ "ssoLinked": {
399
+ "type": "boolean"
400
+ },
401
+ "orgs": {
402
+ "type": "array",
403
+ "items": {
404
+ "type": "object",
405
+ "properties": {
406
+ "id": {
407
+ "type": "string",
408
+ "pattern": "^[A-Fa-f\\d]{24}$"
409
+ },
410
+ "iconColor": {
411
+ "type": "string",
412
+ "maxLength": 64
413
+ },
414
+ "name": {
415
+ "type": "string",
416
+ "minLength": 1,
417
+ "maxLength": 255
418
+ }
419
+ }
420
+ }
421
+ }
422
+ }
423
+ }
data/schemas/instanceSandboxes.json ADDED
@@ -0,0 +1,48 @@
1
+ {
2
+ "$schema": "http://json-schema.org/draft-04/schema#",
3
+ "type": "object",
4
+ "properties": {
5
+ "items": {
6
+ "type": "array",
7
+ "items": {
8
+ "type": "#/definitions/instanceSandbox"
9
+ }
10
+ },
11
+ "count": {
12
+ "type": "integer"
13
+ },
14
+ "limit": {
15
+ "type": "integer"
16
+ },
17
+ "startingAfterId": {
18
+ "type": "string",
19
+ "pattern": "^[A-Fa-f\\d]{24}$"
20
+ },
21
+ "endingBeforeId": {
22
+ "type": "string",
23
+ "pattern": "^[A-Fa-f\\d]{24}$"
24
+ },
25
+ "filter": {
26
+ "type": "string"
27
+ },
28
+ "filterField": {
29
+ "type": "string"
30
+ },
31
+ "sortField": {
32
+ "type": "string"
33
+ },
34
+ "sortDirection": {
35
+ "type": "string",
36
+ "enum": [
37
+ "asc",
38
+ "desc",
39
+ "ASC",
40
+ "DESC",
41
+ ""
42
+ ]
43
+ },
44
+ "hasMore": {
45
+ "type": "boolean"
46
+ }
47
+ }
48
+ }