losant_rest 1.14.1 → 1.15.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (77) hide show
  1. checksums.yaml +4 -4
  2. data/docs/_schemas.md +4268 -1402
  3. data/docs/embeddedDeployment.md +49 -0
  4. data/docs/embeddedDeployments.md +215 -0
  5. data/docs/flow.md +2 -2
  6. data/docs/flows.md +2 -2
  7. data/lib/losant_rest/client.rb +10 -2
  8. data/lib/losant_rest/embedded_deployment.rb +81 -0
  9. data/lib/losant_rest/embedded_deployments.rb +280 -0
  10. data/lib/losant_rest/flow.rb +2 -2
  11. data/lib/losant_rest/flows.rb +2 -2
  12. data/lib/losant_rest/version.rb +1 -1
  13. data/lib/losant_rest.rb +2 -0
  14. data/schemas/apiTokenPost.json +8 -0
  15. data/schemas/application.json +32 -32
  16. data/schemas/applicationCreationByTemplateResult.json +32 -32
  17. data/schemas/applicationDashboardPost.json +8 -5
  18. data/schemas/applicationPatch.json +13 -13
  19. data/schemas/applicationPost.json +13 -13
  20. data/schemas/applicationTemplate.json +16 -16
  21. data/schemas/applicationTemplates.json +16 -16
  22. data/schemas/applications.json +32 -32
  23. data/schemas/authedDevice.json +2 -1
  24. data/schemas/dashboard.json +8 -5
  25. data/schemas/dashboardPatch.json +8 -5
  26. data/schemas/dashboardPost.json +8 -5
  27. data/schemas/dashboardSendReport.json +6 -6
  28. data/schemas/dashboards.json +8 -5
  29. data/schemas/device.json +2 -1
  30. data/schemas/deviceClassFilter.json +4 -2
  31. data/schemas/devicePatch.json +2 -1
  32. data/schemas/devicePost.json +2 -1
  33. data/schemas/deviceRecipe.json +2 -1
  34. data/schemas/deviceRecipePatch.json +2 -1
  35. data/schemas/deviceRecipePost.json +2 -1
  36. data/schemas/deviceRecipes.json +2 -1
  37. data/schemas/devices.json +4 -2
  38. data/schemas/devicesPatch.json +4 -2
  39. data/schemas/edgeDeployment.json +4 -0
  40. data/schemas/edgeDeployments.json +4 -0
  41. data/schemas/embeddedDeployment.json +179 -0
  42. data/schemas/embeddedDeploymentExport.json +44 -0
  43. data/schemas/embeddedDeploymentRelease.json +58 -0
  44. data/schemas/embeddedDeploymentRemove.json +25 -0
  45. data/schemas/embeddedDeploymentReplace.json +29 -0
  46. data/schemas/embeddedDeployments.json +212 -0
  47. data/schemas/experienceEndpoint.json +6 -8
  48. data/schemas/experienceEndpointPatch.json +6 -8
  49. data/schemas/experienceEndpointPost.json +6 -8
  50. data/schemas/experienceEndpoints.json +6 -8
  51. data/schemas/experienceLinkedResources.json +387 -57
  52. data/schemas/flow.json +127 -16
  53. data/schemas/flowPatch.json +126 -16
  54. data/schemas/flowPost.json +127 -16
  55. data/schemas/flowVersion.json +253 -33
  56. data/schemas/flowVersionPost.json +126 -16
  57. data/schemas/flowVersions.json +253 -33
  58. data/schemas/flows.json +128 -16
  59. data/schemas/flowsImportPost.json +253 -32
  60. data/schemas/flowsImportResult.json +380 -49
  61. data/schemas/githubLogin.json +8 -0
  62. data/schemas/historicalSummary.json +87 -74
  63. data/schemas/instance.json +92 -79
  64. data/schemas/instanceMember.json +6 -0
  65. data/schemas/instanceMembers.json +6 -0
  66. data/schemas/instanceOrg.json +87 -74
  67. data/schemas/instanceOrgMember.json +6 -0
  68. data/schemas/instanceOrgPatch.json +64 -26
  69. data/schemas/instanceOrgPost.json +65 -27
  70. data/schemas/instanceOrgs.json +87 -74
  71. data/schemas/instancePatch.json +2 -2
  72. data/schemas/me.json +104 -91
  73. data/schemas/org.json +115 -96
  74. data/schemas/orgs.json +115 -96
  75. data/schemas/userCredentials.json +8 -0
  76. data/schemas/userPost.json +8 -0
  77. metadata +16 -6
