losant_rest 1.17.3 → 1.17.4

Sign up to get free protection for your applications and to get access to all the features.
@@ -166,7 +166,7 @@ all.Application, all.Application.read, all.Organization, all.Organization.read,
166
166
 
167
167
  | Code | Type | Description |
168
168
  | ---- | ---- | ----------- |
169
- | 200 | [Success](_schemas.md#success) | Send dashboard report |
169
+ | 202 | [Job Enqueued API Result](_schemas.md#job-enqueued-api-result) | If dashboard report was enqueued to be sent |
170
170
 
171
171
  #### Error Responses
172
172
 
data/docs/flow.md CHANGED
@@ -128,7 +128,7 @@ all.Application, all.Application.read, all.Organization, all.Organization.read,
128
128
  | limit | string | N | Maximum number of errors to return | 25 | 25 |
129
129
  | sortDirection | string | N | Direction to sort the results by. Accepted values are: asc, desc | desc | desc |
130
130
  | flowVersion | string | N | Flow version name or ID. When not included, will be errors for all versions. Pass develop for just the develop version. | | develop |
131
- | deviceId | string | N | For edge or embedded workflows, the Device ID to return workflow errors for. When not included, will be errors for all device IDs. | | 575ed18f7ae143cd83dc4bb6 |
131
+ | deviceId | string | N | For edge or embedded workflows, the Device ID for which to return workflow errors. When not included, will be errors for all device IDs. | | 575ed18f7ae143cd83dc4bb6 |
132
132
  | losantdomain | string | N | Domain scope of request (rarely needed) | | example.com |
133
133
 
134
134
  #### Successful Responses
@@ -190,7 +190,7 @@ module LosantRest
190
190
  # * {boolean} _embedded - Return embedded resources in response
191
191
  #
192
192
  # Responses:
193
- # * 200 - Send dashboard report (https://api.losant.com/#/definitions/success)
193
+ # * 202 - If dashboard report was enqueued to be sent (https://api.losant.com/#/definitions/jobEnqueuedResult)
194
194
  #
195
195
  # Errors:
196
196
  # * 400 - Error if malformed request (https://api.losant.com/#/definitions/error)
@@ -27,7 +27,7 @@ module LosantRest
27
27
  #
28
28
  # User API for accessing Losant data
29
29
  #
30
- # Built For Version 1.24.3
30
+ # Built For Version 1.24.4
31
31
  class Client
32
32
  attr_accessor :auth_token, :url
33
33
 
@@ -382,7 +382,7 @@ module LosantRest
382
382
 
383
383
  headers["Accept"] = "application/json"
384
384
  headers["Content-Type"] = "application/json"
385
- headers["Accept-Version"] = "^1.24.3"
385
+ headers["Accept-Version"] = "^1.24.4"
386
386
  headers["Authorization"] = "Bearer #{self.auth_token}" if self.auth_token
387
387
  path = self.url + options.fetch(:path, "")
388
388
 
@@ -139,7 +139,7 @@ module LosantRest
139
139
  # * {string} limit - Maximum number of errors to return
140
140
  # * {string} sortDirection - Direction to sort the results by. Accepted values are: asc, desc
141
141
  # * {string} flowVersion - Flow version name or ID. When not included, will be errors for all versions. Pass develop for just the develop version.
142
- # * {string} deviceId - For edge or embedded workflows, the Device ID to return workflow errors for. When not included, will be errors for all device IDs.
142
+ # * {string} deviceId - For edge or embedded workflows, the Device ID for which to return workflow errors. When not included, will be errors for all device IDs.
143
143
  # * {string} losantdomain - Domain scope of request (rarely needed)
144
144
  # * {boolean} _actions - Return resource actions in response
145
145
  # * {boolean} _links - Return resource link in response
@@ -21,5 +21,5 @@
21
21
  # SOFTWARE.
22
22
 
23
23
  module LosantRest
24
- VERSION = "1.17.3"
24
+ VERSION = "1.17.4"
25
25
  end
@@ -29,6 +29,30 @@
29
29
  "organization"
30
30
  ]
31
31
  },
