losant_rest 1.21.3 → 1.22.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (35) hide show
  1. checksums.yaml +4 -4
  2. data/docs/_schemas.md +893 -15
  3. data/docs/deviceAttribute.md +139 -0
  4. data/docs/deviceAttributes.md +96 -0
  5. data/lib/platform_rest/client.rb +10 -2
  6. data/lib/platform_rest/device_attribute.rb +182 -0
  7. data/lib/platform_rest/device_attributes.rb +138 -0
  8. data/lib/platform_rest/version.rb +1 -1
  9. data/lib/platform_rest.rb +2 -0
  10. data/schemas/apiTokenPost.json +7 -0
  11. data/schemas/applicationExportPost.json +29 -0
  12. data/schemas/applicationImportExecutions.json +18 -1
  13. data/schemas/credential.json +39 -1
  14. data/schemas/credentialPatch.json +37 -0
  15. data/schemas/credentialPost.json +54 -1
  16. data/schemas/credentials.json +39 -1
  17. data/schemas/device.json +0 -1
  18. data/schemas/deviceAttribute.json +128 -0
  19. data/schemas/deviceAttributePatch.json +111 -0
  20. data/schemas/deviceAttributePost.json +125 -0
  21. data/schemas/deviceAttributes.json +171 -0
  22. data/schemas/devicePatch.json +0 -1
  23. data/schemas/devicePost.json +0 -1
  24. data/schemas/deviceRecipe.json +0 -1
  25. data/schemas/deviceRecipePatch.json +0 -1
  26. data/schemas/deviceRecipePost.json +0 -1
  27. data/schemas/deviceRecipes.json +0 -1
  28. data/schemas/devices.json +0 -1
  29. data/schemas/devicesPatch.json +0 -3
  30. data/schemas/githubLogin.json +7 -0
  31. data/schemas/importIntoApplicationOptions.json +17 -0
  32. data/schemas/samlResponse.json +7 -0
  33. data/schemas/userCredentials.json +7 -0
  34. data/schemas/userPost.json +7 -0
  35. metadata +10 -2
data/schemas/applicationImportExecutions.json CHANGED
@@ -13,7 +13,8 @@
13
13
  "enum": [
14
14
  "importBundle",
15
15
  "importUrl",
16
- "fromApplication"
16
+ "fromApplication",
17
+ "repository"
17
18
  ]
18
19
  },
19
20
  "importExecutionId": {
@@ -199,6 +200,22 @@
199
200
  "type": "string",
200
201
  "format": "uri",
201
202
  "maxLength": 1024
203
+ },
204
+ "credentialName": {
205
+ "type": "string"
206
+ },
207
+ "repo": {
208
+ "type": "object",
209
+ "properties": {
210
+ "branch": {
211
+ "type": "string",
212
+ "maxLength": 255
213
+ },
214
+ "directory": {
215
+ "type": "string",
216
+ "maxLength": 1024
217
+ }
218
+ }
202
219
  }
203
220
  }
204
221
  }
data/schemas/credential.json CHANGED
@@ -69,7 +69,8 @@
69
69
  "sql",
70
70
  "mongodb",
71
71
  "mailgun",
72
- "snowflake"
72
+ "snowflake",
73
+ "git"
73
74
  ]
74
75
  },
75
76
  "awsConfig": {
@@ -295,6 +296,43 @@
295
296
  "publicKey"
296
297
  ],
297
298
  "additionalProperties": false
