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
@@ -105,6 +105,11 @@
105
105
  "maxLength": 1024
106
106
  }
107
107
  },
108
+ "callbackUrl": {
109
+ "type": "string",
110
+ "format": "uri",
111
+ "maxLength": 1024
112
+ },
108
113
  "subject": {
109
114
  "type": "string",
110
115
  "maxLength": 255
@@ -127,12 +132,28 @@
127
132
  "locale": {
128
133
  "type": "string",
129
134
  "maxLength": 5
135
+ },
136
+ "ctx": {
137
+ "ref": "#/definitions/dashboardContextInstance"
138
+ },
139
+ "branded": {
140
+ "type": "boolean"
130
141
  }
131
142
  },
132
143
  "additionalProperties": false,
133
- "required": [
134
- "cron",
135
- "toEmail"
144
+ "anyOf": [
145
+ {
146
+ "required": [
147
+ "cron",
148
+ "toEmail"
149
+ ]
150
+ },
151
+ {
152
+ "required": [
153
+ "cron",
154
+ "callbackUrl"
155
+ ]
156
+ }
136
157
  ]
137
158
  }
138
159
  },
@@ -1095,6 +1116,147 @@
1095
1116
  ],
1096
1117
  "additionalProperties": false
1097
1118
  },
1119
+ {
1120
+ "type": "object",
1121
+ "properties": {
1122
+ "id": {
1123
+ "type": "string",
1124
+ "maxLength": 48
1125
+ },
1126
+ "title": {
1127
+ "type": "string",
1128
+ "maxLength": 255
1129
+ },
1130
+ "description": {
1131
+ "type": "string",
1132
+ "maxLength": 32767
1133
+ },
1134
+ "applicationId": {
1135
+ "type": "string",
1136
+ "pattern": "^[A-Fa-f\\d]{24}$"
1137
+ },
1138
+ "startX": {
1139
+ "type": "number"
1140
+ },
1141
+ "startY": {
1142
+ "type": "number"
1143
+ },
1144
+ "width": {
1145
+ "type": "number"
1146
+ },
1147
+ "height": {
1148
+ "type": "number"
1149
+ },
1150
+ "blockType": {
1151
+ "type": "string",
1152
+ "enum": [
1153
+ "device-count"
1154
+ ]
1155
+ },
1156
+ "config": {
1157
+ "type": "object",
1158
+ "properties": {
1159
+ "segments": {
1160
+ "type": "array",
1161
+ "minItems": 1,
1162
+ "maxItems": 100,
1163
+ "items": {
1164
+ "type": "object",
1165
+ "properties": {
1166
+ "id": {
1167
+ "type": "string",
1168
+ "maxLength": 48
1169
+ },
1170
+ "query": {
1171
+ "type": "string",
1172
+ "maxLength": 32767
1173
+ }
1174
+ },
1175
+ "required": [
1176
+ "id",
1177
+ "query"
1178
+ ],
1179
+ "additionalProperties": false
1180
+ }
1181
+ },
1182
+ "conditions": {
1183
+ "type": "array",
1184
+ "maxItems": 100,
1185
+ "items": {
1186
+ "type": "object",
1187
+ "properties": {
1188
+ "color": {
1189
+ "type": "string",
1190
+ "maxLength": 64
1191
+ },
1192
+ "id": {
1193
+ "type": "string",
1194
+ "maxLength": 48
1195
+ },
1196
+ "label": {
1197
+ "type": "string",
1198
+ "maxLength": 32767
1199
+ },
1200
+ "condition": {
1201
+ "type": "string",
1202
+ "maxLength": 2048
1203
+ },
1204
+ "imageUrl": {
1205
+ "type": "string",
1206
+ "maxLength": 32767
1207
+ },
1208
+ "shape": {
1209
+ "type": "string",
1210
+ "enum": [
1211
+ "circle",
1212
+ "square",
1213
+ "triangle-down",
1214
+ "triangle-up",
1215
+ "octagon"
1216
+ ]
1217
+ }
1218
+ },
1219
+ "additionalProperties": false
1220
+ }
1221
+ },
1222
+ "defaultCondition": {
1223
+ "type": "object",
1224
+ "properties": {
1225
+ "color": {
1226
+ "type": "string",
1227
+ "maxLength": 64
1228
+ },
1229
+ "label": {
1230
+ "type": "string",
1231
+ "maxLength": 32767
1232
+ },
1233
+ "value": {
1234
+ "type": "string",
1235
+ "maxLength": 32767
1236
+ }
1237
+ },
1238
+ "required": [
1239
+ "color"
1240
+ ],
1241
+ "additionalProperties": false
1242
+ }
1243
+ },
1244
+ "required": [
1245
+ "segments",
1246
+ "defaultCondition"
1247
+ ],
1248
+ "additionalProperties": false
1249
+ }
1250
+ },
1251
+ "required": [
1252
+ "blockType",
1253
+ "startX",
1254
+ "startY",
1255
+ "width",
1256
+ "height"
1257
+ ],
1258
+ "additionalProperties": false
1259
+ },
1098
1260
  {
1099
1261
  "type": "object",
1100
1262
  "properties": {
@@ -9,6 +9,7 @@
9
9
  },
10
10
  "callbackUrl": {
11
11
  "type": "string",
12
+ "format": "uri",
12
13
  "maxLength": 1024
13
14
  },
14
15
  "deviceIds": {
@@ -1334,6 +1334,11 @@
1334
1334
  }
1335
1335
  },
