losant_rest 1.4.0 → 1.4.1

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.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA1:
3
- metadata.gz: f694a4207f01979eccdf4a9efc3fd8716295957f
4
- data.tar.gz: 9d4dfc759fbc43209d77e4b4657241823b172c55
3
+ metadata.gz: 953d0b8c769ddba10e356c990a502b49a1f8f212
4
+ data.tar.gz: 6a1dbf5dba079e7414ed64551ab3d328986eb06a
5
5
  SHA512:
6
- metadata.gz: 93b7bdb6c393c2afc90e5dc95e858d34967ab3574621976c0b06358616a203e8a2e607237e0ca63883e5f87f3cecad292d22f7bbc40f8bf3776e83c3229b0989
7
- data.tar.gz: ce6904bb8ac7ce290289ae512a93400f584df880a6384b21ed13323f016f693c7281814daec4f3101f9f2c51336e59f4a8132a400b23424518061bcc40e6f54d
6
+ metadata.gz: 3942428163bc48340058122486dc57c9273d5b03d610229bae56971c362ddebf93a54b8d07552ed88deb2e21633b76bbc687f47caf4d4542fcdf95c7bbd952f4
7
+ data.tar.gz: d55eda538b27deb9bb20ee223b35a92fa0f6d8b743a441e43e1599489deb353ec588f9dfe288368f421a9f8b9f18a03f1dfaf1a499fbd12e572f4913d73ca21f
data/README.md CHANGED
@@ -143,6 +143,12 @@ Each of the following is a method on the client object, and returns a wrapper fo
143
143
  * [events](docs/events.md)