299
+ },
300
+ "gitConfig": {
301
+ "type": "object",
302
+ "properties": {
303
+ "type": {
304
+ "type": "string",
305
+ "enum": [
306
+ "ssh-key",
307
+ "http-password"
308
+ ]
309
+ },
310
+ "cloneUrl": {
311
+ "type": "string",
312
+ "minLength": 5,
313
+ "maxLength": 1024
314
+ },
315
+ "publicKey": {
316
+ "type": "string",
317
+ "maxLength": 8192
318
+ },
319
+ "username": {
320
+ "type": "string",
321
+ "maxLength": 128
322
+ },
323
+ "committerName": {
324
+ "type": "string",
325
+ "maxLength": 128
326
+ },
327
+ "committerEmail": {
328
+ "type": "string",
329
+ "maxLength": 128
330
+ }
331
+ },
332
+ "required": [
333
+ "type",
334
+ "cloneUrl"
335
+ ]
298
336
  }
299
337
  },
300
338
  "additionalProperties": false,
data/schemas/credentialPatch.json CHANGED
@@ -272,6 +272,43 @@
272
272
  }
273
273
  },
274
274
  "additionalProperties": false
275
+ },
276
+ "gitConfig": {
277
+ "type": "object",
278
+ "properties": {
279
+ "type": {
280
+ "type": "string",
281
+ "enum": [
282
+ "ssh-key",
283
+ "http-password"
284
+ ]
285
+ },
286
+ "cloneUrl": {
287
+ "type": "string",
288
+ "minLength": 5,
289
+ "maxLength": 1024
290
+ },
291
+ "username": {
292
+ "type": "string",
293
+ "maxLength": 128
294
+ },
295
+ "committerName": {
296
+ "type": "string",
297
+ "maxLength": 128
298
+ },
299
+ "committerEmail": {
300
+ "type": "string",
301
+ "maxLength": 128
302
+ },
303
+ "generatePrivateKey": {
304
+ "type": "boolean"
305
+ },
306
+ "secretValue": {
307
+ "type": "string",
308
+ "maxLength": 8196
309
+ }
310
+ },
311
+ "additionalProperties": false
275
312
  }
276
313
  },
277
314
  "additionalProperties": false
data/schemas/credentialPost.json CHANGED
@@ -29,7 +29,8 @@
29
29
  "sql",
30
30
  "mongodb",
31
31
  "mailgun",
32
- "snowflake"
32
+ "snowflake",
33
+ "git"
33
34
  ]
34
35
  },
35
36
  "awsConfig": {
@@ -353,6 +354,58 @@
353
354
  ]
354
355
  }
355
356
  ]
357
+ },
358
+ "gitConfig": {
359
+ "type": "object",
360
+ "properties": {
361
+ "type": {
362
+ "type": "string",
363
+ "enum": [
364
+ "ssh-key",
365
+ "http-password"
366
+ ]
367
+ },
368
+ "cloneUrl": {
369
+ "type": "string",
370
+ "minLength": 5,
371
+ "maxLength": 1024
372
+ },
373
+ "username": {
374
+ "type": "string",
375
+ "maxLength": 128
376
+ },
377
+ "committerName": {
378
+ "type": "string",
379
+ "maxLength": 128
380
+ },
381
+ "committerEmail": {
382
+ "type": "string",
383
+ "maxLength": 128
384
+ },
385
+ "generatePrivateKey": {
386
+ "type": "boolean"
387
+ },
388
+ "secretValue": {
389
+ "type": "string",
390
+ "maxLength": 8196
391
+ }
392
+ },
393
+ "additionalProperties": false,
394
+ "anyOf": [
395
+ {
396
+ "required": [
397
+ "type",
398
+ "cloneUrl",
399
+ "generatePrivateKey"
400
+ ]
401
+ },
402
+ {
403
+ "required": [
404
+ "type",
405
+ "cloneUrl"
406
+ ]
407
+ }
408
+ ]
356
409
  }
357
410
  },
358
411
  "additionalProperties": false,
data/schemas/credentials.json CHANGED
@@ -76,7 +76,8 @@
76
76
  "sql",
77
77
  "mongodb",
78
78
  "mailgun",
79
- "snowflake"
79
+ "snowflake",
80
+ "git"
80
81
  ]
81
82
  },