1336
1336
  "additionalProperties": false
1337
+ },
1338
+ "callbackUrl": {
1339
+ "type": "string",
1340
+ "format": "uri",
1341
+ "maxLength": 1024
1337
1342
  }
1338
1343
  },
1339
1344
  "additionalProperties": false,
@@ -9,6 +9,7 @@
9
9
  },
10
10
  "callbackUrl": {
11
11
  "type": "string",
12
+ "format": "uri",
12
13
  "maxLength": 1024
13
14
  },
14
15
  "query": {
@@ -9,6 +9,7 @@
9
9
  },
10
10
  "callbackUrl": {
11
11
  "type": "string",
12
+ "format": "uri",
12
13
  "maxLength": 1024
13
14
  },
14
15
  "query": {
@@ -2279,6 +2279,11 @@
2279
2279
  "type": "string",
2280
2280
  "format": "email",
2281
2281
  "maxLength": 1024
2282
+ },
2283
+ "callbackUrl": {
2284
+ "type": "string",
2285
+ "format": "uri",
2286
+ "maxLength": 1024
2282
2287
  }
2283
2288
  },
2284
2289
  "additionalProperties": false,
@@ -7,6 +7,11 @@
7
7
  "format": "email",
8
8
  "maxLength": 1024
9
9
  },
10
+ "callbackUrl": {
11
+ "type": "string",
12
+ "format": "uri",
13
+ "maxLength": 1024
14
+ },
10
15
  "embeddedDeploymentId": {
11
16
  "type": "string",
12
17
  "pattern": "^[A-Fa-f\\d]{24}$"
@@ -9,6 +9,7 @@
9
9
  },
10
10
  "callbackUrl": {
11
11
  "type": "string",
12
+ "format": "uri",
12
13
  "maxLength": 1024
13
14
  },
14
15
  "query": {
@@ -16,7 +16,7 @@
16
16
  },
17
17
  "slug": {
18
18
  "type": "string",
19
- "minLength": 4,
19
+ "minLength": 3,
20
20
  "maxLength": 63,
21
21
  "pattern": "^[0-9a-z-]*$"
22
22
  }
@@ -412,11 +412,28 @@
412
412
  "type": "string",
413
413
  "maxLength": 32767
414
414
  },
415
+ "shortDescription": {
416
+ "type": "string",
417
+ "maxLength": 1024
418
+ },
415
419
  "iconData": {
416
420
  "type": "string",
417
421
  "maxLength": 32767,
418
422
  "pattern": "^data:image/(jpg|jpeg|png|svg\\+xml);base64,[0-9a-zA-Z+/=]*$"
419
423
  },
424
+ "docsUrl": {
425
+ "type": "string",
426
+ "maxLength": 1024
427
+ },
428
+ "category": {
429
+ "type": "string",
430
+ "enum": [
431
+ "data",
432
+ "experience",
433
+ "logic",
434
+ "output"
435
+ ]
436
+ },
420
437
  "enabled": {
421
438
  "type": "boolean"
422
439
  },
@@ -489,6 +506,7 @@
489
506
  "deviceIdsTagsDisconnect",
490
507
  "eeaInit",
491
508
  "flowError",
509
+ "azureEventHub",
492
510
  "googlePubSub",
493
511
  "meridian",
494
512
  "mqtt",
@@ -3128,6 +3146,7 @@
3128
3146
  "deviceIdsTagsDisconnect",
3129
3147
  "eeaInit",
3130
3148
  "flowError",
3149
+ "azureEventHub",
3131
3150
  "googlePubSub",
3132
3151
  "meridian",
3133
3152
  "mqtt",
@@ -5643,11 +5662,6 @@
5643
5662
  "type": "string",
5644
5663
  "maxLength": 32767
5645
5664
  },