32
+ "createdById": {
33
+ "type": "string",
34
+ "pattern": "^[A-Fa-f\\d]{24}$"
35
+ },
36
+ "createdByType": {
37
+ "type": "string",
38
+ "enum": [
39
+ "flow",
40
+ "user",
41
+ "apiToken"
42
+ ]
43
+ },
44
+ "lastUpdatedById": {
45
+ "type": "string",
46
+ "pattern": "^[A-Fa-f\\d]{24}$"
47
+ },
48
+ "lastUpdatedByType": {
49
+ "type": "string",
50
+ "enum": [
51
+ "flow",
52
+ "user",
53
+ "apiToken"
54
+ ]
55
+ },
32
56
  "organizationName": {
33
57
  "type": "string",
34
58
  "minLength": 1,
@@ -36,6 +36,30 @@
36
36
  "organization"
37
37
  ]
38
38
  },
39
+ "createdById": {
40
+ "type": "string",
41
+ "pattern": "^[A-Fa-f\\d]{24}$"
42
+ },
43
+ "createdByType": {
44
+ "type": "string",
45
+ "enum": [
46
+ "flow",
47
+ "user",
48
+ "apiToken"
49
+ ]
50
+ },
51
+ "lastUpdatedById": {
52
+ "type": "string",
53
+ "pattern": "^[A-Fa-f\\d]{24}$"
54
+ },
55
+ "lastUpdatedByType": {
56
+ "type": "string",
57
+ "enum": [
58
+ "flow",
59
+ "user",
60
+ "apiToken"
61
+ ]
62
+ },
39
63
  "organizationName": {
40
64
  "type": "string",
41
65
  "minLength": 1,
@@ -76,6 +76,16 @@
76
76
  "minLength": 1,
77
77
  "maxLength": 255
78
78
  },
79
+ "currentEtag": {
80
+ "type": "string",
81
+ "minLength": 1,
82
+ "maxLength": 255
83
+ },
84
+ "desiredEtag": {
85
+ "type": "string",
86
+ "minLength": 1,
87
+ "maxLength": 255
88
+ },
79
89
  "logs": {
80
90
  "type": "array",
81
91
  "items": {
@@ -130,6 +140,21 @@
130
140
  "minLength": 1,
131
141
  "maxLength": 255
132
142
  },
143
+ "newEtag": {
144
+ "type": "string",
145
+ "minLength": 1,
146
+ "maxLength": 255
147
+ },
148
+ "previousEtag": {
149
+ "type": "string",
150
+ "minLength": 1,
151
+ "maxLength": 255
152
+ },
153
+ "attemptedEtag": {
154
+ "type": "string",
155
+ "minLength": 1,
156
+ "maxLength": 255
157
+ },
133
158
  "error": {
134
159
  "type": "string"
135
160
  }
@@ -83,6 +83,16 @@
83
83
  "minLength": 1,
84
84
  "maxLength": 255
85
85
  },
86
+ "currentEtag": {
87
+ "type": "string",
88
+ "minLength": 1,
89
+ "maxLength": 255
90
+ },
91
+ "desiredEtag": {
92
+ "type": "string",
93
+ "minLength": 1,
94
+ "maxLength": 255
95
+ },
86
96
  "logs": {
87
97
  "type": "array",
88
98
  "items": {
@@ -137,6 +147,21 @@
137
147
  "minLength": 1,
138
148
  "maxLength": 255
139
149
  },
150
+ "newEtag": {
151
+ "type": "string",
152
+ "minLength": 1,
153
+ "maxLength": 255
154
+ },
155
+ "previousEtag": {
156
+ "type": "string",
157
+ "minLength": 1,
158
+ "maxLength": 255
159
+ },
160
+ "attemptedEtag": {
161
+ "type": "string",
162
+ "minLength": 1,
163
+ "maxLength": 255
164
+ },
140
165
  "error": {
141
166
  "type": "string"
142
167
  }
@@ -1683,6 +1683,94 @@
1683
1683
  ],
1684
1684
  "additionalProperties": false
1685
1685
  },