82
83
  "awsConfig": {
@@ -302,6 +303,43 @@
302
303
  "publicKey"
303
304
  ],
304
305
  "additionalProperties": false
306
+ },
307
+ "gitConfig": {
308
+ "type": "object",
309
+ "properties": {
310
+ "type": {
311
+ "type": "string",
312
+ "enum": [
313
+ "ssh-key",
314
+ "http-password"
315
+ ]
316
+ },
317
+ "cloneUrl": {
318
+ "type": "string",
319
+ "minLength": 5,
320
+ "maxLength": 1024
321
+ },
322
+ "publicKey": {
323
+ "type": "string",
324
+ "maxLength": 8192
325
+ },
326
+ "username": {
327
+ "type": "string",
328
+ "maxLength": 128
329
+ },
330
+ "committerName": {
331
+ "type": "string",
332
+ "maxLength": 128
333
+ },
334
+ "committerEmail": {
335
+ "type": "string",
336
+ "maxLength": 128
337
+ }
338
+ },
339
+ "required": [
340
+ "type",
341
+ "cloneUrl"
342
+ ]
305
343
  }
306
344
  },
307
345
  "additionalProperties": false,
data/schemas/device.json CHANGED
@@ -119,7 +119,6 @@
119
119
  "type": "object",
120
120
  "additionalProperties": false
121
121
  },
122
- "additionalProperties": false,
123
122
  "maxItems": 0
124
123
  },