5646
- "iconData": {
5647
- "type": "string",
5648
- "maxLength": 32767,
5649
- "pattern": "^data:image/(jpg|jpeg|png|svg\\+xml);base64,[0-9a-zA-Z+/=]*$"
5650
- },
5651
5665
  "flowClass": {
5652
5666
  "type": "string",
5653
5667
  "enum": [
@@ -5716,6 +5730,7 @@
5716
5730
  "deviceIdsTagsDisconnect",
5717
5731
  "eeaInit",
5718
5732
  "flowError",
5733
+ "azureEventHub",
5719
5734
  "googlePubSub",
5720
5735
  "meridian",
5721
5736
  "mqtt",
@@ -24,7 +24,7 @@
24
24
  },
25
25
  "slug": {
26
26
  "type": "string",
27
- "minLength": 4,
27
+ "minLength": 3,
28
28
  "maxLength": 63,
29
29
  "pattern": "^[0-9a-z-]*$"
30
30
  },
@@ -16,7 +16,7 @@
16
16
  },
17
17
  "slug": {
18
18
  "type": "string",
19
- "minLength": 4,
19
+ "minLength": 3,
20
20
  "maxLength": 63,
21
21
  "pattern": "^[0-9a-z-]*$"
22
22
  }
@@ -16,7 +16,7 @@
16
16
  },
17
17
  "slug": {
18
18
  "type": "string",
19
- "minLength": 4,
19
+ "minLength": 3,
20
20
  "maxLength": 63,
21
21
  "pattern": "^[0-9a-z-]*$"
22
22
  }
@@ -31,7 +31,7 @@
31
31
  },
32
32
  "slug": {
33
33
  "type": "string",
34
- "minLength": 4,
34
+ "minLength": 3,
35
35
  "maxLength": 63,
36
36
  "pattern": "^[0-9a-z-]*$"
37
37
  },
@@ -45,7 +45,8 @@
45
45
  },
46
46
  "avatarUrl": {
47
47
  "type": "string",
48
- "format": "url"
48
+ "format": "uri",
49
+ "maxLength": 1024
49
50
  },
50
51
  "tokenCutoff": {
51
52
  "type": "string",
@@ -52,7 +52,8 @@
52
52
  },
53
53
  "avatarUrl": {
54
54
  "type": "string",
55
- "format": "url"
55
+ "format": "uri",
56
+ "maxLength": 1024
56
57
  },
57
58
  "tokenCutoff": {
58
59
  "type": "string",
data/schemas/flow.json CHANGED
@@ -31,11 +31,28 @@
31
31
  "type": "string",
32
32
  "maxLength": 32767
33
33
  },
34
+ "shortDescription": {
35
+ "type": "string",
36
+ "maxLength": 1024
37
+ },
34
38
  "iconData": {
35
39
  "type": "string",
36
40
  "maxLength": 32767,
37
41
  "pattern": "^data:image/(jpg|jpeg|png|svg\\+xml);base64,[0-9a-zA-Z+/=]*$"
38
42
  },
43
+ "docsUrl": {
44
+ "type": "string",
45
+ "maxLength": 1024
46
+ },
47
+ "category": {
48
+ "type": "string",
49
+ "enum": [
50
+ "data",
51
+ "experience",
52
+ "logic",
53
+ "output"
54
+ ]
55
+ },
39
56
  "enabled": {
40
57
  "type": "boolean"
41
58
  },
@@ -108,6 +125,7 @@
108
125
  "deviceIdsTagsDisconnect",
109
126
  "eeaInit",
110
127
  "flowError",
128
+ "azureEventHub",
111
129
  "googlePubSub",
112
130
  "meridian",
113
131
  "mqtt",
@@ -11,6 +11,10 @@
11
11
  "type": "string",
12
12
  "maxLength": 32767
13
13
  },
14
+ "shortDescription": {
15
+ "type": "string",
16
+ "maxLength": 1024
17
+ },
14
18
  "iconData": {
15
19
  "oneOf": [
16
20
  {
@@ -23,6 +27,20 @@
23
27
  }
24
28
  ]
25
29
  },
30
+ "docsUrl": {
31
+ "type": "string",
32
+ "maxLength": 1024
33
+ },
34
+ "category": {
35
+ "type": "string",
36
+ "enum": [
37
+ "data",
38
+ "experience",
39
+ "logic",
40
+ "output",
41
+ ""
42
+ ]
43
+ },
26
44
  "enabled": {
27
45
  "type": "boolean"
28
46
  },
@@ -88,6 +106,7 @@
88
106
  "deviceIdsTagsDisconnect",
89
107
  "eeaInit",
90
108
  "flowError",
109
+ "azureEventHub",
91
110
  "googlePubSub",
92
111
  "meridian",
93
112
  "mqtt",
@@ -11,6 +11,10 @@
11
11
  "type": "string",
12
12
  "maxLength": 32767
13
13
  },
14
+ "shortDescription": {
15
+ "type": "string",
16
+ "maxLength": 1024
17
+ },
14
18
  "iconData": {
15
19
  "oneOf": [
16
20
  {
@@ -23,6 +27,20 @@
23
27
  }
24
28
  ]
25
29
  },