data/schemas/applicationDashboardPost.json CHANGED
@@ -3035,8 +3035,8 @@
3035
3035
  },
3036
3036
  "length": {
3037
3037
  "type": "integer",
3038
- "min": 1,
3039
- "max": 10
3038
+ "minimum": 1,
3039
+ "maximum": 10
3040
3040
  },
3041
3041
  "orientation": {
3042
3042
  "type": "string",
@@ -5251,6 +5251,9 @@
5251
5251
  "includeEdge": {
5252
5252
  "type": "boolean"
5253
5253
  },
5254
+ "includeEmbedded": {
5255
+ "type": "boolean"
5256
+ },
5254
5257
  "includeExperience": {
5255
5258
  "type": "boolean"
5256
5259
  },
@@ -5293,7 +5296,7 @@
5293
5296
  },
5294
5297
  "reportConfigs": {
5295
5298
  "type": "array",
5296
- "max": 10,
5299
+ "maxItems": 10,
5297
5300
  "items": {
5298
5301
  "type": "object",
5299
5302
  "properties": {
@@ -5307,8 +5310,8 @@
5307
5310
  },
5308
5311
  "toEmail": {
5309
5312
  "type": "array",
5310
- "min": 1,
5311
- "max": 10,
5313
+ "minItems": 1,
5314
+ "maxItems": 10,
5312
5315
  "items": {
5313
5316
  "type": "string",
5314
5317
  "format": "email",
data/schemas/applicationPatch.json CHANGED
@@ -89,7 +89,7 @@
89
89
  "properties": {
90
90
  "directory": {
91
91
  "type": "string",
92
- "max": 255
92
+ "maxLength": 255
93
93
  },
94
94
  "mode": {
95
95
  "type": "string",
@@ -159,21 +159,21 @@
159
159
  "properties": {
160
160
  "bucket": {
161
161
  "type": "string",
162
- "max": 255
162
+ "maxLength": 255
163
163
  },
164
164
  "accessKeyId": {
165
165
  "type": "string",
166
- "min": 4,
167
- "max": 128
166
+ "minLength": 4,
167
+ "maxLength": 128
168
168
  },
169
169
  "secretAccessKey": {
170
170
  "type": "string",
171
- "min": 4,
172
- "max": 128
171
+ "minLength": 4,
172
+ "maxLength": 128
173
173
  },
174
174
  "region": {
175
175
  "type": "string",
176
- "max": 128
176
+ "maxLength": 128
177
177
  }
178
178
  },
179
179
  "required": [
@@ -199,7 +199,7 @@
199
199
  },
200
200
  "bucket": {
201
201
  "type": "string",
202
- "max": 255
202
+ "maxLength": 255
203
203
  }
204
204
  },
205
205
  "required": [
@@ -214,17 +214,17 @@
214
214
  "properties": {
215
215
  "account": {
216
216
  "type": "string",
217
- "min": 3,
218
- "max": 24
217
+ "minLength": 3,
218
+ "maxLength": 24
219
219
  },
220
220
  "accountKey": {
221
221
  "type": "string",
222
- "max": 255
222
+ "maxLength": 255
223
223
  },
224
224
  "bucket": {
225
225
  "type": "string",
226
- "min": 3,
227
- "max": 63
226
+ "minLength": 3,
227
+ "maxLength": 63
228
228
  }
229
229
  },
230
230
  "required": [
data/schemas/applicationPost.json CHANGED
@@ -76,7 +76,7 @@
76
76
  "properties": {
77
77
  "directory": {
78
78
  "type": "string",
79
- "max": 255
79
+ "maxLength": 255
80
80
  },
81
81
  "mode": {
82
82
  "type": "string",
@@ -146,21 +146,21 @@
146
146
  "properties": {
147
147
  "bucket": {
148
148
  "type": "string",
149
- "max": 255
149
+ "maxLength": 255
150
150
  },
151
151
  "accessKeyId": {
152
152
  "type": "string",
153
- "min": 4,
154
- "max": 128
153
+ "minLength": 4,
154
+ "maxLength": 128
155
155
  },
156
156
  "secretAccessKey": {
157
157
  "type": "string",
158
- "min": 4,
159
- "max": 128
158
+ "minLength": 4,
159
+ "maxLength": 128
160
160
  },
161
161
  "region": {
162
162
  "type": "string",
163
- "max": 128
163
+ "maxLength": 128
164
164
  }
165
165
  },
166
166
  "required": [
@@ -186,7 +186,7 @@
186
186
  },
187
187
  "bucket": {
188
188
  "type": "string",
189
- "max": 255
189
+ "maxLength": 255
190
190
  }
191
191
  },
192
192
  "required": [
@@ -201,17 +201,17 @@
201
201
  "properties": {
202
202
  "account": {
203
203
  "type": "string",
204
- "min": 3,
205
- "max": 24
204
+ "minLength": 3,
205
+ "maxLength": 24
206
206
  },
207
207
  "accountKey": {
208
208
  "type": "string",
209
- "max": 255
209
+ "maxLength": 255
210
210
  },
211
211
  "bucket": {
212
212
  "type": "string",
213
- "min": 3,
214
- "max": 63
213
+ "minLength": 3,
214
+ "maxLength": 63
215
215
  }
216
216
  },
217
217
  "required": [
data/schemas/applicationTemplate.json CHANGED
@@ -66,52 +66,52 @@
66
66
  "type": "object",
67
67
  "properties": {
68
68
  "applicationCertificateAuthorityCount": {
69
- "type": "number"
69
+ "type": "integer"
70
70
  },
71
71
  "dashboardCount": {
72
- "type": "number"
72
+ "type": "integer"
73
73
  },
74
74
  "deviceCount": {
75
- "type": "number"
75
+ "type": "integer"
76
76
  },
77
77
  "deviceRecipeCount": {
78
- "type": "number"
78
+ "type": "integer"
79
79
  },
80
80
  "dataTableCount": {
81
- "type": "number"
81
+ "type": "integer"
82
82
  },
83
83
  "experienceGroupCount": {
84
- "type": "number"
84
+ "type": "integer"
85
85
  },
86
86
  "experienceUserCount": {
87
- "type": "number"
87
+ "type": "integer"
88
88
  },
89
89
  "experienceVersionCount": {
90
- "type": "number"
90
+ "type": "integer"
91
91
  },
92
92
  "experienceViewCount": {
93
- "type": "number"
93
+ "type": "integer"
94
94
  },
95
95
  "experienceEndpointCount": {
96
- "type": "number"
96
+ "type": "integer"
97
97
  },
98
98
  "fileCount": {
99
- "type": "number"
99
+ "type": "integer"
100
100
  },
101
101
  "flowCount": {
102
- "type": "number"
102
+ "type": "integer"
103
103
  },
104
104
  "integrationCount": {
105
- "type": "number"
105
+ "type": "integer"
106
106
  },
107
107
  "notebookCount": {
108
- "type": "number"
108
+ "type": "integer"
109
109
  },
110
110
  "dataTableCsvSize": {
111
- "type": "number"
111
+ "type": "integer"
112
112
  },
113
113
  "webhookCount": {
114
- "type": "number"
114
+ "type": "integer"
115
115
  }
116
116
  }
117
117
  }
data/schemas/applicationTemplates.json CHANGED
@@ -73,52 +73,52 @@
73
73
  "type": "object",
74
74
  "properties": {
75
75
  "applicationCertificateAuthorityCount": {
76
- "type": "number"
76
+ "type": "integer"
77
77
  },
78
78
  "dashboardCount": {
79
- "type": "number"
79
+ "type": "integer"
80
80
  },
81
81
  "deviceCount": {
82
- "type": "number"
82
+ "type": "integer"
83
83
  },
84
84
  "deviceRecipeCount": {
85
- "type": "number"
85
+ "type": "integer"
86
86
  },
87
87
  "dataTableCount": {
88
- "type": "number"
88
+ "type": "integer"
89
89
  },
90
90
  "experienceGroupCount": {
91
- "type": "number"
91
+ "type": "integer"
92
92
  },
93
93
  "experienceUserCount": {
94
- "type": "number"
94
+ "type": "integer"
95
95
  },
96
96
  "experienceVersionCount": {
97
- "type": "number"
97
+ "type": "integer"
98
98
  },
99
99
  "experienceViewCount": {
100
- "type": "number"
100
+ "type": "integer"
101
101
  },
102
102
  "experienceEndpointCount": {
103
- "type": "number"
103
+ "type": "integer"
104
104
  },
105
105
  "fileCount": {
106
- "type": "number"
106
+ "type": "integer"
107
107
  },
108
108
  "flowCount": {
109
- "type": "number"
109
+ "type": "integer"
110
110
  },
111
111
  "integrationCount": {
112
- "type": "number"
112
+ "type": "integer"
113
113
  },
114
114
  "notebookCount": {
115
- "type": "number"
115
+ "type": "integer"
116
116
  },
117
117
  "dataTableCsvSize": {
118
- "type": "number"
118
+ "type": "integer"
119
119
  },
120
120
  "webhookCount": {
121
- "type": "number"
121
+ "type": "integer"
122
122
  }
123
123
  }
124
124
  }
data/schemas/applications.json CHANGED
@@ -115,66 +115,66 @@
115
115
  "type": "object",
116
116
  "properties": {
117
117
  "apiTokenCount": {
118
- "type": "number"
118
+ "type": "integer"
119
119
  },
120
120
  "dataTableCount": {
121
- "type": "number"
121
+ "type": "integer"
122
122
  },
123
123
  "deviceCount": {
124
- "type": "number"
124
+ "type": "integer"
125
125
  },
126
126
  "deviceRecipeCount": {
127
- "type": "number"
127
+ "type": "integer"
128
128
  },
129
129
  "eventCount": {
130
- "type": "number"
130
+ "type": "integer"
131
131
  },
132
132
  "experienceDomainCount": {
133
- "type": "number"
133
+ "type": "integer"
134
134
  },
135
135
  "experienceEndpointCount": {
136
- "type": "number"
136
+ "type": "integer"
137
137
  },
138
138
  "experienceGroupCount": {
139
- "type": "number"
139
+ "type": "integer"
140
140
  },
141
141
  "experienceSlugCount": {
142
- "type": "number"
142
+ "type": "integer"
143
143
  },
144
144
  "experienceUserCount": {
145
- "type": "number"
145
+ "type": "integer"
146
146
  },
147
147
  "experienceVersionCount": {
148
- "type": "number"
148
+ "type": "integer"
149
149
  },
150
150
  "experienceViewCount": {
151
- "type": "number"
151
+ "type": "integer"
152
152
  },
153
153
  "fileCount": {
154
- "type": "number"
154
+ "type": "integer"
155
155
  },
156
156
  "flowCount": {
157
- "type": "number"
157
+ "type": "integer"
158
158
  },
159
159
  "integrationCount": {
160
- "type": "number"
160
+ "type": "integer"
161
161
  },
162
162
  "keyCount": {
163
- "type": "number"
163
+ "type": "integer"
164
164
  },
165
165
  "storageStats": {
166
166
  "type": "object",
167
167
  "properties": {
168
168
  "count": {
169
- "type": "number"
169
+ "type": "integer"
170
170
  },
171
171
  "size": {
172
- "type": "number"
172
+ "type": "integer"
173
173
  }
174
174
  }
175
175
  },
176
176
  "webhookCount": {
177
- "type": "number"
177
+ "type": "integer"
178
178
  }
179
179
  }
180
180
  },
@@ -212,7 +212,7 @@
212
212
  "properties": {
213
213
  "directory": {
214
214
  "type": "string",
215
- "max": 255
215
+ "maxLength": 255
216
216
  },
217
217
  "mode": {
218
218
  "type": "string",
@@ -282,21 +282,21 @@
282
282
  "properties": {
283
283
  "bucket": {
284
284
  "type": "string",
285
- "max": 255
285
+ "maxLength": 255
286
286
  },
287
287
  "accessKeyId": {
288
288
  "type": "string",
289
- "min": 4,
290
- "max": 128
289
+ "minLength": 4,
290
+ "maxLength": 128
291
291
  },
292
292
  "secretAccessKey": {
293
293
  "type": "string",
294
- "min": 4,
295
- "max": 128
294
+ "minLength": 4,
295
+ "maxLength": 128
296
296
  },
297
297
  "region": {
298
298
  "type": "string",
299
- "max": 128
299
+ "maxLength": 128
300
300
  }
301
301
  },
302
302
  "required": [
@@ -322,7 +322,7 @@
322
322
  },
323
323
  "bucket": {
324
324
  "type": "string",
325
- "max": 255
325
+ "maxLength": 255
326
326
  }
327
327
  },
328
328
  "required": [
@@ -337,17 +337,17 @@
337
337
  "properties": {
338
338
  "account": {
339
339
  "type": "string",
340
- "min": 3,
341
- "max": 24
340
+ "minLength": 3,
341
+ "maxLength": 24
342
342
  },
343
343
  "accountKey": {
344
344
  "type": "string",
345
- "max": 255
345
+ "maxLength": 255
346
346
  },
347
347
  "bucket": {
348
348
  "type": "string",
349
- "min": 3,
350
- "max": 63
349
+ "minLength": 3,
350
+ "maxLength": 63
351
351
  }
352
352
  },
353
353
  "required": [
data/schemas/authedDevice.json CHANGED
@@ -18,7 +18,8 @@
18
18
  "peripheral",
19
19
  "floating",
20
20
  "edgeCompute",
21
- "system"
21
+ "system",
22
+ "embedded"
22
23
  ]
23
24
  },
24
25
  "token": {
data/schemas/dashboard.json CHANGED
@@ -76,7 +76,7 @@
76
76
  },
77
77
  "reportConfigs": {
78
78
  "type": "array",
79
- "max": 10,
79
+ "maxItems": 10,
80
80
  "items": {
81
81
  "type": "object",
82
82
  "properties": {
@@ -90,8 +90,8 @@
90
90
  },
91
91
  "toEmail": {
92
92
  "type": "array",
93
- "min": 1,
94
- "max": 10,
93
+ "minItems": 1,
94
+ "maxItems": 10,
95
95
  "items": {
96
96
  "type": "string",
97
97
  "format": "email",
@@ -3157,8 +3157,8 @@
3157
3157
  },
3158
3158
  "length": {
3159
3159
  "type": "integer",
3160
- "min": 1,
3161
- "max": 10
3160
+ "minimum": 1,
3161
+ "maximum": 10
3162
3162
  },
3163
3163
  "orientation": {
3164
3164
  "type": "string",
@@ -5373,6 +5373,9 @@
5373
5373
  "includeEdge": {
5374
5374
  "type": "boolean"
5375
5375
  },
5376
+ "includeEmbedded": {
5377
+ "type": "boolean"
5378
+ },
5376
5379
  "includeExperience": {
5377
5380
  "type": "boolean"
5378
5381
  },
data/schemas/dashboardPatch.json CHANGED
@@ -3035,8 +3035,8 @@
3035
3035
  },
3036
3036
  "length": {
3037
3037
  "type": "integer",
3038
- "min": 1,
3039
- "max": 10
3038
+ "minimum": 1,
3039
+ "maximum": 10
3040
3040
  },
3041
3041
  "orientation": {
3042
3042
  "type": "string",
@@ -5251,6 +5251,9 @@
5251
5251
  "includeEdge": {
5252
5252
  "type": "boolean"
5253
5253
  },
5254
+ "includeEmbedded": {
5255
+ "type": "boolean"
5256
+ },
5254
5257
  "includeExperience": {
5255
5258
  "type": "boolean"
5256
5259
  },
@@ -5277,7 +5280,7 @@
5277
5280
  },
5278
5281
  "reportConfigs": {
5279
5282
  "type": "array",
5280
- "max": 10,
5283
+ "maxItems": 10,
5281
5284
  "items": {
5282
5285
  "type": "object",
5283
5286
  "properties": {
@@ -5291,8 +5294,8 @@
5291
5294
  },
5292
5295
  "toEmail": {
5293
5296
  "type": "array",
5294
- "min": 1,
5295
- "max": 10,
5297
+ "minItems": 1,
5298
+ "maxItems": 10,
5296
5299
  "items": {
5297
5300
  "type": "string",
5298
5301
  "format": "email",
data/schemas/dashboardPost.json CHANGED
@@ -3043,8 +3043,8 @@
3043
3043
  },
3044
3044
  "length": {
3045
3045
  "type": "integer",
3046
- "min": 1,
3047
- "max": 10
3046
+ "minimum": 1,
3047
+ "maximum": 10
3048
3048
  },
3049
3049
  "orientation": {
3050
3050
  "type": "string",
@@ -5259,6 +5259,9 @@
5259
5259
  "includeEdge": {
5260
5260
  "type": "boolean"
5261
5261
  },
5262
+ "includeEmbedded": {
5263
+ "type": "boolean"
5264
+ },
5262
5265
  "includeExperience": {
5263
5266
  "type": "boolean"
5264
5267
  },
@@ -5301,7 +5304,7 @@
5301
5304
  },
5302
5305
  "reportConfigs": {
5303
5306
  "type": "array",
5304
- "max": 10,
5307
+ "maxItems": 10,
5305
5308
  "items": {
5306
5309
  "type": "object",
5307
5310
  "properties": {
@@ -5315,8 +5318,8 @@
5315
5318
  },
5316
5319
  "toEmail": {
5317
5320
  "type": "array",
5318
- "min": 1,
5319
- "max": 10,
5321
+ "minItems": 1,
5322
+ "maxItems": 10,
5320
5323
  "items": {
5321
5324
  "type": "string",
5322
5325
  "format": "email",
data/schemas/dashboardSendReport.json CHANGED
@@ -7,8 +7,8 @@
7
7
  "properties": {
8
8
  "toEmail": {
9
9
  "type": "array",
10
- "min": 1,
11
- "max": 10,
10
+ "minItems": 1,
11
+ "maxItems": 10,
12
12
  "items": {
13
13
  "type": "string",
14
14
  "format": "email",
@@ -17,11 +17,11 @@
17
17
  },
18
18
  "subject": {
19
19
  "type": "string",
20
- "max": 255
20
+ "maxLength": 255
21
21
  },
22
22
  "message": {
23
23
  "type": "string",
24
- "max": 32767
24
+ "maxLength": 32767
25
25
  },
26
26
  "theme": {
27
27
  "type": "string",
@@ -35,11 +35,11 @@
35
35
  },
36
36
  "timezone": {
37
37
  "type": "string",
38
- "max": 255
38
+ "maxLength": 255
39
39
  },
40
40
  "locale": {
41
41
  "type": "string",
42
- "max": 5
42
+ "maxLength": 5
43
43
  }
44
44
  },
45
45
  "additionalProperties": false