losant_rest 1.15.1 → 1.16.1

Sign up to get free protection for your applications and to get access to all the features.
Files changed (152) hide show
  1. checksums.yaml +4 -4
  2. data/LICENSE +1 -1
  3. data/docs/_schemas.md +12170 -4718
  4. data/docs/application.md +3 -4
  5. data/docs/applicationDashboard.md +43 -0
  6. data/docs/applications.md +3 -2
  7. data/docs/devices.md +40 -0
  8. data/docs/flows.md +38 -0
  9. data/docs/instanceCustomNode.md +222 -0
  10. data/docs/instanceCustomNodes.md +91 -0
  11. data/lib/losant_rest/application.rb +1 -1
  12. data/lib/losant_rest/application_api_token.rb +1 -1
  13. data/lib/losant_rest/application_api_tokens.rb +1 -1
  14. data/lib/losant_rest/application_certificate.rb +1 -1
  15. data/lib/losant_rest/application_certificate_authorities.rb +1 -1
  16. data/lib/losant_rest/application_certificate_authority.rb +1 -1
  17. data/lib/losant_rest/application_certificates.rb +1 -1
  18. data/lib/losant_rest/application_dashboard.rb +50 -1
  19. data/lib/losant_rest/application_dashboards.rb +1 -1
  20. data/lib/losant_rest/application_key.rb +1 -1
  21. data/lib/losant_rest/application_keys.rb +1 -1
  22. data/lib/losant_rest/application_template.rb +1 -1
  23. data/lib/losant_rest/application_templates.rb +1 -1
  24. data/lib/losant_rest/applications.rb +1 -1
  25. data/lib/losant_rest/audit_log.rb +1 -1
  26. data/lib/losant_rest/audit_logs.rb +1 -1
  27. data/lib/losant_rest/auth.rb +1 -1
  28. data/lib/losant_rest/client.rb +11 -3
  29. data/lib/losant_rest/dashboard.rb +1 -1
  30. data/lib/losant_rest/dashboards.rb +1 -1
  31. data/lib/losant_rest/data.rb +1 -1
  32. data/lib/losant_rest/data_table.rb +1 -1
  33. data/lib/losant_rest/data_table_row.rb +1 -1
  34. data/lib/losant_rest/data_table_rows.rb +1 -1
  35. data/lib/losant_rest/data_tables.rb +1 -1
  36. data/lib/losant_rest/device.rb +1 -1
  37. data/lib/losant_rest/device_recipe.rb +1 -1
  38. data/lib/losant_rest/device_recipes.rb +1 -1
  39. data/lib/losant_rest/devices.rb +50 -1
  40. data/lib/losant_rest/edge_deployment.rb +1 -1
  41. data/lib/losant_rest/edge_deployments.rb +1 -1
  42. data/lib/losant_rest/embedded_deployment.rb +1 -1
  43. data/lib/losant_rest/embedded_deployments.rb +1 -1
  44. data/lib/losant_rest/error.rb +1 -1
  45. data/lib/losant_rest/event.rb +1 -1
  46. data/lib/losant_rest/events.rb +1 -1
  47. data/lib/losant_rest/experience.rb +1 -1
  48. data/lib/losant_rest/experience_domain.rb +1 -1
  49. data/lib/losant_rest/experience_domains.rb +1 -1
  50. data/lib/losant_rest/experience_endpoint.rb +1 -1
  51. data/lib/losant_rest/experience_endpoints.rb +1 -1
  52. data/lib/losant_rest/experience_group.rb +1 -1
  53. data/lib/losant_rest/experience_groups.rb +1 -1
  54. data/lib/losant_rest/experience_slug.rb +1 -1
  55. data/lib/losant_rest/experience_slugs.rb +1 -1
  56. data/lib/losant_rest/experience_user.rb +1 -1
  57. data/lib/losant_rest/experience_users.rb +1 -1
  58. data/lib/losant_rest/experience_version.rb +1 -1
  59. data/lib/losant_rest/experience_versions.rb +1 -1
  60. data/lib/losant_rest/experience_view.rb +1 -1
  61. data/lib/losant_rest/experience_views.rb +1 -1
  62. data/lib/losant_rest/file.rb +1 -1
  63. data/lib/losant_rest/files.rb +1 -1
  64. data/lib/losant_rest/flow.rb +1 -1
  65. data/lib/losant_rest/flow_version.rb +1 -1
  66. data/lib/losant_rest/flow_versions.rb +1 -1
  67. data/lib/losant_rest/flows.rb +45 -1
  68. data/lib/losant_rest/instance.rb +1 -1
  69. data/lib/losant_rest/instance_api_token.rb +1 -1
  70. data/lib/losant_rest/instance_api_tokens.rb +1 -1
  71. data/lib/losant_rest/instance_custom_node.rb +282 -0
  72. data/lib/losant_rest/instance_custom_nodes.rb +136 -0
  73. data/lib/losant_rest/instance_member.rb +1 -1
  74. data/lib/losant_rest/instance_members.rb +1 -1
  75. data/lib/losant_rest/instance_org.rb +1 -1
  76. data/lib/losant_rest/instance_org_invite.rb +1 -1
  77. data/lib/losant_rest/instance_org_invites.rb +1 -1
  78. data/lib/losant_rest/instance_org_member.rb +1 -1
  79. data/lib/losant_rest/instance_org_members.rb +1 -1
  80. data/lib/losant_rest/instance_orgs.rb +1 -1
  81. data/lib/losant_rest/instances.rb +1 -1
  82. data/lib/losant_rest/integration.rb +1 -1
  83. data/lib/losant_rest/integrations.rb +1 -1
  84. data/lib/losant_rest/me.rb +1 -1
  85. data/lib/losant_rest/notebook.rb +1 -1
  86. data/lib/losant_rest/notebooks.rb +1 -1
  87. data/lib/losant_rest/org.rb +1 -1
  88. data/lib/losant_rest/org_invites.rb +1 -1
  89. data/lib/losant_rest/orgs.rb +1 -1
  90. data/lib/losant_rest/user_api_token.rb +1 -1
  91. data/lib/losant_rest/user_api_tokens.rb +1 -1
  92. data/lib/losant_rest/utils.rb +1 -1
  93. data/lib/losant_rest/version.rb +2 -2
  94. data/lib/losant_rest/webhook.rb +1 -1
  95. data/lib/losant_rest/webhooks.rb +1 -1
  96. data/lib/losant_rest.rb +3 -1
  97. data/schemas/apiTokenPost.json +13 -1
  98. data/schemas/application.json +1 -1
  99. data/schemas/applicationApplyTemplatePatch.json +5 -0
  100. data/schemas/applicationClonePost.json +5 -0
  101. data/schemas/applicationCreationByTemplateResult.json +1 -1
  102. data/schemas/applicationDashboardPost.json +162 -3
  103. data/schemas/applicationExportPost.json +4 -0
  104. data/schemas/applicationImportOptions.json +43 -0
  105. data/schemas/applicationPatch.json +1 -1
  106. data/schemas/applicationPost.json +1 -1
  107. data/schemas/applications.json +1 -1
  108. data/schemas/dashboard.json +162 -3
  109. data/schemas/dashboardPatch.json +162 -3
  110. data/schemas/dashboardPost.json +162 -3
  111. data/schemas/dashboardSendReport.json +20 -3
  112. data/schemas/dashboards.json +162 -3
  113. data/schemas/deviceNamesResponse.json +36 -0
  114. data/schemas/experienceBootstrapOptions.json +1 -1
  115. data/schemas/experienceLinkedResources.json +485 -5
  116. data/schemas/experienceSlug.json +1 -1
  117. data/schemas/experienceSlugPatch.json +1 -1
  118. data/schemas/experienceSlugPost.json +1 -1
  119. data/schemas/experienceSlugs.json +1 -1
  120. data/schemas/experienceUser.json +2 -1
  121. data/schemas/experienceUsers.json +2 -1
  122. data/schemas/flow.json +173 -0
  123. data/schemas/flowPatch.json +174 -0
  124. data/schemas/flowPost.json +174 -0
  125. data/schemas/flowVersion.json +312 -5
  126. data/schemas/flowVersionPost.json +156 -0
  127. data/schemas/flowVersions.json +312 -5
  128. data/schemas/flows.json +173 -0
  129. data/schemas/flowsImportPost.json +339 -2
  130. data/schemas/flowsImportResult.json +485 -5
  131. data/schemas/githubLogin.json +13 -1
  132. data/schemas/instanceCustomNode.json +589 -0
  133. data/schemas/instanceCustomNodePatch.json +674 -0
  134. data/schemas/instanceCustomNodePost.json +679 -0
  135. data/schemas/instanceCustomNodes.json +634 -0
  136. data/schemas/instanceMember.json +2 -2
  137. data/schemas/instanceMembers.json +2 -2
  138. data/schemas/instanceOrg.json +8 -0
  139. data/schemas/instanceOrgMember.json +2 -2
  140. data/schemas/instanceOrgs.json +8 -0
  141. data/schemas/integration.json +30 -2
  142. data/schemas/integrationPatch.json +30 -2
  143. data/schemas/integrationPost.json +30 -2
  144. data/schemas/integrations.json +30 -2
  145. data/schemas/me.json +2 -2
  146. data/schemas/mePatch.json +0 -1
  147. data/schemas/org.json +2 -2
  148. data/schemas/orgs.json +2 -2
  149. data/schemas/paletteResponse.json +785 -0
  150. data/schemas/userCredentials.json +13 -1
  151. data/schemas/userPost.json +13 -2
  152. metadata +13 -2
