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/applicationTemplateCategories.json CHANGED
@@ -25,6 +25,17 @@
25
25
  "description": {
26
26
  "type": "string",
27
27
  "maxLength": 32767
28
+ },
29
+ "resourceTypes": {
30
+ "type": "array",
31
+ "items": {
32
+ "type": "string",
33
+ "enum": [
34
+ "DeviceRecipe",
35
+ "CustomNode"
36
+ ]
37
+ },
38
+ "maxItems": 100
28
39
  }
29
40
  }
30
41
  }
data/schemas/applicationTemplateCategory.json CHANGED
@@ -18,6 +18,17 @@
18
18
  "description": {
19
19
  "type": "string",
20
20
  "maxLength": 32767
21
+ },
22
+ "resourceTypes": {
23
+ "type": "array",
24
+ "items": {
25
+ "type": "string",
26
+ "enum": [
27
+ "DeviceRecipe",
28
+ "CustomNode"
29
+ ]
30
+ },
31
+ "maxItems": 100
21
32
  }
22
33
  }
23
34
  }
data/schemas/applications.json CHANGED
@@ -64,7 +64,7 @@
64
64
  },
65
65
  "endpointSlug": {
66
66
  "type": "string",
67
- "minLength": 4,
67
+ "minLength": 3,
68
68
  "maxLength": 63,
69
69
  "pattern": "^[0-9a-z-]*$"
70
70
  },
data/schemas/dashboard.json CHANGED
@@ -98,6 +98,11 @@
98
98
  "maxLength": 1024
99
99
  }
100
100
  },
101
+ "callbackUrl": {
102
+ "type": "string",
103
+ "format": "uri",
104
+ "maxLength": 1024
105
+ },
101
106
  "subject": {
102
107
  "type": "string",
103
108
  "maxLength": 255
@@ -120,12 +125,28 @@
120
125
  "locale": {
121
126
  "type": "string",
122
127
  "maxLength": 5
128
+ },
129
+ "ctx": {
130
+ "ref": "#/definitions/dashboardContextInstance"
131
+ },
132
+ "branded": {
133
+ "type": "boolean"
123
134
  }
124
135
  },
125
136
  "additionalProperties": false,
126
- "required": [
127
- "cron",
128
- "toEmail"
137
+ "anyOf": [
138
+ {
139
+ "required": [
140
+ "cron",
141
+ "toEmail"
142
+ ]
143
+ },
144
+ {
145
+ "required": [
146
+ "cron",
147
+ "callbackUrl"
148
+ ]
149
+ }
129
150
  ]
130
151
  }
131
152
  },
@@ -1088,6 +1109,147 @@
1088
1109
  ],
1089
1110
  "additionalProperties": false
1090
1111
  },