1686
+ {
1687
+ "type": "object",
1688
+ "properties": {
1689
+ "key": {
1690
+ "type": "string",
1691
+ "maxLength": 1024
1692
+ },
1693
+ "type": {
1694
+ "type": "string",
1695
+ "enum": [
1696
+ "onSync"
1697
+ ]
1698
+ },
1699
+ "config": {
1700
+ "type": "object",
1701
+ "properties": {
1702
+ "syncTypes": {
1703
+ "type": "array",
1704
+ "maxItems": 3,
1705
+ "minItems": 1,
1706
+ "items": {
1707
+ "type": "string",
1708
+ "enum": [
1709
+ "application",
1710
+ "device",
1711
+ "peripheral"
1712
+ ]
1713
+ }
1714
+ }
1715
+ },
1716
+ "additionalProperties": false
1717
+ },
1718
+ "meta": {
1719
+ "type": "object",
1720
+ "properties": {
1721
+ "category": {
1722
+ "type": "string",
1723
+ "enum": [
1724
+ "trigger"
1725
+ ]
1726
+ },
1727
+ "name": {
1728
+ "type": "string",
1729
+ "enum": [
1730
+ "onSync"
1731
+ ]
1732
+ },
1733
+ "label": {
1734
+ "type": "string",
1735
+ "minLength": 1,
1736
+ "maxLength": 255
1737
+ },
1738
+ "x": {
1739
+ "type": "number"
1740
+ },
1741
+ "y": {
1742
+ "type": "number"
1743
+ },
1744
+ "uiId": {
1745
+ "type": "string",
1746
+ "maxLength": 48
1747
+ },
1748
+ "description": {
1749
+ "type": "string",
1750
+ "maxLength": 32767
1751
+ }
1752
+ },
1753
+ "additionalProperties": false
1754
+ },
1755
+ "outputIds": {
1756
+ "type": "array",
1757
+ "items": {
1758
+ "type": "array",
1759
+ "items": {
1760
+ "type": "string",
1761
+ "maxLength": 48,
1762
+ "minLength": 1
1763
+ },
1764
+ "maxItems": 100
1765
+ },
1766
+ "maxItems": 100
1767
+ }
1768
+ },
1769
+ "required": [
1770
+ "type"
1771
+ ],
1772
+ "additionalProperties": false
1773
+ },
1686
1774
  {
1687
1775
  "type": "object",
1688
1776
  "properties": {
@@ -4362,6 +4450,94 @@
4362
4450
  ],
4363
4451
  "additionalProperties": false
4364
4452
  },
4453
+ {
4454
+ "type": "object",
4455
+ "properties": {
4456
+ "key": {
4457
+ "type": "string",
4458
+ "maxLength": 1024
4459
+ },
4460
+ "type": {
4461
+ "type": "string",
4462
+ "enum": [
4463
+ "onSync"
4464
+ ]
4465
+ },
4466
+ "config": {
4467
+ "type": "object",
4468
+ "properties": {
4469
+ "syncTypes": {
4470
+ "type": "array",
4471
+ "maxItems": 3,
4472
+ "minItems": 1,
4473
+ "items": {
4474
+ "type": "string",
4475
+ "enum": [
4476
+ "application",
4477
+ "device",
4478
+ "peripheral"
4479
+ ]
4480
+ }
4481
+ }
4482
+ },
4483
+ "additionalProperties": false
4484
+ },
4485
+ "meta": {
4486
+ "type": "object",
4487
+ "properties": {
4488
+ "category": {
4489
+ "type": "string",
4490
+ "enum": [
4491
+ "trigger"
4492
+ ]
4493
+ },
4494
+ "name": {
4495
+ "type": "string",
4496
+ "enum": [
4497
+ "onSync"
4498
+ ]
4499
+ },
4500
+ "label": {
4501
+ "type": "string",
4502
+ "minLength": 1,
4503
+ "maxLength": 255
4504
+ },
4505
+ "x": {
4506
+ "type": "number"
4507
+ },
4508
+ "y": {
4509
+ "type": "number"
4510
+ },
4511
+ "uiId": {
4512
+ "type": "string",
4513
+ "maxLength": 48
4514
+ },
4515
+ "description": {
4516
+ "type": "string",
4517
+ "maxLength": 32767
4518
+ }
4519
+ },
4520
+ "additionalProperties": false
4521
+ },
4522
+ "outputIds": {
4523
+ "type": "array",
4524
+ "items": {
4525
+ "type": "array",
4526
+ "items": {
4527
+ "type": "string",
4528
+ "maxLength": 48,
4529
+ "minLength": 1
4530
+ },
4531
+ "maxItems": 100
4532
+ },
4533
+ "maxItems": 100
4534
+ }
4535
+ },
4536
+ "required": [
4537
+ "type"
4538
+ ],
4539
+ "additionalProperties": false
4540
+ },
4365
4541
  {
4366
4542
  "type": "object",
4367
4543
  "properties": {
@@ -6952,6 +7128,94 @@
6952
7128
  ],
6953
7129
  "additionalProperties": false
6954
7130
  },