@@ -116,6 +116,7 @@
116
116
  "applicationCertificateAuthorities.post",
117
117
  "applicationDashboard.get",
118
118
  "applicationDashboard.patch",
119
+ "applicationDashboard.sendReport",
119
120
  "applicationDashboard.delete",
120
121
  "applicationDashboards.get",
121
122
  "applicationDashboards.post",
@@ -170,6 +171,7 @@
170
171
  "devices.delete",
171
172
  "devices.removeData",
172
173
  "devices.detailedSummary",
174
+ "devices.deviceNames",
173
175
  "devices.export",
174
176
  "devices.get",
175
177
  "devices.payloadCounts",
@@ -264,6 +266,7 @@
264
266
  "flows.get",
265
267
  "flows.getByVersion",
266
268
  "flows.import",
269
+ "flows.palette",
267
270
  "flows.post",
268
271
  "flowVersion.delete",
269
272
  "flowVersion.errors",
@@ -378,7 +381,16 @@
378
381
  "instanceApiToken.*",
379
382
  "instanceApiToken.get",
380
383
  "instanceApiToken.patch",
381
- "instanceApiToken.delete"
384
+ "instanceApiToken.delete",
385
+ "instanceCustomNodes.*",
386
+ "instanceCustomNodes.get",
387
+ "instanceCustomNodes.post",
388
+ "instanceCustomNode.*",
389
+ "instanceCustomNode.get",
390
+ "instanceCustomNode.patch",
391
+ "instanceCustomNode.delete",
392
+ "instanceCustomNode.errors",
393
+ "instanceCustomNode.stats"
382
394
  ]