1112
+ {
1113
+ "type": "object",
1114
+ "properties": {
1115
+ "id": {
1116
+ "type": "string",
1117
+ "maxLength": 48
1118
+ },
1119
+ "title": {
1120
+ "type": "string",
1121
+ "maxLength": 255
1122
+ },
1123
+ "description": {
1124
+ "type": "string",
1125
+ "maxLength": 32767
1126
+ },
1127
+ "applicationId": {
1128
+ "type": "string",
1129
+ "pattern": "^[A-Fa-f\\d]{24}$"
1130
+ },
1131
+ "startX": {
1132
+ "type": "number"
1133
+ },
1134
+ "startY": {
1135
+ "type": "number"
1136
+ },
1137
+ "width": {
1138
+ "type": "number"
1139
+ },
1140
+ "height": {
1141
+ "type": "number"
1142
+ },
1143
+ "blockType": {
1144
+ "type": "string",
1145
+ "enum": [
1146
+ "device-count"
1147
+ ]
1148
+ },
1149
+ "config": {
1150
+ "type": "object",
1151
+ "properties": {
1152
+ "segments": {
1153
+ "type": "array",
1154
+ "minItems": 1,
1155
+ "maxItems": 100,
1156
+ "items": {
1157
+ "type": "object",
1158
+ "properties": {
1159
+ "id": {
1160
+ "type": "string",
1161
+ "maxLength": 48
1162
+ },
1163
+ "query": {
1164
+ "type": "string",
1165
+ "maxLength": 32767
1166
+ }
1167
+ },
1168
+ "required": [
1169
+ "id",
1170
+ "query"
1171
+ ],
1172
+ "additionalProperties": false
1173
+ }
1174
+ },
1175
+ "conditions": {
1176
+ "type": "array",
1177
+ "maxItems": 100,
1178
+ "items": {
1179
+ "type": "object",
1180
+ "properties": {
1181
+ "color": {
1182
+ "type": "string",
1183
+ "maxLength": 64
1184
+ },
1185
+ "id": {
1186
+ "type": "string",
1187
+ "maxLength": 48
1188
+ },
1189
+ "label": {
1190
+ "type": "string",
1191
+ "maxLength": 32767
1192
+ },
1193
+ "condition": {
1194
+ "type": "string",
1195
+ "maxLength": 2048
1196
+ },
1197
+ "imageUrl": {
1198
+ "type": "string",
1199
+ "maxLength": 32767
1200
+ },
1201
+ "shape": {
1202
+ "type": "string",
1203
+ "enum": [
1204
+ "circle",
1205
+ "square",
1206
+ "triangle-down",
1207
+ "triangle-up",
1208
+ "octagon"
1209
+ ]
1210
+ }
1211
+ },
1212
+ "additionalProperties": false
1213
+ }
1214
+ },
1215
+ "defaultCondition": {
1216
+ "type": "object",
1217
+ "properties": {
1218
+ "color": {
1219
+ "type": "string",
1220
+ "maxLength": 64
1221
+ },
1222
+ "label": {
1223
+ "type": "string",
1224
+ "maxLength": 32767
1225
+ },
1226
+ "value": {
1227
+ "type": "string",
1228
+ "maxLength": 32767
1229
+ }
1230
+ },
1231
+ "required": [
1232
+ "color"
1233
+ ],
1234
+ "additionalProperties": false
1235
+ }
1236
+ },
1237
+ "required": [
1238
+ "segments",
1239
+ "defaultCondition"
1240
+ ],
1241
+ "additionalProperties": false
1242
+ }
1243
+ },
1244
+ "required": [
1245
+ "blockType",
1246
+ "startX",
1247
+ "startY",
1248
+ "width",
1249
+ "height"
1250
+ ],
1251
+ "additionalProperties": false
1252
+ },
1091
1253
  {
1092
1254
  "type": "object",
1093
1255
  "properties": {
data/schemas/dashboardPatch.json CHANGED
@@ -966,6 +966,147 @@
966
966
  ],
967
967
  "additionalProperties": false
968
968
  },
969
+ {
970
+ "type": "object",
971
+ "properties": {
972
+ "id": {
973
+ "type": "string",
974
+ "maxLength": 48
975
+ },
976
+ "title": {
977
+ "type": "string",
978
+ "maxLength": 255
979
+ },
980
+ "description": {
981
+ "type": "string",
982
+ "maxLength": 32767
983
+ },
984
+ "applicationId": {
985
+ "type": "string",
986
+ "pattern": "^[A-Fa-f\\d]{24}$"
987
+ },
988
+ "startX": {
989
+ "type": "number"
990
+ },
991
+ "startY": {
992
+ "type": "number"
993
+ },
994
+ "width": {
995
+ "type": "number"
996
+ },
997
+ "height": {
998
+ "type": "number"
999
+ },
1000
+ "blockType": {
1001
+ "type": "string",
1002
+ "enum": [
1003
+ "device-count"
1004
+ ]
1005
+ },
1006
+ "config": {
1007
+ "type": "object",
1008
+ "properties": {
1009
+ "segments": {
1010
+ "type": "array",
1011
+ "minItems": 1,
1012
+ "maxItems": 100,
1013
+ "items": {
1014
+ "type": "object",
1015
+ "properties": {
1016
+ "id": {
1017
+ "type": "string",
1018
+ "maxLength": 48
1019
+ },
1020
+ "query": {
1021
+ "type": "string",
1022
+ "maxLength": 32767
1023
+ }
1024
+ },
1025
+ "required": [
1026
+ "id",
1027
+ "query"
1028
+ ],
1029
+ "additionalProperties": false
1030
+ }
1031
+ },
1032
+ "conditions": {
1033
+ "type": "array",
1034
+ "maxItems": 100,
1035
+ "items": {
1036
+ "type": "object",
1037
+ "properties": {
1038
+ "color": {
1039
+ "type": "string",
1040
+ "maxLength": 64
1041
+ },
1042
+ "id": {
1043
+ "type": "string",
1044
+ "maxLength": 48
1045
+ },
1046
+ "label": {
1047
+ "type": "string",
1048
+ "maxLength": 32767
1049
+ },
1050
+ "condition": {
1051
+ "type": "string",
1052
+ "maxLength": 2048
1053
+ },
1054
+ "imageUrl": {
1055
+ "type": "string",
1056
+ "maxLength": 32767
1057
+ },
1058
+ "shape": {
1059
+ "type": "string",
1060
+ "enum": [
1061
+ "circle",
1062
+ "square",
1063
+ "triangle-down",
1064
+ "triangle-up",
1065
+ "octagon"
1066
+ ]
1067
+ }
1068
+ },
1069
+ "additionalProperties": false
1070
+ }
1071
+ },
1072
+ "defaultCondition": {
1073
+ "type": "object",
1074
+ "properties": {
1075
+ "color": {
1076
+ "type": "string",
1077
+ "maxLength": 64
1078
+ },
1079
+ "label": {
1080
+ "type": "string",
1081
+ "maxLength": 32767
1082
+ },
1083
+ "value": {
1084
+ "type": "string",
1085
+ "maxLength": 32767
1086
+ }
1087
+ },
1088
+ "required": [
1089
+ "color"
1090
+ ],
1091
+ "additionalProperties": false
1092
+ }
1093
+ },
1094
+ "required": [
1095
+ "segments",
1096
+ "defaultCondition"
1097
+ ],
1098
+ "additionalProperties": false
1099
+ }
1100
+ },
1101
+ "required": [
1102
+ "blockType",
1103
+ "startX",
1104
+ "startY",
1105
+ "width",
1106
+ "height"
1107
+ ],
1108
+ "additionalProperties": false
1109
+ },
969
1110
  {
970
1111
  "type": "object",
971
1112
  "properties": {
@@ -5302,6 +5443,11 @@
5302
5443
  "maxLength": 1024
5303
5444
  }
5304
5445
  },