125
124
  "childAttributes": {
data/schemas/deviceAttribute.json ADDED
@@ -0,0 +1,128 @@
1
+ {
2
+ "$schema": "http://json-schema.org/draft-07/schema#",
3
+ "type": "object",
4
+ "properties": {
5
+ "name": {
6
+ "type": "string",
7
+ "pattern": "^[0-9a-zA-Z_-]{1,255}$"
8
+ },
9
+ "dataType": {
10
+ "type": "string",
11
+ "enum": [
12
+ "string",
13
+ "number",
14
+ "gps",
15
+ "boolean",
16
+ "blob"
17
+ ]
18
+ },
19
+ "contentType": {
20
+ "type": "string",
21
+ "maxLength": 64
22
+ },
23
+ "description": {
24
+ "type": "string",
25
+ "maxLength": 32767
26
+ },
27
+ "attributeTags": {
28
+ "type": "object",
29
+ "patternProperties": {
30
+ "^[0-9a-zA-Z_-]{1,255}$": {
31
+ "type": "string",
32
+ "minLength": 1,
33
+ "maxLength": 255
34
+ }
35
+ },
36
+ "additionalProperties": false
37
+ },
38
+ "system": {
39
+ "type": "object",
40
+ "properties": {
41
+ "aggregation": {
42
+ "type": "string",
43
+ "enum": [
44
+ "FIRST",
45
+ "LAST",
46
+ "COUNT",
47
+ "MAX",
48
+ "MIN",
49
+ "MEDIAN",
50
+ "MEAN",
51
+ "SUM",
52
+ "STD_DEV"
53
+ ]
54
+ },
55
+ "aggregationOptions": {
56
+ "type": "array",
57
+ "items": {
58
+ "type": "object",
59
+ "additionalProperties": false
60
+ },
61
+ "maxItems": 0
62
+ },
63
+ "childAttributes": {
64
+ "type": "array",
65
+ "items": {
66
+ "type": "object",
67
+ "properties": {
68
+ "name": {
69
+ "type": "string",
70
+ "pattern": "^[0-9a-zA-Z_-]{1,255}$"
71
+ },
72
+ "mode": {
73
+ "type": "string",
74
+ "enum": [
75
+ "all",
76
+ "whitelist",
77
+ "blacklist"
78
+ ]
79
+ },
80
+ "deviceIds": {
81
+ "type": "array",
82
+ "items": {
83
+ "type": "string",
84
+ "pattern": "^[A-Fa-f\\d]{24}$"
85
+ },
86
+ "maxItems": 1000
87
+ },
88
+ "deviceTags": {
89
+ "type": "array",
90
+ "items": {
91
+ "type": "object",
92
+ "properties": {
93
+ "key": {
94
+ "type": "string",
95
+ "pattern": "^[0-9a-zA-Z_-]{1,255}$"
96
+ },
97
+ "value": {
98
+ "type": "string",
99
+ "minLength": 1,
100
+ "maxLength": 255
101
+ }
102
+ },
103
+ "additionalProperties": false
104
+ },
105
+ "maxItems": 100
106
+ }
107
+ },
108
+ "required": [
109
+ "name",
110
+ "mode"
111
+ ],
112
+ "additionalProperties": false
113
+ },
114
+ "maxItems": 256
115
+ }
116
+ },
117
+ "additionalProperties": false
118
+ },
119
+ "applicationId": {
120
+ "type": "string",
121
+ "pattern": "^[A-Fa-f\\d]{24}$"
122
+ },
123
+ "deviceId": {
124
+ "type": "string",
125
+ "pattern": "^[A-Fa-f\\d]{24}$"
126
+ }
127
+ }
128
+ }
data/schemas/deviceAttributePatch.json ADDED
@@ -0,0 +1,111 @@
1
+ {
2
+ "$schema": "http://json-schema.org/draft-07/schema#",
3
+ "type": "object",
4
+ "properties": {
5
+ "name": {
6
+ "type": "string",
7
+ "pattern": "^[0-9a-zA-Z_-]{1,255}$"
8
+ },
9
+ "contentType": {
10
+ "type": "string",
11
+ "maxLength": 64
12
+ },
13
+ "description": {
14
+ "type": "string",
15
+ "maxLength": 32767
16
+ },
17
+ "attributeTags": {
18
+ "type": "object",
19
+ "patternProperties": {
20
+ "^[0-9a-zA-Z_-]{1,255}$": {
21
+ "type": "string",
22
+ "minLength": 1,
23
+ "maxLength": 255
24
+ }
25
+ },
26
+ "additionalProperties": false
27
+ },
28
+ "system": {
29
+ "type": "object",
30
+ "properties": {
31
+ "aggregation": {
32
+ "type": "string",
33
+ "enum": [
34
+ "FIRST",
35
+ "LAST",
36
+ "COUNT",
37
+ "MAX",
38
+ "MIN",
39
+ "MEDIAN",
40
+ "MEAN",
41
+ "SUM",
42
+ "STD_DEV"
43
+ ]
44
+ },
45
+ "aggregationOptions": {
46
+ "type": "array",
47
+ "items": {
48
+ "type": "object",
49
+ "additionalProperties": false
50
+ },
51
+ "maxItems": 0
52
+ },
53
+ "childAttributes": {
54
+ "type": "array",
55
+ "items": {
56
+ "type": "object",
57
+ "properties": {
58
+ "name": {
59
+ "type": "string",
60
+ "pattern": "^[0-9a-zA-Z_-]{1,255}$"
61
+ },
62
+ "mode": {
63
+ "type": "string",
64
+ "enum": [
65
+ "all",
66
+ "whitelist",
67
+ "blacklist"
68
+ ]
69
+ },
70
+ "deviceIds": {
71
+ "type": "array",
72
+ "items": {
73
+ "type": "string",
74
+ "pattern": "^[A-Fa-f\\d]{24}$"
75
+ },
76
+ "maxItems": 1000
77
+ },
78
+ "deviceTags": {
79
+ "type": "array",
80
+ "items": {
81
+ "type": "object",
82
+ "properties": {
83
+ "key": {
84
+ "type": "string",
85
+ "pattern": "^[0-9a-zA-Z_-]{1,255}$"
86
+ },
87
+ "value": {
88
+ "type": "string",
89
+ "minLength": 1,
90
+ "maxLength": 255
91
+ }
92
+ },
93
+ "additionalProperties": false
94
+ },
95
+ "maxItems": 100
96
+ }
97
+ },
98
+ "required": [
99
+ "name",
100
+ "mode"
101
+ ],
102
+ "additionalProperties": false
103
+ },
104
+ "maxItems": 256
105
+ }
106
+ },
107
+ "additionalProperties": false
108
+ }
109
+ },
110
+ "additionalProperties": false
111
+ }
data/schemas/deviceAttributePost.json ADDED
@@ -0,0 +1,125 @@
1
+ {
2
+ "$schema": "http://json-schema.org/draft-07/schema#",
3
+ "type": "object",
4
+ "properties": {
5
+ "name": {
6
+ "type": "string",
7
+ "pattern": "^[0-9a-zA-Z_-]{1,255}$"
8
+ },
9
+ "dataType": {
10
+ "type": "string",
11
+ "enum": [
12
+ "string",
13
+ "number",
14
+ "gps",
15
+ "boolean",
16
+ "blob"
17
+ ]
18
+ },
19
+ "contentType": {
20
+ "type": "string",
21
+ "maxLength": 64
22
+ },
23
+ "description": {
24
+ "type": "string",
25
+ "maxLength": 32767
26
+ },
27
+ "attributeTags": {
28
+ "type": "object",
29
+ "patternProperties": {
30
+ "^[0-9a-zA-Z_-]{1,255}$": {
31
+ "type": "string",
32
+ "minLength": 1,
33
+ "maxLength": 255
34
+ }
35
+ },
36
+ "additionalProperties": false
37
+ },
38
+ "system": {
39
+ "type": "object",
40
+ "properties": {
41
+ "aggregation": {
42
+ "type": "string",
43
+ "enum": [
44
+ "FIRST",
45
+ "LAST",
46
+ "COUNT",
47
+ "MAX",
48
+ "MIN",
49
+ "MEDIAN",
50
+ "MEAN",
51
+ "SUM",
52
+ "STD_DEV"
53
+ ]
54
+ },
55
+ "aggregationOptions": {
56
+ "type": "array",
57
+ "items": {
58
+ "type": "object",
59
+ "additionalProperties": false
60
+ },
61
+ "maxItems": 0
62
+ },
63
+ "childAttributes": {
64
+ "type": "array",
65
+ "items": {
66
+ "type": "object",
67
+ "properties": {
68
+ "name": {
69
+ "type": "string",
70
+ "pattern": "^[0-9a-zA-Z_-]{1,255}$"
71
+ },
72
+ "mode": {
73
+ "type": "string",
74
+ "enum": [
75
+ "all",
76
+ "whitelist",
77
+ "blacklist"
78
+ ]
79
+ },
80
+ "deviceIds": {
81
+ "type": "array",
82
+ "items": {
83
+ "type": "string",
84
+ "pattern": "^[A-Fa-f\\d]{24}$"
85
+ },
86
+ "maxItems": 1000
87
+ },
88
+ "deviceTags": {
89
+ "type": "array",
90
+ "items": {
91
+ "type": "object",
92
+ "properties": {
93
+ "key": {
94
+ "type": "string",
95
+ "pattern": "^[0-9a-zA-Z_-]{1,255}$"
96
+ },
97
+ "value": {
98
+ "type": "string",
99
+ "minLength": 1,
100
+ "maxLength": 255
101
+ }
102
+ },
103
+ "additionalProperties": false
104
+ },
105
+ "maxItems": 100
106
+ }
107
+ },
108
+ "required": [
109
+ "name",
110
+ "mode"
111
+ ],
112
+ "additionalProperties": false
113
+ },
114
+ "maxItems": 256
115
+ }
116
+ },
117
+ "additionalProperties": false
118
+ }
119
+ },
120
+ "required": [
121
+ "name",
122
+ "dataType"
123
+ ],
124
+ "additionalProperties": false
125
+ }