383
395
  },
384
396
  {
@@ -57,7 +57,7 @@
57
57
  },
58
58
  "endpointSlug": {
59
59
  "type": "string",
60
- "minLength": 4,
60
+ "minLength": 3,
61
61
  "maxLength": 63,
62
62
  "pattern": "^[0-9a-z-]*$"
63
63
  },
@@ -10,6 +10,11 @@
10
10
  "type": "string",
11
11
  "format": "email",
12
12
  "maxLength": 1024
13
+ },
14
+ "callbackUrl": {
15
+ "type": "string",
16
+ "format": "uri",
17
+ "maxLength": 1024
13
18
  }
14
19
  },
15
20
  "required": [
@@ -40,6 +40,11 @@
40
40
  "type": "string",
41
41
  "format": "email",
42
42
  "maxLength": 1024
43
+ },
44
+ "callbackUrl": {
45
+ "type": "string",
46
+ "format": "uri",
47
+ "maxLength": 1024
43
48
  }
44
49
  },
45
50
  "additionalProperties": false
@@ -62,7 +62,7 @@
62
62
  },
63
63
  "endpointSlug": {
64
64
  "type": "string",
65
- "minLength": 4,
65
+ "minLength": 3,
66
66
  "maxLength": 63,
67
67
  "pattern": "^[0-9a-z-]*$"
68
68
  },