5446
+ "callbackUrl": {
5447
+ "type": "string",
5448
+ "format": "uri",
5449
+ "maxLength": 1024
5450
+ },
5305
5451
  "subject": {
5306
5452
  "type": "string",
5307
5453
  "maxLength": 255
@@ -5324,12 +5470,28 @@
5324
5470
  "locale": {
5325
5471
  "type": "string",
5326
5472
  "maxLength": 5
5473
+ },
5474
+ "ctx": {
5475
+ "ref": "#/definitions/dashboardContextInstance"
5476
+ },
5477
+ "branded": {
5478
+ "type": "boolean"
5327
5479
  }
5328
5480
  },
5329
5481
  "additionalProperties": false,
5330
- "required": [
5331
- "cron",
5332
- "toEmail"
5482
+ "anyOf": [
5483
+ {
5484
+ "required": [
5485
+ "cron",
5486
+ "toEmail"
5487
+ ]
5488
+ },
5489
+ {
5490
+ "required": [
5491
+ "cron",
5492
+ "callbackUrl"
5493
+ ]
5494
+ }
5333
5495
  ]
5334
5496
  }
5335
5497
  },
data/schemas/dashboardPost.json CHANGED
@@ -974,6 +974,147 @@
974
974
  ],
975
975
  "additionalProperties": false
976
976
  },