30
+ "docsUrl": {
31
+ "type": "string",
32
+ "maxLength": 1024
33
+ },
34
+ "category": {
35
+ "type": "string",
36
+ "enum": [
37
+ "data",
38
+ "experience",
39
+ "logic",
40
+ "output",
41
+ ""
42
+ ]
43
+ },
26
44
  "enabled": {
27
45
  "type": "boolean"
28
46
  },
@@ -77,6 +95,7 @@
77
95
  "deviceIdsTagsDisconnect",
78
96
  "eeaInit",
79
97
  "flowError",
98
+ "azureEventHub",
80
99
  "googlePubSub",
81
100
  "meridian",
82
101
  "mqtt",
@@ -92,6 +92,7 @@
92
92
  "deviceIdsTagsDisconnect",
93
93
  "eeaInit",
94
94
  "flowError",
95
+ "azureEventHub",
95
96
  "googlePubSub",
96
97
  "meridian",
97
98
  "mqtt",
@@ -2607,11 +2608,6 @@
2607
2608
  "type": "string",
2608
2609
  "maxLength": 32767
2609
2610
  },
2610
- "iconData": {
2611
- "type": "string",
2612
- "maxLength": 32767,
2613
- "pattern": "^data:image/(jpg|jpeg|png|svg\\+xml);base64,[0-9a-zA-Z+/=]*$"
2614
- },
2615
2611
  "flowClass": {
2616
2612
  "type": "string",
2617
2613
  "enum": [
@@ -2680,6 +2676,7 @@
2680
2676
  "deviceIdsTagsDisconnect",
2681
2677
  "eeaInit",
2682
2678
  "flowError",
2679
+ "azureEventHub",
2683
2680
  "googlePubSub",
2684
2681
  "meridian",
2685
2682
  "mqtt",
@@ -65,6 +65,7 @@
65
65
  "deviceIdsTagsDisconnect",
66
66
  "eeaInit",
67
67
  "flowError",
68
+ "azureEventHub",
68
69
  "googlePubSub",
69
70
  "meridian",
70
71
  "mqtt",
@@ -99,6 +99,7 @@
99
99
  "deviceIdsTagsDisconnect",
100
100
  "eeaInit",
101
101
  "flowError",
102
+ "azureEventHub",
102
103
  "googlePubSub",
103
104
  "meridian",
104
105
  "mqtt",
@@ -2614,11 +2615,6 @@
2614
2615
  "type": "string",
2615
2616
  "maxLength": 32767
2616
2617
  },
2617
- "iconData": {
2618
- "type": "string",
2619
- "maxLength": 32767,
2620
- "pattern": "^data:image/(jpg|jpeg|png|svg\\+xml);base64,[0-9a-zA-Z+/=]*$"
2621
- },
2622
2618
  "flowClass": {
2623
2619
  "type": "string",
2624
2620
  "enum": [
@@ -2687,6 +2683,7 @@
2687
2683
  "deviceIdsTagsDisconnect",
2688
2684
  "eeaInit",
2689
2685
  "flowError",
2686
+ "azureEventHub",
2690
2687
  "googlePubSub",
2691
2688
  "meridian",
2692
2689
  "mqtt",
@@ -932,6 +932,11 @@
932
932
  }
933
933
  },
934
934
  "additionalProperties": false
935
+ },
936
+ "callbackUrl": {
937
+ "type": "string",
938
+ "format": "uri",
939
+ "maxLength": 1024
935
940
  }
936
941
  },
937
942
  "additionalProperties": false,
data/schemas/flows.json CHANGED
@@ -38,11 +38,28 @@
38
38
  "type": "string",
39
39
  "maxLength": 32767
40
40
  },
41
+ "shortDescription": {
42
+ "type": "string",
43
+ "maxLength": 1024
44
+ },
41
45
  "iconData": {
42
46
  "type": "string",
43
47
  "maxLength": 32767,
44
48
  "pattern": "^data:image/(jpg|jpeg|png|svg\\+xml);base64,[0-9a-zA-Z+/=]*$"
45
49
  },
50
+ "docsUrl": {
51
+ "type": "string",
52
+ "maxLength": 1024
53
+ },
54
+ "category": {
55
+ "type": "string",
56
+ "enum": [
57
+ "data",
58
+ "experience",
59
+ "logic",
60
+ "output"
61
+ ]
62
+ },
46
63
  "enabled": {
47
64
  "type": "boolean"
48
65
  },
@@ -115,6 +132,7 @@
115
132
  "deviceIdsTagsDisconnect",
116
133
  "eeaInit",
117
134
  "flowError",
135
+ "azureEventHub",
118
136
  "googlePubSub",
119
137
  "meridian",
120
138
  "mqtt",