@@ -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": {
@@ -5318,6 +5459,11 @@
5318
5459
  "maxLength": 1024
5319
5460
  }
5320
5461
  },
5462
+ "callbackUrl": {
5463
+ "type": "string",
5464
+ "format": "uri",
5465
+ "maxLength": 1024
5466
+ },
5321
5467
  "subject": {
5322
5468
  "type": "string",
5323
5469
  "maxLength": 255
@@ -5340,12 +5486,25 @@
5340
5486
  "locale": {
5341
5487
  "type": "string",
5342
5488
  "maxLength": 5
5489
+ },
5490
+ "ctx": {
5491
+ "ref": "#/definitions/dashboardContextInstance"
5343
5492
  }
5344
5493
  },
5345
5494
  "additionalProperties": false,
5346
- "required": [
5347
- "cron",
5348
- "toEmail"
5495
+ "anyOf": [
5496
+ {
5497
+ "required": [
5498
+ "cron",
5499
+ "toEmail"
5500
+ ]
5501
+ },
5502
+ {
5503
+ "required": [
5504
+ "cron",
5505
+ "callbackUrl"
5506
+ ]
5507
+ }
5349
5508
  ]
5350
5509
  }
5351
5510
  },
@@ -18,6 +18,10 @@
18
18
  "type": "string",
19
19
  "format": "email",
20
20
  "maxLength": 1024
21
+ },
22
+ "callbackUrl": {
23
+ "type": "string",
24
+ "maxLength": 1024
21
25
  }
22
26
  },
23
27
  "additionalProperties": false
@@ -0,0 +1,43 @@
1
+ {
2
+ "$schema": "http://json-schema.org/draft-04/schema#",
3
+ "type": "object",
4
+ "properties": {
5
+ "importUrl": {
6
+ "type": "string",
7
+ "format": "uri",
8
+ "maxLength": 1024
9
+ },
10
+ "callbackUrl": {
11
+ "type": "string",
12
+ "format": "uri",
13
+ "maxLength": 1024
14
+ },
15
+ "include": {
16
+ "type": "array",
17
+ "items": {
18
+ "enum": [
19
+ "ApplicationCertificateAuthority",
20
+ "Dashboard",
21
+ "DataTableRow",
22
+ "DataTable",
23
+ "DeviceRecipe",
24
+ "Device",
25
+ "ExperienceEndpoint",
26
+ "ExperienceFlowVersion",
27
+ "ExperienceGroup",
28
+ "ExperienceUser",
29
+ "ExperienceVersion",
30
+ "ExperienceView",
31
+ "File",
32
+ "FlowVersion",
33
+ "Flow",
34
+ "Integration",
35
+ "Notebook",
36
+ "Webhook"
37
+ ]
38
+ },
39
+ "uniqueItems": true
40
+ }
41
+ },
42
+ "additionalProperties": false
43
+ }
@@ -13,7 +13,7 @@
13
13
  },
14
14
  "endpointSlug": {
15
15
  "type": "string",
16
- "minLength": 4,
16
+ "minLength": 3,
17
17
  "maxLength": 63,
18
18
  "pattern": "^[0-9a-z-]*$"
19
19
  },
@@ -29,7 +29,7 @@
29
29
  },
30
30
  "endpointSlug": {
31
31
  "type": "string",
32
- "minLength": 4,
32
+ "minLength": 3,
33
33
  "maxLength": 63,
34
34
  "pattern": "^[0-9a-z-]*$"
35
35
  },
@@ -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
  },
@@ -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,25 @@
120
125
  "locale": {
121
126
  "type": "string",
122
127
  "maxLength": 5
128
+ },
129
+ "ctx": {
130
+ "ref": "#/definitions/dashboardContextInstance"
123
131
  }
124
132
  },
125
133
  "additionalProperties": false,
126
- "required": [
127
- "cron",
128
- "toEmail"
134
+ "anyOf": [
135
+ {
136
+ "required": [
137
+ "cron",
138
+ "toEmail"
139
+ ]
140
+ },
141
+ {
142
+ "required": [
143
+ "cron",
144
+ "callbackUrl"
145
+ ]
146
+ }
129
147
  ]
130
148
  }