977
+ {
978
+ "type": "object",
979
+ "properties": {
980
+ "id": {
981
+ "type": "string",
982
+ "maxLength": 48
983
+ },
984
+ "title": {
985
+ "type": "string",
986
+ "maxLength": 255
987
+ },
988
+ "description": {
989
+ "type": "string",
990
+ "maxLength": 32767
991
+ },
992
+ "applicationId": {
993
+ "type": "string",
994
+ "pattern": "^[A-Fa-f\\d]{24}$"
995
+ },
996
+ "startX": {
997
+ "type": "number"
998
+ },
999
+ "startY": {
1000
+ "type": "number"
1001
+ },
1002
+ "width": {
1003
+ "type": "number"
1004
+ },
1005
+ "height": {
1006
+ "type": "number"
1007
+ },
1008
+ "blockType": {
1009
+ "type": "string",
1010
+ "enum": [
1011
+ "device-count"
1012
+ ]
1013
+ },
1014
+ "config": {
1015
+ "type": "object",
1016
+ "properties": {
1017
+ "segments": {
1018
+ "type": "array",
1019
+ "minItems": 1,
1020
+ "maxItems": 100,
1021
+ "items": {
1022
+ "type": "object",
1023
+ "properties": {
1024
+ "id": {
1025
+ "type": "string",
1026
+ "maxLength": 48
1027
+ },
1028
+ "query": {
1029
+ "type": "string",
1030
+ "maxLength": 32767
1031
+ }
1032
+ },
1033
+ "required": [
1034
+ "id",
1035
+ "query"
1036
+ ],
1037
+ "additionalProperties": false
1038
+ }
1039
+ },
1040
+ "conditions": {
1041
+ "type": "array",
1042
+ "maxItems": 100,
1043
+ "items": {
1044
+ "type": "object",
1045
+ "properties": {
1046
+ "color": {
1047
+ "type": "string",
1048
+ "maxLength": 64
1049
+ },
1050
+ "id": {
1051
+ "type": "string",
1052
+ "maxLength": 48
1053
+ },
1054
+ "label": {
1055
+ "type": "string",
1056
+ "maxLength": 32767
1057
+ },
1058
+ "condition": {
1059
+ "type": "string",
1060
+ "maxLength": 2048
1061
+ },
1062
+ "imageUrl": {
1063
+ "type": "string",
1064
+ "maxLength": 32767
1065
+ },
1066
+ "shape": {
1067
+ "type": "string",
1068
+ "enum": [
1069
+ "circle",
1070
+ "square",
1071
+ "triangle-down",
1072
+ "triangle-up",
1073
+ "octagon"
1074
+ ]
1075
+ }
1076
+ },
1077
+ "additionalProperties": false
1078
+ }
1079
+ },
1080
+ "defaultCondition": {
1081
+ "type": "object",
1082
+ "properties": {
1083
+ "color": {
1084
+ "type": "string",
1085
+ "maxLength": 64
1086
+ },
1087
+ "label": {
1088
+ "type": "string",
1089
+ "maxLength": 32767
1090
+ },
1091
+ "value": {
1092
+ "type": "string",
1093
+ "maxLength": 32767
1094
+ }
1095
+ },
1096
+ "required": [
1097
+ "color"
1098
+ ],
1099
+ "additionalProperties": false
1100
+ }
1101
+ },
1102
+ "required": [
1103
+ "segments",
1104
+ "defaultCondition"
1105
+ ],
1106
+ "additionalProperties": false
1107
+ }
1108
+ },
1109
+ "required": [
1110
+ "blockType",
1111
+ "startX",
1112
+ "startY",
1113
+ "width",
1114
+ "height"
1115
+ ],
1116
+ "additionalProperties": false
1117
+ },
977
1118
  {
978
1119
  "type": "object",
979
1120
  "properties": {
@@ -5326,6 +5467,11 @@
5326
5467
  "maxLength": 1024
5327
5468
  }
5328
5469
  },
5470
+ "callbackUrl": {
5471
+ "type": "string",
5472
+ "format": "uri",
5473
+ "maxLength": 1024
5474
+ },
5329
5475
  "subject": {
5330
5476
  "type": "string",
5331
5477
  "maxLength": 255
@@ -5348,12 +5494,28 @@
5348
5494
  "locale": {
5349
5495
  "type": "string",
5350
5496
  "maxLength": 5
5497
+ },
5498
+ "ctx": {
5499
+ "ref": "#/definitions/dashboardContextInstance"
5500
+ },
5501
+ "branded": {
5502
+ "type": "boolean"
5351
5503
  }
5352
5504
  },
5353
5505
  "additionalProperties": false,
5354
- "required": [
5355
- "cron",
5356
- "toEmail"
5506
+ "anyOf": [
5507
+ {
5508
+ "required": [
5509
+ "cron",
5510
+ "toEmail"
5511
+ ]
5512
+ },
5513
+ {
5514
+ "required": [
5515
+ "cron",
5516
+ "callbackUrl"
5517
+ ]
5518
+ }
5357
5519
  ]
5358
5520
  }
5359
5521
  },
data/schemas/dashboardSendReport.json CHANGED
@@ -1,9 +1,6 @@
1
1
  {
2
2
  "$schema": "http://json-schema.org/draft-04/schema#",
3
3
  "type": "object",
4
- "required": [
5
- "toEmail"
6
- ],
7
4
  "properties": {
8
5
  "toEmail": {
9
6
  "type": "array",
@@ -15,6 +12,11 @@
15
12
  "maxLength": 1024
16
13
  }
17
14
  },
15
+ "callbackUrl": {
16
+ "type": "string",
17
+ "format": "uri",
18
+ "maxLength": 1024
19
+ },
18
20
  "subject": {
19
21
  "type": "string",
20
22
  "maxLength": 255
@@ -40,7 +42,25 @@
40
42
  "locale": {
41
43
  "type": "string",
42
44
  "maxLength": 5
45
+ },
46
+ "ctx": {
47
+ "ref": "#/definitions/dashboardContextInstance"
48
+ },
49
+ "branded": {
50
+ "type": "boolean"
43
51
  }
44
52
  },
53
+ "anyOf": [
54
+ {
55
+ "required": [
56
+ "toEmail"
57
+ ]
58
+ },
59
+ {
60
+ "required": [
61
+ "callbackUrl"
62
+ ]
63
+ }
64
+ ],
45
65
  "additionalProperties": false
46
66
  }