144
144
  Contains all the actions that can be performed against the collection of [Events](https://docs.losant.com/events/overview/) belonging to an Application - such as listing open events or creating a new event.
145
145
 
146
+ * [experience_domain](docs/experienceDomain.md)
147
+ Contains all the actions that can be performed against a single [Experience Domain](https://docs.losant.com/experiences/domains/), such as updating SSL certificate information.
148
+
149
+ * [experience_domains](docs/experienceDomains.md)
150
+ Contains all the actions that can be performed against the collection of [Experience Domains](https://docs.losant.com/experiences/domains/) belonging to an Application - such as listing domains or creating a new domain.
151
+
146
152
  * [experience_endpoint](docs/experienceEndpoint.md)
147
153
  Contains all the actions that can be performed against a single [Experience Endpoint](https://docs.losant.com/experiences/endpoints/), such as updating route information.
148
154
 
data/docs/_schemas.md CHANGED
@@ -33,6 +33,7 @@
33
33
  * [Data Table Row](#data-table-row)
34
34
  * [Data Table Row Insert/Update](#data-table-row-insert/update)
35
35
  * [Data Table Rows](#data-table-rows)
36
+ * [Data Table Rows Delete](#data-table-rows-delete)
36
37
  * [Data Table Export](#data-table-export)
37
38
  * [Data Tables](#data-tables)
38
39
  * [Device](#device)
@@ -363,7 +364,7 @@ Schema for a single Application
363
364
  "json": {
364
365
  "type": "string",
365
366
  "minLength": 1,
366
- "maxLength": 2048
367
+ "maxLength": 32767
367
368
  }
368
369
  },
369
370
  "additionalProperties": false,
@@ -448,6 +449,87 @@ Schema for a single Application
448
449
  "additionalProperties": false
449
450
  },
450
451
  "maxItems": 100
452
+ },
453
+ "archiveConfig": {
454
+ "type": "object",
455
+ "properties": {
456
+ "directory": {
457
+ "type": "string",
458
+ "max": 255
459
+ },
460
+ "whiteList": {
461
+ "type": "array",
462
+ "items": {
463
+ "type": "string",
464
+ "pattern": "^[A-Fa-f\\d]{24}$"
465
+ },
466
+ "max": 100
467
+ },
468
+ "blackList": {
469
+ "type": "array",
470
+ "items": {
471
+ "type": "string",
472
+ "pattern": "^[A-Fa-f\\d]{24}$"
473
+ },
474
+ "max": 100
475
+ },
476
+ "s3": {
477
+ "type": "object",
478
+ "properties": {
479
+ "bucket": {
480
+ "type": "string",
481
+ "max": 255
482
+ },
483
+ "accessKeyId": {
484
+ "type": "string",
485
+ "min": 16,
486
+ "max": 128
487
+ },
488
+ "secretAccessKey": {
489
+ "type": "string",
490
+ "min": 16,
491
+ "max": 128
492
+ },
493
+ "region": {
494
+ "type": "string",
495
+ "max": 128
496
+ }
497
+ },
498
+ "required": [
499
+ "bucket",
500
+ "accessKeyId",
501
+ "secretAccessKey",
502
+ "region"
503
+ ],
504
+ "additionalProperties": false
505
+ },
506
+ "gcs": {
507
+ "type": "object",
508
+ "properties": {
509
+ "projectId": {
510
+ "type": "string",
511
+ "minLength": 1,
512
+ "maxLength": 1024
513
+ },
514
+ "keyJson": {
515
+ "type": "string",
516
+ "maxLength": 32767,
517
+ "minLength": 50
518
+ },
519
+ "bucket": {
520
+ "type": "string",
521
+ "max": 255
522
+ }
523
+ },
524
+ "required": [
525
+ "projectId",
526
+ "keyJson",
527
+ "bucket"
528
+ ],
529
+ "additionalProperties": false
530
+ }
531
+ },
532
+ "additionalProperties": false
451
533
  }
452
534
  }
453
535
  }
@@ -471,6 +553,18 @@ Schema for a single Application
471
553
  "eventCount": 0,
472
554
  "keyCount": 1,
473
555
  "deviceRecipeCount": 0
556
+ },
557
+ "archiveConfig": {
558
+ "s3": {
559
+ "bucket": "bucketName",
560
+ "accessKeyId": "awsAccessKey",
561
+ "accessSecretKey": "awsSecretKey",
562
+ "region": "us-west-1"
563
+ },
564
+ "blackList": [
565
+ "575ec8687ae143cd83dc4a95",
566
+ "575ec8687ae143cd83dc4a91"
567
+ ]
474
568
  }
475
569
  }
476
570
  ```
@@ -569,6 +663,9 @@ Schema for the body of an Application API Token creation request
569
663
  "dataTableRows.get",
570
664
  "dataTableRows.post",
571
665
  "dataTableRows.query",
666
+ "dataTableRows.export",
667
+ "dataTableRows.delete",
668
+ "dataTableRows.truncate",
572
669
  "dataTables.get",
573
670
  "dataTables.post",
574
671
  "device.delete",
@@ -1155,7 +1252,7 @@ Schema for the body of an Application modification request
1155
1252
  "json": {
1156
1253
  "type": "string",
1157
1254
  "minLength": 1,
1158
- "maxLength": 2048
1255
+ "maxLength": 32767
1159
1256
  }
1160
1257
  },
1161
1258
  "additionalProperties": false,
@@ -1193,6 +1290,87 @@ Schema for the body of an Application modification request
1193
1290
  "additionalProperties": false
1194
1291
  },
1195
1292
  "maxItems": 100
1293
+ },
1294
+ "archiveConfig": {
1295
+ "type": "object",
1296
+ "properties": {
1297
+ "directory": {
1298
+ "type": "string",
1299
+ "max": 255
1300
+ },
1301
+ "whiteList": {
1302
+ "type": "array",
1303
+ "items": {
1304
+ "type": "string",
1305
+ "pattern": "^[A-Fa-f\\d]{24}$"
1306
+ },
1307
+ "max": 100
1308
+ },
1309
+ "blackList": {
1310
+ "type": "array",
1311
+ "items": {
1312
+ "type": "string",
1313
+ "pattern": "^[A-Fa-f\\d]{24}$"
1314
+ },
1315
+ "max": 100
1316
+ },
1317
+ "s3": {
1318
+ "type": "object",
1319
+ "properties": {
1320
+ "bucket": {
1321
+ "type": "string",
1322
+ "max": 255
1323
+ },
1324
+ "accessKeyId": {
1325
+ "type": "string",
1326
+ "min": 16,
1327
+ "max": 128
1328
+ },
1329
+ "secretAccessKey": {
1330
+ "type": "string",
1331
+ "min": 16,
1332
+ "max": 128
1333
+ },
1334
+ "region": {
1335
+ "type": "string",
1336
+ "max": 128
1337
+ }
1338
+ },
1339
+ "required": [
1340
+ "bucket",
1341
+ "accessKeyId",
1342
+ "secretAccessKey",
1343
+ "region"
1344
+ ],
1345
+ "additionalProperties": false
1346
+ },
1347
+ "gcs": {
1348
+ "type": "object",
1349
+ "properties": {
1350
+ "projectId": {
1351
+ "type": "string",
1352
+ "minLength": 1,
1353
+ "maxLength": 1024
1354
+ },
1355
+ "keyJson": {
1356
+ "type": "string",
1357
+ "maxLength": 32767,
1358
+ "minLength": 50
1359
+ },
1360
+ "bucket": {
1361
+ "type": "string",
1362
+ "max": 255
1363
+ }
1364
+ },
1365
+ "required": [
1366
+ "projectId",
1367
+ "keyJson",
1368
+ "bucket"
1369
+ ],
1370
+ "additionalProperties": false
1371
+ }
1372
+ },
1373
+ "additionalProperties": false
1196
1374
  }
1197
1375
  },
1198
1376
  "additionalProperties": false
@@ -1259,7 +1437,7 @@ Schema for the body of an Application creation request
1259
1437
  "json": {
1260
1438
  "type": "string",
1261
1439
  "minLength": 1,
1262
- "maxLength": 2048
1440
+ "maxLength": 32767
1263
1441
  }
1264
1442
  },
1265
1443
  "additionalProperties": false,
@@ -1268,6 +1446,87 @@ Schema for the body of an Application creation request
1268
1446
  "json"
1269
1447
  ]
1270
1448
  }
1449
+ },
1450
+ "archiveConfig": {
1451
+ "type": "object",
1452
+ "properties": {
1453
+ "directory": {
1454
+ "type": "string",
1455
+ "max": 255
1456
+ },
1457
+ "whiteList": {
1458
+ "type": "array",
1459
+ "items": {
1460
+ "type": "string",
1461
+ "pattern": "^[A-Fa-f\\d]{24}$"
1462
+ },
1463
+ "max": 100
1464
+ },
1465
+ "blackList": {
1466
+ "type": "array",
1467
+ "items": {
1468
+ "type": "string",
1469
+ "pattern": "^[A-Fa-f\\d]{24}$"
1470
+ },
1471
+ "max": 100
1472
+ },
1473
+ "s3": {
1474
+ "type": "object",
1475
+ "properties": {
1476
+ "bucket": {
1477
+ "type": "string",
1478
+ "max": 255
1479
+ },
1480
+ "accessKeyId": {
1481
+ "type": "string",
1482
+ "min": 16,
1483
+ "max": 128
1484
+ },
1485
+ "secretAccessKey": {
1486
+ "type": "string",
1487
+ "min": 16,
1488
+ "max": 128
1489
+ },
1490
+ "region": {
1491
+ "type": "string",
1492
+ "max": 128
1493
+ }
1494
+ },
1495
+ "required": [
1496
+ "bucket",
1497
+ "accessKeyId",
1498
+ "secretAccessKey",
1499
+ "region"
1500
+ ],
1501
+ "additionalProperties": false
1502
+ },
1503
+ "gcs": {
1504
+ "type": "object",
1505
+ "properties": {
1506
+ "projectId": {
1507
+ "type": "string",
1508
+ "minLength": 1,
1509
+ "maxLength": 1024
1510
+ },
1511
+ "keyJson": {
1512
+ "type": "string",
1513
+ "maxLength": 32767,
1514
+ "minLength": 50
1515
+ },
1516
+ "bucket": {
1517
+ "type": "string",
1518
+ "max": 255
1519
+ }
1520
+ },
1521
+ "required": [
1522
+ "projectId",
1523
+ "keyJson",
1524
+ "bucket"
1525
+ ],
1526
+ "additionalProperties": false
1527
+ }
1528
+ },
1529
+ "additionalProperties": false
1271
1530
  }
1272
1531
  },
1273
1532
  "additionalProperties": false,
@@ -1367,7 +1626,7 @@ Schema for a collection of Applications
1367
1626
  "json": {
1368
1627
  "type": "string",
1369
1628
  "minLength": 1,
1370
- "maxLength": 2048
1629
+ "maxLength": 32767
1371
1630
  }
1372
1631
  },
1373
1632
  "additionalProperties": false,
@@ -1452,6 +1711,87 @@ Schema for a collection of Applications
1452
1711
  "additionalProperties": false
1453
1712
  },
1454
1713
  "maxItems": 100
1714
+ },
1715
+ "archiveConfig": {
1716
+ "type": "object",
1717
+ "properties": {
1718
+ "directory": {
1719
+ "type": "string",
1720
+ "max": 255
1721
+ },
1722
+ "whiteList": {
1723
+ "type": "array",
1724
+ "items": {
1725
+ "type": "string",
1726
+ "pattern": "^[A-Fa-f\\d]{24}$"
1727
+ },
1728
+ "max": 100
1729
+ },
1730
+ "blackList": {
1731
+ "type": "array",
1732
+ "items": {
1733
+ "type": "string",
1734
+ "pattern": "^[A-Fa-f\\d]{24}$"
1735
+ },
1736
+ "max": 100
1737
+ },
1738
+ "s3": {
1739
+ "type": "object",
1740
+ "properties": {
1741
+ "bucket": {
1742
+ "type": "string",
1743
+ "max": 255
1744
+ },
1745
+ "accessKeyId": {
1746
+ "type": "string",
1747
+ "min": 16,
1748
+ "max": 128
1749
+ },
1750
+ "secretAccessKey": {
1751
+ "type": "string",
1752
+ "min": 16,
1753
+ "max": 128
1754
+ },
1755
+ "region": {
1756
+ "type": "string",
1757
+ "max": 128
1758
+ }
1759
+ },
1760
+ "required": [
1761
+ "bucket",
1762
+ "accessKeyId",
1763
+ "secretAccessKey",
1764
+ "region"
1765
+ ],
1766
+ "additionalProperties": false
1767
+ },
1768
+ "gcs": {
1769
+ "type": "object",
1770
+ "properties": {
1771
+ "projectId": {
1772
+ "type": "string",
1773
+ "minLength": 1,
1774
+ "maxLength": 1024
1775
+ },
1776
+ "keyJson": {
1777
+ "type": "string",
1778
+ "maxLength": 32767,
1779
+ "minLength": 50
1780
+ },
1781
+ "bucket": {
1782
+ "type": "string",
1783
+ "max": 255
1784
+ }
1785
+ },
1786
+ "required": [
1787
+ "projectId",
1788
+ "keyJson",
1789
+ "bucket"
1790
+ ],
1791
+ "additionalProperties": false
1792
+ }
1793
+ },
1794
+ "additionalProperties": false
1455
1795
  }
1456
1796
  }
1457
1797
  }
@@ -1508,6 +1848,18 @@ Schema for a collection of Applications
1508
1848
  "eventCount": 0,
1509
1849
  "keyCount": 1,
1510
1850
  "deviceRecipeCount": 0
1851
+ },
1852
+ "archiveConfig": {
1853
+ "s3": {
1854
+ "bucket": "bucketName",
1855
+ "accessKeyId": "awsAccessKey",
1856
+ "accessSecretKey": "awsSecretKey",
1857
+ "region": "us-west-1"
1858
+ },
1859
+ "blackList": [
1860
+ "575ec8687ae143cd83dc4a95",
1861
+ "575ec8687ae143cd83dc4a91"
1862
+ ]
1511
1863
  }
1512
1864
  }
1513
1865
  ],
@@ -3963,6 +4315,33 @@ Schema for a collection of Data Table Rows
3963
4315
 
3964
4316
  <br/>
3965
4317
 
4318
+ ## Data Table Rows Delete
4319
+
4320
+ Schema for response to data table rows removal
4321
+
4322
+ ### <a name="data-table-rows-delete-schema"></a> Schema
4323
+
4324
+ ```json
4325
+ {
4326
+ "$schema": "http://json-schema.org/draft-04/schema#",
4327
+ "type": "object",
4328
+ "properties": {
4329
+ "removed": {
4330
+ "type": "Number"
4331
+ }
4332
+ }
4333
+ }
4334
+ ```
4335
+ ### <a name="data-table-rows-delete-example"></a> Example
4336
+
4337
+ ```json
4338
+ {
4339
+ "removed": 100
4340
+ }
4341
+ ```
4342
+
4343
+ <br/>
4344
+
3966
4345
  ## Data Table Export
3967
4346
 
3968
4347
  Schema for the body of a data table export
@@ -6662,19 +7041,40 @@ Schema for the body of an Experience Domain modification request
6662
7041
  "type": "object",
6663
7042
  "properties": {
6664
7043
  "sslKey": {
6665
- "type": "string",
6666
- "maxLength": 32767,
6667
- "minLength": 50
7044
+ "$oneOf": [
7045
+ {
7046
+ "type": "string",
7047
+ "maxLength": 32767,
7048
+ "minLength": 50
7049
+ },
7050
+ {
7051
+ "type": null
7052
+ }
7053
+ ]
6668
7054
  },
6669
7055
  "sslCert": {
6670
- "type": "string",
6671
- "maxLength": 32767,
6672
- "minLength": 50
7056
+ "$oneOf": [
7057
+ {
7058
+ "type": "string",
7059
+ "maxLength": 32767,
7060
+ "minLength": 50
7061
+ },
7062
+ {
7063
+ "type": null
7064
+ }
7065
+ ]
6673
7066
  },
6674
7067
  "sslBundle": {
6675
- "type": "string",
6676
- "maxLength": 32767,
6677
- "minLength": 50
7068
+ "$oneOf": [
7069
+ {
7070
+ "type": "string",
7071
+ "maxLength": 32767,
7072
+ "minLength": 50
7073
+ },
7074
+ {
7075
+ "type": null
7076
+ }
7077
+ ]
6678
7078
  },
6679
7079
  "domainName": {
6680
7080
  "type": "string",
@@ -8704,7 +9104,7 @@ Schema for a single Workflow
8704
9104
  "json": {
8705
9105
  "type": "string",
8706
9106
  "minLength": 1,
8707
- "maxLength": 2048
9107
+ "maxLength": 32767
8708
9108
  }
8709
9109
  },
8710
9110
  "additionalProperties": false,
@@ -8988,7 +9388,7 @@ Schema for the body of a Workflow modification request
8988
9388
  "json": {
8989
9389
  "type": "string",
8990
9390
  "minLength": 1,
8991
- "maxLength": 2048
9391
+ "maxLength": 32767
8992
9392
  }
8993
9393
  },
8994
9394
  "additionalProperties": false,
@@ -9144,7 +9544,7 @@ Schema for the body of a Workflow creation request
9144
9544
  "json": {
9145
9545
  "type": "string",
9146
9546
  "minLength": 1,
9147
- "maxLength": 2048
9547
+ "maxLength": 32767
9148
9548
  }
9149
9549
  },
9150
9550
  "additionalProperties": false,
@@ -9431,7 +9831,7 @@ Schema for a single Workflow Version
9431
9831
  "json": {
9432
9832
  "type": "string",
9433
9833
  "minLength": 1,
9434
- "maxLength": 2048
9834
+ "maxLength": 32767
9435
9835
  }
9436
9836
  },
9437
9837
  "additionalProperties": false,
@@ -9628,7 +10028,7 @@ Schema for the body of a Workflow Version creation request
9628
10028
  "json": {
9629
10029
  "type": "string",
9630
10030
  "minLength": 1,
9631
- "maxLength": 2048
10031
+ "maxLength": 32767
9632
10032
  }
9633
10033
  },
9634
10034
  "additionalProperties": false,
@@ -9818,7 +10218,7 @@ Schema for a collection of Workflow Versions
9818
10218
  "json": {
9819
10219
  "type": "string",
9820
10220
  "minLength": 1,
9821
- "maxLength": 2048
10221
+ "maxLength": 32767
9822
10222
  }
9823
10223
  },
9824
10224
  "additionalProperties": false,
@@ -10064,7 +10464,7 @@ Schema for a collection of Workflows
10064
10464
  "json": {
10065
10465
  "type": "string",
10066
10466
  "minLength": 1,
10067
- "maxLength": 2048
10467
+ "maxLength": 32767
10068
10468
  }
10069
10469
  },
10070
10470
  "additionalProperties": false,
@@ -14718,7 +15118,8 @@ Schema for a single Webhook
14718
15118
  "facebook",
14719
15119
  "fitbit",
14720
15120
  "none",
14721
- "twilio"
15121
+ "twilio",
15122
+ "alexa"
14722
15123
  ]
14723
15124
  },
14724
15125
  "verificationCode": {
@@ -14783,7 +15184,8 @@ Schema for the body of a Webhook modification request
14783
15184
  "facebook",
14784
15185
  "fitbit",
14785
15186
  "none",
14786
- "twilio"
15187
+ "twilio",
15188
+ "alexa"
14787
15189
  ]
14788
15190
  },
14789
15191
  "verificationCode": {
@@ -14843,7 +15245,8 @@ Schema for the body of a Webhook creation request
14843
15245
  "facebook",
14844
15246
  "fitbit",
14845
15247
  "none",
14846
- "twilio"
15248
+ "twilio",
15249
+ "alexa"
14847
15250
  ]
14848
15251
  },
14849
15252
  "verificationCode": {
@@ -14936,7 +15339,8 @@ Schema for a collection of Webhooks
14936
15339
  "facebook",
14937
15340
  "fitbit",
14938
15341
  "none",
14939
- "twilio"
15342
+ "twilio",
15343
+ "alexa"
14940
15344
  ]
14941
15345
  },
14942
15346
  "verificationCode": {