131
149
  },
@@ -1088,6 +1106,147 @@
1088
1106
  ],
1089
1107
  "additionalProperties": false
1090
1108
  },
1109
+ {
1110
+ "type": "object",
1111
+ "properties": {
1112
+ "id": {
1113
+ "type": "string",
1114
+ "maxLength": 48
1115
+ },
1116
+ "title": {
1117
+ "type": "string",
1118
+ "maxLength": 255
1119
+ },
1120
+ "description": {
1121
+ "type": "string",
1122
+ "maxLength": 32767
1123
+ },
1124
+ "applicationId": {
1125
+ "type": "string",
1126
+ "pattern": "^[A-Fa-f\\d]{24}$"
1127
+ },
1128
+ "startX": {
1129
+ "type": "number"
1130
+ },
1131
+ "startY": {
1132
+ "type": "number"
1133
+ },
1134
+ "width": {
1135
+ "type": "number"
1136
+ },
1137
+ "height": {
1138
+ "type": "number"
1139
+ },
1140
+ "blockType": {
1141
+ "type": "string",
1142
+ "enum": [
1143
+ "device-count"
1144
+ ]
1145
+ },
1146
+ "config": {
1147
+ "type": "object",
1148
+ "properties": {
1149
+ "segments": {
1150
+ "type": "array",
1151
+ "minItems": 1,
1152
+ "maxItems": 100,
1153
+ "items": {
1154
+ "type": "object",
1155
+ "properties": {
1156
+ "id": {
1157
+ "type": "string",
1158
+ "maxLength": 48
1159
+ },
1160
+ "query": {
1161
+ "type": "string",
1162
+ "maxLength": 32767
1163
+ }
1164
+ },
1165
+ "required": [
1166
+ "id",
1167
+ "query"
1168
+ ],
1169
+ "additionalProperties": false
1170
+ }
1171
+ },
1172
+ "conditions": {
1173
+ "type": "array",
1174
+ "maxItems": 100,
1175
+ "items": {
1176
+ "type": "object",
1177
+ "properties": {
1178
+ "color": {
1179
+ "type": "string",
1180
+ "maxLength": 64
1181
+ },
1182
+ "id": {
1183
+ "type": "string",
1184
+ "maxLength": 48
1185
+ },
1186
+ "label": {
1187
+ "type": "string",
1188
+ "maxLength": 32767
1189
+ },
1190
+ "condition": {
1191
+ "type": "string",
1192
+ "maxLength": 2048
1193
+ },
1194
+ "imageUrl": {
1195
+ "type": "string",
1196
+ "maxLength": 32767
1197
+ },
1198
+ "shape": {
1199
+ "type": "string",
1200
+ "enum": [
1201
+ "circle",
1202
+ "square",
1203
+ "triangle-down",
1204
+ "triangle-up",
1205
+ "octagon"
1206
+ ]
1207
+ }
1208
+ },
1209
+ "additionalProperties": false
1210
+ }
1211
+ },
1212
+ "defaultCondition": {
1213
+ "type": "object",
1214
+ "properties": {
1215
+ "color": {
1216
+ "type": "string",
1217
+ "maxLength": 64
1218
+ },
1219
+ "label": {
1220
+ "type": "string",
1221
+ "maxLength": 32767
1222
+ },
1223
+ "value": {
1224
+ "type": "string",
1225
+ "maxLength": 32767
1226
+ }
1227
+ },
1228
+ "required": [
1229
+ "color"
1230
+ ],
1231
+ "additionalProperties": false
1232
+ }
1233
+ },
1234
+ "required": [
1235
+ "segments",
1236
+ "defaultCondition"
1237
+ ],
1238
+ "additionalProperties": false
1239
+ }
1240
+ },
1241
+ "required": [
1242
+ "blockType",
1243
+ "startX",
1244
+ "startY",
1245
+ "width",
1246
+ "height"
1247
+ ],
1248
+ "additionalProperties": false
1249
+ },
1091
1250
  {
1092
1251
  "type": "object",
1093
1252
  "properties": {