7131
+ {
7132
+ "type": "object",
7133
+ "properties": {
7134
+ "key": {
7135
+ "type": "string",
7136
+ "maxLength": 1024
7137
+ },
7138
+ "type": {
7139
+ "type": "string",
7140
+ "enum": [
7141
+ "onSync"
7142
+ ]
7143
+ },
7144
+ "config": {
7145
+ "type": "object",
7146
+ "properties": {
7147
+ "syncTypes": {
7148
+ "type": "array",
7149
+ "maxItems": 3,
7150
+ "minItems": 1,
7151
+ "items": {
7152
+ "type": "string",
7153
+ "enum": [
7154
+ "application",
7155
+ "device",
7156
+ "peripheral"
7157
+ ]
7158
+ }
7159
+ }
7160
+ },
7161
+ "additionalProperties": false
7162
+ },
7163
+ "meta": {
7164
+ "type": "object",
7165
+ "properties": {
7166
+ "category": {
7167
+ "type": "string",
7168
+ "enum": [
7169
+ "trigger"
7170
+ ]
7171
+ },
7172
+ "name": {
7173
+ "type": "string",
7174
+ "enum": [
7175
+ "onSync"
7176
+ ]
7177
+ },
7178
+ "label": {
7179
+ "type": "string",
7180
+ "minLength": 1,
7181
+ "maxLength": 255
7182
+ },
7183
+ "x": {
7184
+ "type": "number"
7185
+ },
7186
+ "y": {
7187
+ "type": "number"
7188
+ },
7189
+ "uiId": {
7190
+ "type": "string",
7191
+ "maxLength": 48
7192
+ },
7193
+ "description": {
7194
+ "type": "string",
7195
+ "maxLength": 32767
7196
+ }
7197
+ },
7198
+ "additionalProperties": false
7199
+ },
7200
+ "outputIds": {
7201
+ "type": "array",
7202
+ "items": {
7203
+ "type": "array",
7204
+ "items": {
7205
+ "type": "string",
7206
+ "maxLength": 48,
7207
+ "minLength": 1
7208
+ },
7209
+ "maxItems": 100
7210
+ },
7211
+ "maxItems": 100
7212
+ }
7213
+ },
7214
+ "required": [
7215
+ "type"
7216
+ ],
7217
+ "additionalProperties": false
7218
+ },
6955
7219
  {
6956
7220
  "type": "object",
6957
7221
  "properties": {
data/schemas/flow.json CHANGED
@@ -1302,6 +1302,94 @@
1302
1302
  ],
1303
1303
  "additionalProperties": false
1304
1304
  },
1305
+ {
1306
+ "type": "object",
1307
+ "properties": {
1308
+ "key": {
1309
+ "type": "string",
1310
+ "maxLength": 1024
1311
+ },
1312
+ "type": {
1313
+ "type": "string",
1314
+ "enum": [
1315
+ "onSync"
1316
+ ]
1317
+ },
1318
+ "config": {
1319
+ "type": "object",
1320
+ "properties": {
1321
+ "syncTypes": {
1322
+ "type": "array",
1323
+ "maxItems": 3,
1324
+ "minItems": 1,
1325
+ "items": {
1326
+ "type": "string",
1327
+ "enum": [
1328
+ "application",
1329
+ "device",
1330
+ "peripheral"
1331
+ ]
1332
+ }
1333
+ }
1334
+ },
1335
+ "additionalProperties": false
1336
+ },
1337
+ "meta": {
1338
+ "type": "object",
1339
+ "properties": {
1340
+ "category": {
1341
+ "type": "string",
1342
+ "enum": [
1343
+ "trigger"
1344
+ ]
1345
+ },
1346
+ "name": {
1347
+ "type": "string",
1348
+ "enum": [
1349
+ "onSync"
1350
+ ]
1351
+ },
1352
+ "label": {
1353
+ "type": "string",
1354
+ "minLength": 1,
1355
+ "maxLength": 255
1356
+ },
1357
+ "x": {
1358
+ "type": "number"
1359
+ },
1360
+ "y": {
1361
+ "type": "number"
1362
+ },
1363
+ "uiId": {
1364
+ "type": "string",
1365
+ "maxLength": 48
1366
+ },
1367
+ "description": {
1368
+ "type": "string",
1369
+ "maxLength": 32767
1370
+ }
1371
+ },
1372
+ "additionalProperties": false
1373
+ },
1374
+ "outputIds": {
1375
+ "type": "array",
1376
+ "items": {
1377
+ "type": "array",
1378
+ "items": {
1379
+ "type": "string",
1380
+ "maxLength": 48,
1381
+ "minLength": 1
1382
+ },
1383
+ "maxItems": 100
1384
+ },
1385
+ "maxItems": 100
1386
+ }
1387
+ },
1388
+ "required": [
1389
+ "type"
1390
+ ],
1391
+ "additionalProperties": false
1392
+ },
1305
1393
  {
1306
1394
  "type": "object",
1307
1395
  "properties": {
@@ -1259,6 +1259,94 @@
1259
1259
  ],
1260
1260
  "additionalProperties": false
1261
1261
  },
1262
+ {
1263
+ "type": "object",
1264
+ "properties": {
1265
+ "key": {
1266
+ "type": "string",
1267
+ "maxLength": 1024
1268
+ },
1269
+ "type": {
1270
+ "type": "string",
1271
+ "enum": [
1272
+ "onSync"
1273
+ ]
1274
+ },
1275
+ "config": {
1276
+ "type": "object",
1277
+ "properties": {
1278
+ "syncTypes": {
1279
+ "type": "array",
1280
+ "maxItems": 3,
1281
+ "minItems": 1,
1282
+ "items": {
1283
+ "type": "string",
1284
+ "enum": [
1285
+ "application",
1286
+ "device",
1287
+ "peripheral"
1288
+ ]
1289
+ }
1290
+ }
1291
+ },
1292
+ "additionalProperties": false
1293
+ },
1294
+ "meta": {
1295
+ "type": "object",
1296
+ "properties": {
1297
+ "category": {
1298
+ "type": "string",
1299
+ "enum": [
1300
+ "trigger"
1301
+ ]
1302
+ },
1303
+ "name": {
1304
+ "type": "string",
1305
+ "enum": [
1306
+ "onSync"
1307
+ ]
1308
+ },
1309
+ "label": {
1310
+ "type": "string",
1311
+ "minLength": 1,
1312
+ "maxLength": 255
1313
+ },
1314
+ "x": {
1315
+ "type": "number"
1316
+ },
1317
+ "y": {
1318
+ "type": "number"
1319
+ },
1320
+ "uiId": {
1321
+ "type": "string",
1322
+ "maxLength": 48
1323
+ },
1324
+ "description": {
1325
+ "type": "string",
1326
+ "maxLength": 32767
1327
+ }
1328
+ },
1329
+ "additionalProperties": false
1330
+ },
1331
+ "outputIds": {
1332
+ "type": "array",
1333
+ "items": {
1334
+ "type": "array",
1335
+ "items": {
1336
+ "type": "string",
1337
+ "maxLength": 48,
1338
+ "minLength": 1
1339
+ },
1340
+ "maxItems": 100
1341
+ },
1342
+ "maxItems": 100
1343
+ }
1344
+ },
1345
+ "required": [
1346
+ "type"
1347
+ ],
1348
+ "additionalProperties": false
1349
+ },
1262
1350
  {
1263
1351
  "type": "object",
1264
1352
  "properties": {