@cloudpdf/contract 3.0.0-next.7 → 3.0.0-next.9
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.
- package/dist/index.d.ts +266 -0
- package/dist/index.js +59 -0
- package/dist/index.js.map +1 -1
- package/dist/openapi.js +59 -0
- package/dist/openapi.js.map +1 -1
- package/openapi.json +1234 -409
- package/package.json +2 -2
package/openapi.json
CHANGED
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
"openapi": "3.1.0",
|
|
3
3
|
"info": {
|
|
4
4
|
"title": "CloudPDF Engine API",
|
|
5
|
-
"version": "3.0.0-next.
|
|
5
|
+
"version": "3.0.0-next.9",
|
|
6
6
|
"description": "The backend-callable surface of the CloudPDF document engine: deployment and tenant administration plus the document operations (reads, annotations, forms, page operations, redaction, download). Interactive viewing goes through the CloudPDF viewer SDKs, whose session protocol is deliberately not part of this API. Generated from the @cloudpdf/contract operation registry — do not edit by hand.",
|
|
7
7
|
"license": {
|
|
8
8
|
"name": "Apache-2.0",
|
|
@@ -1342,13 +1342,14 @@
|
|
|
1342
1342
|
}
|
|
1343
1343
|
}
|
|
1344
1344
|
},
|
|
1345
|
-
"/v1/docs/{docId}/layers/{layerName}/pages/
|
|
1345
|
+
"/v1/docs/{docId}/layers/{layerName}/pages/extract": {
|
|
1346
1346
|
"post": {
|
|
1347
|
-
"operationId": "doc.pages.
|
|
1347
|
+
"operationId": "doc.pages.extract",
|
|
1348
1348
|
"x-fern-sdk-group-name": ["doc", "pages"],
|
|
1349
|
-
"x-fern-sdk-method-name": "
|
|
1350
|
-
"x-docs-title": "
|
|
1351
|
-
"summary": "
|
|
1349
|
+
"x-fern-sdk-method-name": "extract",
|
|
1350
|
+
"x-docs-title": "Extract pages",
|
|
1351
|
+
"summary": "Export the listed pages, in order, as a standalone PDF.",
|
|
1352
|
+
"description": "A read, not a mutation: the source document is untouched and no event is published. Body is `{\"pageObjectNumbers\": number[]}`; the response body is the new PDF.",
|
|
1352
1353
|
"security": [
|
|
1353
1354
|
{
|
|
1354
1355
|
"apiToken": []
|
|
@@ -1358,7 +1359,7 @@
|
|
|
1358
1359
|
}
|
|
1359
1360
|
],
|
|
1360
1361
|
"x-required-scope": [],
|
|
1361
|
-
"x-required-capability": ["doc.
|
|
1362
|
+
"x-required-capability": ["doc.download"],
|
|
1362
1363
|
"parameters": [
|
|
1363
1364
|
{
|
|
1364
1365
|
"name": "docId",
|
|
@@ -1389,11 +1390,11 @@
|
|
|
1389
1390
|
}
|
|
1390
1391
|
],
|
|
1391
1392
|
"requestBody": {
|
|
1392
|
-
"required":
|
|
1393
|
+
"required": true,
|
|
1393
1394
|
"content": {
|
|
1394
1395
|
"application/json": {
|
|
1395
1396
|
"schema": {
|
|
1396
|
-
"$ref": "#/components/schemas/
|
|
1397
|
+
"$ref": "#/components/schemas/DocPagesExtractRequest"
|
|
1397
1398
|
}
|
|
1398
1399
|
}
|
|
1399
1400
|
}
|
|
@@ -1402,9 +1403,10 @@
|
|
|
1402
1403
|
"200": {
|
|
1403
1404
|
"description": "OK",
|
|
1404
1405
|
"content": {
|
|
1405
|
-
"application/
|
|
1406
|
+
"application/pdf": {
|
|
1406
1407
|
"schema": {
|
|
1407
|
-
"
|
|
1408
|
+
"type": "string",
|
|
1409
|
+
"format": "binary"
|
|
1408
1410
|
}
|
|
1409
1411
|
}
|
|
1410
1412
|
}
|
|
@@ -1414,7 +1416,7 @@
|
|
|
1414
1416
|
"content": {
|
|
1415
1417
|
"application/json": {
|
|
1416
1418
|
"schema": {
|
|
1417
|
-
"$ref": "#/components/schemas/
|
|
1419
|
+
"$ref": "#/components/schemas/DocPagesExtract400Response"
|
|
1418
1420
|
}
|
|
1419
1421
|
}
|
|
1420
1422
|
}
|
|
@@ -1424,7 +1426,7 @@
|
|
|
1424
1426
|
"content": {
|
|
1425
1427
|
"application/json": {
|
|
1426
1428
|
"schema": {
|
|
1427
|
-
"$ref": "#/components/schemas/
|
|
1429
|
+
"$ref": "#/components/schemas/DocPagesExtract404Response"
|
|
1428
1430
|
}
|
|
1429
1431
|
}
|
|
1430
1432
|
}
|
|
@@ -1442,13 +1444,13 @@
|
|
|
1442
1444
|
}
|
|
1443
1445
|
}
|
|
1444
1446
|
},
|
|
1445
|
-
"/v1/docs/{docId}/layers/{layerName}/pages/
|
|
1447
|
+
"/v1/docs/{docId}/layers/{layerName}/pages/flatten": {
|
|
1446
1448
|
"post": {
|
|
1447
|
-
"operationId": "doc.pages.
|
|
1449
|
+
"operationId": "doc.pages.flatten",
|
|
1448
1450
|
"x-fern-sdk-group-name": ["doc", "pages"],
|
|
1449
|
-
"x-fern-sdk-method-name": "
|
|
1450
|
-
"x-docs-title": "
|
|
1451
|
-
"summary": "
|
|
1451
|
+
"x-fern-sdk-method-name": "flatten",
|
|
1452
|
+
"x-docs-title": "Flatten pages",
|
|
1453
|
+
"summary": "Flatten annotations and form fields into page content.",
|
|
1452
1454
|
"security": [
|
|
1453
1455
|
{
|
|
1454
1456
|
"apiToken": []
|
|
@@ -1458,7 +1460,7 @@
|
|
|
1458
1460
|
}
|
|
1459
1461
|
],
|
|
1460
1462
|
"x-required-scope": [],
|
|
1461
|
-
"x-required-capability": ["doc.pages.
|
|
1463
|
+
"x-required-capability": ["doc.pages.modify", "doc.annotate.modify"],
|
|
1462
1464
|
"parameters": [
|
|
1463
1465
|
{
|
|
1464
1466
|
"name": "docId",
|
|
@@ -1489,11 +1491,11 @@
|
|
|
1489
1491
|
}
|
|
1490
1492
|
],
|
|
1491
1493
|
"requestBody": {
|
|
1492
|
-
"required":
|
|
1494
|
+
"required": false,
|
|
1493
1495
|
"content": {
|
|
1494
1496
|
"application/json": {
|
|
1495
1497
|
"schema": {
|
|
1496
|
-
"$ref": "#/components/schemas/
|
|
1498
|
+
"$ref": "#/components/schemas/DocPagesFlattenRequest"
|
|
1497
1499
|
}
|
|
1498
1500
|
}
|
|
1499
1501
|
}
|
|
@@ -1504,7 +1506,7 @@
|
|
|
1504
1506
|
"content": {
|
|
1505
1507
|
"application/json": {
|
|
1506
1508
|
"schema": {
|
|
1507
|
-
"$ref": "#/components/schemas/
|
|
1509
|
+
"$ref": "#/components/schemas/DocPagesFlatten200Response"
|
|
1508
1510
|
}
|
|
1509
1511
|
}
|
|
1510
1512
|
}
|
|
@@ -1514,7 +1516,7 @@
|
|
|
1514
1516
|
"content": {
|
|
1515
1517
|
"application/json": {
|
|
1516
1518
|
"schema": {
|
|
1517
|
-
"$ref": "#/components/schemas/
|
|
1519
|
+
"$ref": "#/components/schemas/DocPagesFlatten400Response"
|
|
1518
1520
|
}
|
|
1519
1521
|
}
|
|
1520
1522
|
}
|
|
@@ -1524,7 +1526,7 @@
|
|
|
1524
1526
|
"content": {
|
|
1525
1527
|
"application/json": {
|
|
1526
1528
|
"schema": {
|
|
1527
|
-
"$ref": "#/components/schemas/
|
|
1529
|
+
"$ref": "#/components/schemas/DocPagesFlatten404Response"
|
|
1528
1530
|
}
|
|
1529
1531
|
}
|
|
1530
1532
|
}
|
|
@@ -1542,13 +1544,14 @@
|
|
|
1542
1544
|
}
|
|
1543
1545
|
}
|
|
1544
1546
|
},
|
|
1545
|
-
"/v1/docs/{docId}/layers/{layerName}/pages/
|
|
1547
|
+
"/v1/docs/{docId}/layers/{layerName}/pages/insert": {
|
|
1546
1548
|
"post": {
|
|
1547
|
-
"operationId": "doc.pages.
|
|
1549
|
+
"operationId": "doc.pages.insert",
|
|
1548
1550
|
"x-fern-sdk-group-name": ["doc", "pages"],
|
|
1549
|
-
"x-fern-sdk-method-name": "
|
|
1550
|
-
"x-docs-title": "
|
|
1551
|
-
"summary": "
|
|
1551
|
+
"x-fern-sdk-method-name": "insert",
|
|
1552
|
+
"x-docs-title": "Insert pages from a PDF",
|
|
1553
|
+
"summary": "Copy every page of an uploaded PDF into the document at an index.",
|
|
1554
|
+
"description": "Multipart mutation envelope: a `body` field holding `{\"destIndex\"?: number}` (omitted → append) plus a `resource:source` file part carrying the standalone PDF whose pages are copied in. The inserted copies get fresh page object numbers, returned in insertion order.",
|
|
1552
1555
|
"security": [
|
|
1553
1556
|
{
|
|
1554
1557
|
"apiToken": []
|
|
@@ -1591,9 +1594,16 @@
|
|
|
1591
1594
|
"requestBody": {
|
|
1592
1595
|
"required": true,
|
|
1593
1596
|
"content": {
|
|
1594
|
-
"
|
|
1597
|
+
"multipart/form-data": {
|
|
1595
1598
|
"schema": {
|
|
1596
|
-
"
|
|
1599
|
+
"type": "object",
|
|
1600
|
+
"properties": {
|
|
1601
|
+
"file": {
|
|
1602
|
+
"type": "string",
|
|
1603
|
+
"format": "binary"
|
|
1604
|
+
}
|
|
1605
|
+
},
|
|
1606
|
+
"required": ["file"]
|
|
1597
1607
|
}
|
|
1598
1608
|
}
|
|
1599
1609
|
}
|
|
@@ -1604,7 +1614,7 @@
|
|
|
1604
1614
|
"content": {
|
|
1605
1615
|
"application/json": {
|
|
1606
1616
|
"schema": {
|
|
1607
|
-
"$ref": "#/components/schemas/
|
|
1617
|
+
"$ref": "#/components/schemas/DocPagesInsert200Response"
|
|
1608
1618
|
}
|
|
1609
1619
|
}
|
|
1610
1620
|
}
|
|
@@ -1614,7 +1624,7 @@
|
|
|
1614
1624
|
"content": {
|
|
1615
1625
|
"application/json": {
|
|
1616
1626
|
"schema": {
|
|
1617
|
-
"$ref": "#/components/schemas/
|
|
1627
|
+
"$ref": "#/components/schemas/DocPagesInsert400Response"
|
|
1618
1628
|
}
|
|
1619
1629
|
}
|
|
1620
1630
|
}
|
|
@@ -1624,7 +1634,7 @@
|
|
|
1624
1634
|
"content": {
|
|
1625
1635
|
"application/json": {
|
|
1626
1636
|
"schema": {
|
|
1627
|
-
"$ref": "#/components/schemas/
|
|
1637
|
+
"$ref": "#/components/schemas/DocPagesInsert404Response"
|
|
1628
1638
|
}
|
|
1629
1639
|
}
|
|
1630
1640
|
}
|
|
@@ -1642,13 +1652,14 @@
|
|
|
1642
1652
|
}
|
|
1643
1653
|
}
|
|
1644
1654
|
},
|
|
1645
|
-
"/v1/docs/{docId}/layers/{layerName}/
|
|
1655
|
+
"/v1/docs/{docId}/layers/{layerName}/pages/insert-blank": {
|
|
1646
1656
|
"post": {
|
|
1647
|
-
"operationId": "doc.
|
|
1648
|
-
"x-fern-sdk-group-name": ["doc", "
|
|
1649
|
-
"x-fern-sdk-method-name": "
|
|
1650
|
-
"x-docs-title": "
|
|
1651
|
-
"summary": "
|
|
1657
|
+
"operationId": "doc.pages.insertBlank",
|
|
1658
|
+
"x-fern-sdk-group-name": ["doc", "pages"],
|
|
1659
|
+
"x-fern-sdk-method-name": "insertBlank",
|
|
1660
|
+
"x-docs-title": "Insert blank pages",
|
|
1661
|
+
"summary": "Create blank pages of an explicit size at an index.",
|
|
1662
|
+
"description": "Body is `{\"size\": {\"width\", \"height\"}, \"count\"?, \"destIndex\"?}` — size in PDF points, count in [1, 100], destIndex omitted → append.",
|
|
1652
1663
|
"security": [
|
|
1653
1664
|
{
|
|
1654
1665
|
"apiToken": []
|
|
@@ -1658,7 +1669,7 @@
|
|
|
1658
1669
|
}
|
|
1659
1670
|
],
|
|
1660
1671
|
"x-required-scope": [],
|
|
1661
|
-
"x-required-capability": ["doc.pages.
|
|
1672
|
+
"x-required-capability": ["doc.pages.assemble"],
|
|
1662
1673
|
"parameters": [
|
|
1663
1674
|
{
|
|
1664
1675
|
"name": "docId",
|
|
@@ -1689,11 +1700,11 @@
|
|
|
1689
1700
|
}
|
|
1690
1701
|
],
|
|
1691
1702
|
"requestBody": {
|
|
1692
|
-
"required":
|
|
1703
|
+
"required": true,
|
|
1693
1704
|
"content": {
|
|
1694
1705
|
"application/json": {
|
|
1695
1706
|
"schema": {
|
|
1696
|
-
"$ref": "#/components/schemas/
|
|
1707
|
+
"$ref": "#/components/schemas/DocPagesInsertBlankRequest"
|
|
1697
1708
|
}
|
|
1698
1709
|
}
|
|
1699
1710
|
}
|
|
@@ -1704,7 +1715,7 @@
|
|
|
1704
1715
|
"content": {
|
|
1705
1716
|
"application/json": {
|
|
1706
1717
|
"schema": {
|
|
1707
|
-
"$ref": "#/components/schemas/
|
|
1718
|
+
"$ref": "#/components/schemas/DocPagesInsertBlank200Response"
|
|
1708
1719
|
}
|
|
1709
1720
|
}
|
|
1710
1721
|
}
|
|
@@ -1714,7 +1725,7 @@
|
|
|
1714
1725
|
"content": {
|
|
1715
1726
|
"application/json": {
|
|
1716
1727
|
"schema": {
|
|
1717
|
-
"$ref": "#/components/schemas/
|
|
1728
|
+
"$ref": "#/components/schemas/DocPagesInsertBlank400Response"
|
|
1718
1729
|
}
|
|
1719
1730
|
}
|
|
1720
1731
|
}
|
|
@@ -1724,7 +1735,7 @@
|
|
|
1724
1735
|
"content": {
|
|
1725
1736
|
"application/json": {
|
|
1726
1737
|
"schema": {
|
|
1727
|
-
"$ref": "#/components/schemas/
|
|
1738
|
+
"$ref": "#/components/schemas/DocPagesInsertBlank404Response"
|
|
1728
1739
|
}
|
|
1729
1740
|
}
|
|
1730
1741
|
}
|
|
@@ -1742,14 +1753,13 @@
|
|
|
1742
1753
|
}
|
|
1743
1754
|
}
|
|
1744
1755
|
},
|
|
1745
|
-
"/v1/docs/{docId}/layers/{layerName}/
|
|
1746
|
-
"
|
|
1747
|
-
"operationId": "doc.
|
|
1748
|
-
"x-fern-sdk-group-name": ["doc"],
|
|
1749
|
-
"x-fern-sdk-method-name": "
|
|
1750
|
-
"x-docs-title": "
|
|
1751
|
-
"summary": "
|
|
1752
|
-
"description": "Render parameters (viewport, format) pass as flat dotted query keys, e.g. `?viewport.kind=width&viewport.width=800`; the full grammar is documented with the viewer.",
|
|
1756
|
+
"/v1/docs/{docId}/layers/{layerName}/pages/move": {
|
|
1757
|
+
"post": {
|
|
1758
|
+
"operationId": "doc.pages.move",
|
|
1759
|
+
"x-fern-sdk-group-name": ["doc", "pages"],
|
|
1760
|
+
"x-fern-sdk-method-name": "move",
|
|
1761
|
+
"x-docs-title": "Move pages",
|
|
1762
|
+
"summary": "Reorder pages.",
|
|
1753
1763
|
"security": [
|
|
1754
1764
|
{
|
|
1755
1765
|
"apiToken": []
|
|
@@ -1759,7 +1769,7 @@
|
|
|
1759
1769
|
}
|
|
1760
1770
|
],
|
|
1761
1771
|
"x-required-scope": [],
|
|
1762
|
-
"x-required-capability": ["doc.
|
|
1772
|
+
"x-required-capability": ["doc.pages.assemble"],
|
|
1763
1773
|
"parameters": [
|
|
1764
1774
|
{
|
|
1765
1775
|
"name": "docId",
|
|
@@ -1779,15 +1789,6 @@
|
|
|
1779
1789
|
"minLength": 1
|
|
1780
1790
|
}
|
|
1781
1791
|
},
|
|
1782
|
-
{
|
|
1783
|
-
"name": "pon",
|
|
1784
|
-
"in": "path",
|
|
1785
|
-
"required": true,
|
|
1786
|
-
"schema": {
|
|
1787
|
-
"type": "integer",
|
|
1788
|
-
"minimum": 0
|
|
1789
|
-
}
|
|
1790
|
-
},
|
|
1791
1792
|
{
|
|
1792
1793
|
"name": "X-Document-Password",
|
|
1793
1794
|
"in": "header",
|
|
@@ -1798,14 +1799,33 @@
|
|
|
1798
1799
|
}
|
|
1799
1800
|
}
|
|
1800
1801
|
],
|
|
1802
|
+
"requestBody": {
|
|
1803
|
+
"required": true,
|
|
1804
|
+
"content": {
|
|
1805
|
+
"application/json": {
|
|
1806
|
+
"schema": {
|
|
1807
|
+
"$ref": "#/components/schemas/DocPagesMoveRequest"
|
|
1808
|
+
}
|
|
1809
|
+
}
|
|
1810
|
+
}
|
|
1811
|
+
},
|
|
1801
1812
|
"responses": {
|
|
1802
1813
|
"200": {
|
|
1803
1814
|
"description": "OK",
|
|
1804
1815
|
"content": {
|
|
1805
|
-
"
|
|
1816
|
+
"application/json": {
|
|
1806
1817
|
"schema": {
|
|
1807
|
-
"
|
|
1808
|
-
|
|
1818
|
+
"$ref": "#/components/schemas/DocPagesMove200Response"
|
|
1819
|
+
}
|
|
1820
|
+
}
|
|
1821
|
+
}
|
|
1822
|
+
},
|
|
1823
|
+
"400": {
|
|
1824
|
+
"description": "Bad request",
|
|
1825
|
+
"content": {
|
|
1826
|
+
"application/json": {
|
|
1827
|
+
"schema": {
|
|
1828
|
+
"$ref": "#/components/schemas/DocPagesMove400Response"
|
|
1809
1829
|
}
|
|
1810
1830
|
}
|
|
1811
1831
|
}
|
|
@@ -1815,7 +1835,7 @@
|
|
|
1815
1835
|
"content": {
|
|
1816
1836
|
"application/json": {
|
|
1817
1837
|
"schema": {
|
|
1818
|
-
"$ref": "#/components/schemas/
|
|
1838
|
+
"$ref": "#/components/schemas/DocPagesMove404Response"
|
|
1819
1839
|
}
|
|
1820
1840
|
}
|
|
1821
1841
|
}
|
|
@@ -1833,13 +1853,13 @@
|
|
|
1833
1853
|
}
|
|
1834
1854
|
}
|
|
1835
1855
|
},
|
|
1836
|
-
"/v1/docs/{docId}/layers/{layerName}/
|
|
1837
|
-
"
|
|
1838
|
-
"operationId": "doc.
|
|
1839
|
-
"x-fern-sdk-group-name": ["doc"],
|
|
1840
|
-
"x-fern-sdk-method-name": "
|
|
1841
|
-
"x-docs-title": "
|
|
1842
|
-
"summary": "
|
|
1856
|
+
"/v1/docs/{docId}/layers/{layerName}/pages/rotate": {
|
|
1857
|
+
"post": {
|
|
1858
|
+
"operationId": "doc.pages.rotate",
|
|
1859
|
+
"x-fern-sdk-group-name": ["doc", "pages"],
|
|
1860
|
+
"x-fern-sdk-method-name": "rotate",
|
|
1861
|
+
"x-docs-title": "Rotate pages",
|
|
1862
|
+
"summary": "Set absolute rotation on pages.",
|
|
1843
1863
|
"security": [
|
|
1844
1864
|
{
|
|
1845
1865
|
"apiToken": []
|
|
@@ -1849,7 +1869,7 @@
|
|
|
1849
1869
|
}
|
|
1850
1870
|
],
|
|
1851
1871
|
"x-required-scope": [],
|
|
1852
|
-
"x-required-capability": ["doc.
|
|
1872
|
+
"x-required-capability": ["doc.pages.assemble"],
|
|
1853
1873
|
"parameters": [
|
|
1854
1874
|
{
|
|
1855
1875
|
"name": "docId",
|
|
@@ -1869,15 +1889,6 @@
|
|
|
1869
1889
|
"minLength": 1
|
|
1870
1890
|
}
|
|
1871
1891
|
},
|
|
1872
|
-
{
|
|
1873
|
-
"name": "pon",
|
|
1874
|
-
"in": "path",
|
|
1875
|
-
"required": true,
|
|
1876
|
-
"schema": {
|
|
1877
|
-
"type": "integer",
|
|
1878
|
-
"minimum": 0
|
|
1879
|
-
}
|
|
1880
|
-
},
|
|
1881
1892
|
{
|
|
1882
1893
|
"name": "X-Document-Password",
|
|
1883
1894
|
"in": "header",
|
|
@@ -1888,13 +1899,33 @@
|
|
|
1888
1899
|
}
|
|
1889
1900
|
}
|
|
1890
1901
|
],
|
|
1902
|
+
"requestBody": {
|
|
1903
|
+
"required": true,
|
|
1904
|
+
"content": {
|
|
1905
|
+
"application/json": {
|
|
1906
|
+
"schema": {
|
|
1907
|
+
"$ref": "#/components/schemas/DocPagesRotateRequest"
|
|
1908
|
+
}
|
|
1909
|
+
}
|
|
1910
|
+
}
|
|
1911
|
+
},
|
|
1891
1912
|
"responses": {
|
|
1892
1913
|
"200": {
|
|
1893
1914
|
"description": "OK",
|
|
1894
1915
|
"content": {
|
|
1895
1916
|
"application/json": {
|
|
1896
1917
|
"schema": {
|
|
1897
|
-
"$ref": "#/components/schemas/
|
|
1918
|
+
"$ref": "#/components/schemas/DocPagesRotate200Response"
|
|
1919
|
+
}
|
|
1920
|
+
}
|
|
1921
|
+
}
|
|
1922
|
+
},
|
|
1923
|
+
"400": {
|
|
1924
|
+
"description": "Bad request",
|
|
1925
|
+
"content": {
|
|
1926
|
+
"application/json": {
|
|
1927
|
+
"schema": {
|
|
1928
|
+
"$ref": "#/components/schemas/DocPagesRotate400Response"
|
|
1898
1929
|
}
|
|
1899
1930
|
}
|
|
1900
1931
|
}
|
|
@@ -1904,7 +1935,7 @@
|
|
|
1904
1935
|
"content": {
|
|
1905
1936
|
"application/json": {
|
|
1906
1937
|
"schema": {
|
|
1907
|
-
"$ref": "#/components/schemas/
|
|
1938
|
+
"$ref": "#/components/schemas/DocPagesRotate404Response"
|
|
1908
1939
|
}
|
|
1909
1940
|
}
|
|
1910
1941
|
}
|
|
@@ -1922,22 +1953,58 @@
|
|
|
1922
1953
|
}
|
|
1923
1954
|
}
|
|
1924
1955
|
},
|
|
1925
|
-
"/v1/
|
|
1956
|
+
"/v1/docs/{docId}/layers/{layerName}/redactions/apply": {
|
|
1926
1957
|
"post": {
|
|
1927
|
-
"operationId": "
|
|
1928
|
-
"x-fern-sdk-group-name": ["
|
|
1929
|
-
"x-fern-sdk-method-name": "
|
|
1930
|
-
"x-docs-title": "
|
|
1931
|
-
"summary": "
|
|
1932
|
-
"
|
|
1933
|
-
|
|
1958
|
+
"operationId": "doc.redactions.apply",
|
|
1959
|
+
"x-fern-sdk-group-name": ["doc", "redactions"],
|
|
1960
|
+
"x-fern-sdk-method-name": "apply",
|
|
1961
|
+
"x-docs-title": "Apply redactions",
|
|
1962
|
+
"summary": "Apply pending redactions, permanently removing content.",
|
|
1963
|
+
"security": [
|
|
1964
|
+
{
|
|
1965
|
+
"apiToken": []
|
|
1966
|
+
},
|
|
1967
|
+
{
|
|
1968
|
+
"docToken": []
|
|
1969
|
+
}
|
|
1970
|
+
],
|
|
1934
1971
|
"x-required-scope": [],
|
|
1972
|
+
"x-required-capability": ["doc.pages.modify", "doc.annotate.modify", "doc.redact"],
|
|
1973
|
+
"parameters": [
|
|
1974
|
+
{
|
|
1975
|
+
"name": "docId",
|
|
1976
|
+
"in": "path",
|
|
1977
|
+
"required": true,
|
|
1978
|
+
"schema": {
|
|
1979
|
+
"type": "string",
|
|
1980
|
+
"pattern": "^[A-Za-z0-9_-]+$"
|
|
1981
|
+
}
|
|
1982
|
+
},
|
|
1983
|
+
{
|
|
1984
|
+
"name": "layerName",
|
|
1985
|
+
"in": "path",
|
|
1986
|
+
"required": true,
|
|
1987
|
+
"schema": {
|
|
1988
|
+
"type": "string",
|
|
1989
|
+
"minLength": 1
|
|
1990
|
+
}
|
|
1991
|
+
},
|
|
1992
|
+
{
|
|
1993
|
+
"name": "X-Document-Password",
|
|
1994
|
+
"in": "header",
|
|
1995
|
+
"required": false,
|
|
1996
|
+
"description": "Base64-encoded password for an encrypted document. Valid only with the API token (403 anywhere else). An encrypted document answers 422 DocPasswordRequired when the header is absent. Viewer doc JWTs use the SDK password-session flow instead.",
|
|
1997
|
+
"schema": {
|
|
1998
|
+
"type": "string"
|
|
1999
|
+
}
|
|
2000
|
+
}
|
|
2001
|
+
],
|
|
1935
2002
|
"requestBody": {
|
|
1936
|
-
"required":
|
|
2003
|
+
"required": false,
|
|
1937
2004
|
"content": {
|
|
1938
2005
|
"application/json": {
|
|
1939
2006
|
"schema": {
|
|
1940
|
-
"$ref": "#/components/schemas/
|
|
2007
|
+
"$ref": "#/components/schemas/DocRedactionsApplyRequest"
|
|
1941
2008
|
}
|
|
1942
2009
|
}
|
|
1943
2010
|
}
|
|
@@ -1948,7 +2015,7 @@
|
|
|
1948
2015
|
"content": {
|
|
1949
2016
|
"application/json": {
|
|
1950
2017
|
"schema": {
|
|
1951
|
-
"$ref": "#/components/schemas/
|
|
2018
|
+
"$ref": "#/components/schemas/DocRedactionsApply200Response"
|
|
1952
2019
|
}
|
|
1953
2020
|
}
|
|
1954
2021
|
}
|
|
@@ -1958,17 +2025,7 @@
|
|
|
1958
2025
|
"content": {
|
|
1959
2026
|
"application/json": {
|
|
1960
2027
|
"schema": {
|
|
1961
|
-
"$ref": "#/components/schemas/
|
|
1962
|
-
}
|
|
1963
|
-
}
|
|
1964
|
-
}
|
|
1965
|
-
},
|
|
1966
|
-
"403": {
|
|
1967
|
-
"description": "Forbidden",
|
|
1968
|
-
"content": {
|
|
1969
|
-
"application/json": {
|
|
1970
|
-
"schema": {
|
|
1971
|
-
"$ref": "#/components/schemas/SharesExchange403Response"
|
|
2028
|
+
"$ref": "#/components/schemas/DocRedactionsApply400Response"
|
|
1972
2029
|
}
|
|
1973
2030
|
}
|
|
1974
2031
|
}
|
|
@@ -1978,37 +2035,17 @@
|
|
|
1978
2035
|
"content": {
|
|
1979
2036
|
"application/json": {
|
|
1980
2037
|
"schema": {
|
|
1981
|
-
"$ref": "#/components/schemas/
|
|
2038
|
+
"$ref": "#/components/schemas/DocRedactionsApply404Response"
|
|
1982
2039
|
}
|
|
1983
2040
|
}
|
|
1984
2041
|
}
|
|
1985
2042
|
},
|
|
1986
|
-
"
|
|
1987
|
-
"description": "
|
|
2043
|
+
"default": {
|
|
2044
|
+
"description": "Error",
|
|
1988
2045
|
"content": {
|
|
1989
2046
|
"application/json": {
|
|
1990
2047
|
"schema": {
|
|
1991
|
-
"$ref": "#/components/schemas/
|
|
1992
|
-
}
|
|
1993
|
-
}
|
|
1994
|
-
}
|
|
1995
|
-
},
|
|
1996
|
-
"422": {
|
|
1997
|
-
"description": "Unprocessable",
|
|
1998
|
-
"content": {
|
|
1999
|
-
"application/json": {
|
|
2000
|
-
"schema": {
|
|
2001
|
-
"$ref": "#/components/schemas/SharesExchange422Response"
|
|
2002
|
-
}
|
|
2003
|
-
}
|
|
2004
|
-
}
|
|
2005
|
-
},
|
|
2006
|
-
"default": {
|
|
2007
|
-
"description": "Error",
|
|
2008
|
-
"content": {
|
|
2009
|
-
"application/json": {
|
|
2010
|
-
"schema": {
|
|
2011
|
-
"$ref": "#/components/schemas/AdminErrorPayload"
|
|
2048
|
+
"$ref": "#/components/schemas/EngineErrorPayload"
|
|
2012
2049
|
}
|
|
2013
2050
|
}
|
|
2014
2051
|
}
|
|
@@ -2016,46 +2053,80 @@
|
|
|
2016
2053
|
}
|
|
2017
2054
|
}
|
|
2018
2055
|
},
|
|
2019
|
-
"/v1/
|
|
2020
|
-
"
|
|
2021
|
-
"operationId": "
|
|
2022
|
-
"x-fern-sdk-group-name": ["
|
|
2023
|
-
"x-fern-sdk-method-name": "
|
|
2024
|
-
"x-docs-title": "
|
|
2025
|
-
"summary": "
|
|
2056
|
+
"/v1/docs/{docId}/layers/{layerName}/render/pages/{pon}/data": {
|
|
2057
|
+
"get": {
|
|
2058
|
+
"operationId": "doc.render",
|
|
2059
|
+
"x-fern-sdk-group-name": ["doc"],
|
|
2060
|
+
"x-fern-sdk-method-name": "render",
|
|
2061
|
+
"x-docs-title": "Render page",
|
|
2062
|
+
"summary": "Render one page as an image at the current layer version.",
|
|
2063
|
+
"description": "Render parameters (viewport, format) pass as flat dotted query keys, e.g. `?viewport.kind=width&viewport.width=800`; the full grammar is documented with the viewer.",
|
|
2026
2064
|
"security": [
|
|
2027
2065
|
{
|
|
2028
2066
|
"apiToken": []
|
|
2067
|
+
},
|
|
2068
|
+
{
|
|
2069
|
+
"docToken": []
|
|
2029
2070
|
}
|
|
2030
2071
|
],
|
|
2031
2072
|
"x-required-scope": [],
|
|
2032
|
-
"
|
|
2033
|
-
|
|
2034
|
-
|
|
2035
|
-
"
|
|
2036
|
-
|
|
2037
|
-
|
|
2038
|
-
|
|
2073
|
+
"x-required-capability": ["doc.render"],
|
|
2074
|
+
"parameters": [
|
|
2075
|
+
{
|
|
2076
|
+
"name": "docId",
|
|
2077
|
+
"in": "path",
|
|
2078
|
+
"required": true,
|
|
2079
|
+
"schema": {
|
|
2080
|
+
"type": "string",
|
|
2081
|
+
"pattern": "^[A-Za-z0-9_-]+$"
|
|
2082
|
+
}
|
|
2083
|
+
},
|
|
2084
|
+
{
|
|
2085
|
+
"name": "layerName",
|
|
2086
|
+
"in": "path",
|
|
2087
|
+
"required": true,
|
|
2088
|
+
"schema": {
|
|
2089
|
+
"type": "string",
|
|
2090
|
+
"minLength": 1
|
|
2091
|
+
}
|
|
2092
|
+
},
|
|
2093
|
+
{
|
|
2094
|
+
"name": "pon",
|
|
2095
|
+
"in": "path",
|
|
2096
|
+
"required": true,
|
|
2097
|
+
"schema": {
|
|
2098
|
+
"type": "integer",
|
|
2099
|
+
"minimum": 0
|
|
2100
|
+
}
|
|
2101
|
+
},
|
|
2102
|
+
{
|
|
2103
|
+
"name": "X-Document-Password",
|
|
2104
|
+
"in": "header",
|
|
2105
|
+
"required": false,
|
|
2106
|
+
"description": "Base64-encoded password for an encrypted document. Valid only with the API token (403 anywhere else). An encrypted document answers 422 DocPasswordRequired when the header is absent. Viewer doc JWTs use the SDK password-session flow instead.",
|
|
2107
|
+
"schema": {
|
|
2108
|
+
"type": "string"
|
|
2039
2109
|
}
|
|
2040
2110
|
}
|
|
2041
|
-
|
|
2111
|
+
],
|
|
2042
2112
|
"responses": {
|
|
2043
2113
|
"200": {
|
|
2044
2114
|
"description": "OK",
|
|
2045
2115
|
"content": {
|
|
2046
|
-
"
|
|
2116
|
+
"image/webp": {
|
|
2047
2117
|
"schema": {
|
|
2048
|
-
"
|
|
2118
|
+
"type": "string",
|
|
2119
|
+
"format": "binary"
|
|
2049
2120
|
}
|
|
2050
2121
|
}
|
|
2051
2122
|
}
|
|
2052
2123
|
},
|
|
2053
|
-
"
|
|
2054
|
-
"description": "
|
|
2124
|
+
"404": {
|
|
2125
|
+
"description": "Not found",
|
|
2055
2126
|
"content": {
|
|
2056
2127
|
"application/json": {
|
|
2057
2128
|
"schema": {
|
|
2058
|
-
"$ref": "#/components/schemas/
|
|
2129
|
+
"$ref": "#/components/schemas/DocRenderResponse"
|
|
2059
2130
|
}
|
|
2060
2131
|
}
|
|
2061
2132
|
}
|
|
@@ -2065,45 +2136,67 @@
|
|
|
2065
2136
|
"content": {
|
|
2066
2137
|
"application/json": {
|
|
2067
2138
|
"schema": {
|
|
2068
|
-
"$ref": "#/components/schemas/
|
|
2139
|
+
"$ref": "#/components/schemas/EngineErrorPayload"
|
|
2069
2140
|
}
|
|
2070
2141
|
}
|
|
2071
2142
|
}
|
|
2072
2143
|
}
|
|
2073
2144
|
}
|
|
2074
|
-
}
|
|
2145
|
+
}
|
|
2146
|
+
},
|
|
2147
|
+
"/v1/docs/{docId}/layers/{layerName}/text/pages/{pon}/data": {
|
|
2075
2148
|
"get": {
|
|
2076
|
-
"operationId": "
|
|
2077
|
-
"x-fern-sdk-group-name": ["
|
|
2078
|
-
"x-fern-sdk-method-name": "
|
|
2079
|
-
"x-docs-title": "
|
|
2080
|
-
"summary": "
|
|
2149
|
+
"operationId": "doc.text",
|
|
2150
|
+
"x-fern-sdk-group-name": ["doc"],
|
|
2151
|
+
"x-fern-sdk-method-name": "text",
|
|
2152
|
+
"x-docs-title": "Extract page text",
|
|
2153
|
+
"summary": "Extracted text content for one page.",
|
|
2081
2154
|
"security": [
|
|
2082
2155
|
{
|
|
2083
2156
|
"apiToken": []
|
|
2157
|
+
},
|
|
2158
|
+
{
|
|
2159
|
+
"docToken": []
|
|
2084
2160
|
}
|
|
2085
2161
|
],
|
|
2086
2162
|
"x-required-scope": [],
|
|
2163
|
+
"x-required-capability": ["doc.text.copy"],
|
|
2087
2164
|
"parameters": [
|
|
2088
2165
|
{
|
|
2089
|
-
"name": "
|
|
2090
|
-
"in": "
|
|
2091
|
-
"required":
|
|
2166
|
+
"name": "docId",
|
|
2167
|
+
"in": "path",
|
|
2168
|
+
"required": true,
|
|
2092
2169
|
"schema": {
|
|
2093
|
-
"type": "
|
|
2094
|
-
"
|
|
2095
|
-
"maximum": 200,
|
|
2096
|
-
"default": 100
|
|
2170
|
+
"type": "string",
|
|
2171
|
+
"pattern": "^[A-Za-z0-9_-]+$"
|
|
2097
2172
|
}
|
|
2098
2173
|
},
|
|
2099
2174
|
{
|
|
2100
|
-
"name": "
|
|
2101
|
-
"in": "
|
|
2102
|
-
"required":
|
|
2175
|
+
"name": "layerName",
|
|
2176
|
+
"in": "path",
|
|
2177
|
+
"required": true,
|
|
2103
2178
|
"schema": {
|
|
2104
2179
|
"type": "string",
|
|
2105
2180
|
"minLength": 1
|
|
2106
2181
|
}
|
|
2182
|
+
},
|
|
2183
|
+
{
|
|
2184
|
+
"name": "pon",
|
|
2185
|
+
"in": "path",
|
|
2186
|
+
"required": true,
|
|
2187
|
+
"schema": {
|
|
2188
|
+
"type": "integer",
|
|
2189
|
+
"minimum": 0
|
|
2190
|
+
}
|
|
2191
|
+
},
|
|
2192
|
+
{
|
|
2193
|
+
"name": "X-Document-Password",
|
|
2194
|
+
"in": "header",
|
|
2195
|
+
"required": false,
|
|
2196
|
+
"description": "Base64-encoded password for an encrypted document. Valid only with the API token (403 anywhere else). An encrypted document answers 422 DocPasswordRequired when the header is absent. Viewer doc JWTs use the SDK password-session flow instead.",
|
|
2197
|
+
"schema": {
|
|
2198
|
+
"type": "string"
|
|
2199
|
+
}
|
|
2107
2200
|
}
|
|
2108
2201
|
],
|
|
2109
2202
|
"responses": {
|
|
@@ -2112,17 +2205,17 @@
|
|
|
2112
2205
|
"content": {
|
|
2113
2206
|
"application/json": {
|
|
2114
2207
|
"schema": {
|
|
2115
|
-
"$ref": "#/components/schemas/
|
|
2208
|
+
"$ref": "#/components/schemas/DocText200Response"
|
|
2116
2209
|
}
|
|
2117
2210
|
}
|
|
2118
2211
|
}
|
|
2119
2212
|
},
|
|
2120
|
-
"
|
|
2121
|
-
"description": "
|
|
2213
|
+
"404": {
|
|
2214
|
+
"description": "Not found",
|
|
2122
2215
|
"content": {
|
|
2123
2216
|
"application/json": {
|
|
2124
2217
|
"schema": {
|
|
2125
|
-
"$ref": "#/components/schemas/
|
|
2218
|
+
"$ref": "#/components/schemas/DocText404Response"
|
|
2126
2219
|
}
|
|
2127
2220
|
}
|
|
2128
2221
|
}
|
|
@@ -2132,7 +2225,7 @@
|
|
|
2132
2225
|
"content": {
|
|
2133
2226
|
"application/json": {
|
|
2134
2227
|
"schema": {
|
|
2135
|
-
"$ref": "#/components/schemas/
|
|
2228
|
+
"$ref": "#/components/schemas/EngineErrorPayload"
|
|
2136
2229
|
}
|
|
2137
2230
|
}
|
|
2138
2231
|
}
|
|
@@ -2140,140 +2233,169 @@
|
|
|
2140
2233
|
}
|
|
2141
2234
|
}
|
|
2142
2235
|
},
|
|
2143
|
-
"/v1/
|
|
2144
|
-
"
|
|
2145
|
-
"operationId": "
|
|
2146
|
-
"x-fern-sdk-group-name": ["
|
|
2147
|
-
"x-fern-sdk-method-name": "
|
|
2148
|
-
"x-docs-title": "
|
|
2149
|
-
"summary": "
|
|
2150
|
-
"
|
|
2151
|
-
|
|
2152
|
-
"apiToken": []
|
|
2153
|
-
}
|
|
2154
|
-
],
|
|
2236
|
+
"/v1/share-sessions": {
|
|
2237
|
+
"post": {
|
|
2238
|
+
"operationId": "shares.exchange",
|
|
2239
|
+
"x-fern-sdk-group-name": ["shares"],
|
|
2240
|
+
"x-fern-sdk-method-name": "exchange",
|
|
2241
|
+
"x-docs-title": "Exchange share token",
|
|
2242
|
+
"summary": "Trade a public share token for a short-lived document session JWT.",
|
|
2243
|
+
"description": "Unauthenticated, but requires a browser Origin header, checked against the grant allowlist. Unknown, revoked, and disabled tokens are indistinguishable (404). Passphrase-protected grants return 422 SharePasswordRequired until `password` is supplied. Mounted only when the deployment can sign (HS256 mode).",
|
|
2244
|
+
"security": [],
|
|
2155
2245
|
"x-required-scope": [],
|
|
2156
|
-
"
|
|
2157
|
-
|
|
2158
|
-
|
|
2159
|
-
"
|
|
2160
|
-
|
|
2161
|
-
|
|
2162
|
-
|
|
2163
|
-
"pattern": "^[A-Za-z0-9_-]+$"
|
|
2246
|
+
"requestBody": {
|
|
2247
|
+
"required": true,
|
|
2248
|
+
"content": {
|
|
2249
|
+
"application/json": {
|
|
2250
|
+
"schema": {
|
|
2251
|
+
"$ref": "#/components/schemas/SharesExchangeRequest"
|
|
2252
|
+
}
|
|
2164
2253
|
}
|
|
2165
2254
|
}
|
|
2166
|
-
|
|
2255
|
+
},
|
|
2167
2256
|
"responses": {
|
|
2168
2257
|
"200": {
|
|
2169
2258
|
"description": "OK",
|
|
2170
2259
|
"content": {
|
|
2171
2260
|
"application/json": {
|
|
2172
2261
|
"schema": {
|
|
2173
|
-
"$ref": "#/components/schemas/
|
|
2262
|
+
"$ref": "#/components/schemas/SharesExchange200Response"
|
|
2174
2263
|
}
|
|
2175
2264
|
}
|
|
2176
2265
|
}
|
|
2177
2266
|
},
|
|
2178
|
-
"
|
|
2179
|
-
"description": "
|
|
2267
|
+
"400": {
|
|
2268
|
+
"description": "Bad request",
|
|
2180
2269
|
"content": {
|
|
2181
2270
|
"application/json": {
|
|
2182
2271
|
"schema": {
|
|
2183
|
-
"$ref": "#/components/schemas/
|
|
2272
|
+
"$ref": "#/components/schemas/SharesExchange400Response"
|
|
2184
2273
|
}
|
|
2185
2274
|
}
|
|
2186
2275
|
}
|
|
2187
2276
|
},
|
|
2188
|
-
"
|
|
2189
|
-
"description": "
|
|
2277
|
+
"403": {
|
|
2278
|
+
"description": "Forbidden",
|
|
2190
2279
|
"content": {
|
|
2191
2280
|
"application/json": {
|
|
2192
2281
|
"schema": {
|
|
2193
|
-
"$ref": "#/components/schemas/
|
|
2282
|
+
"$ref": "#/components/schemas/SharesExchange403Response"
|
|
2194
2283
|
}
|
|
2195
2284
|
}
|
|
2196
2285
|
}
|
|
2197
|
-
}
|
|
2198
|
-
}
|
|
2199
|
-
},
|
|
2200
|
-
"delete": {
|
|
2201
|
-
"operationId": "tenants.delete",
|
|
2202
|
-
"x-fern-sdk-group-name": ["tenants"],
|
|
2203
|
-
"x-fern-sdk-method-name": "delete",
|
|
2204
|
-
"x-docs-title": "Delete tenant",
|
|
2205
|
-
"summary": "Delete a tenant and everything under it.",
|
|
2206
|
-
"description": "Destroys the tenant and everything in its namespace — documents, layers, stored bytes, audit history. Irreversible.",
|
|
2207
|
-
"security": [
|
|
2208
|
-
{
|
|
2209
|
-
"apiToken": []
|
|
2210
|
-
}
|
|
2211
|
-
],
|
|
2212
|
-
"x-required-scope": [],
|
|
2213
|
-
"parameters": [
|
|
2214
|
-
{
|
|
2215
|
-
"name": "tenantId",
|
|
2216
|
-
"in": "path",
|
|
2217
|
-
"required": true,
|
|
2218
|
-
"schema": {
|
|
2219
|
-
"type": "string",
|
|
2220
|
-
"pattern": "^[A-Za-z0-9_-]+$"
|
|
2221
|
-
}
|
|
2222
|
-
}
|
|
2223
|
-
],
|
|
2224
|
-
"responses": {
|
|
2225
|
-
"204": {
|
|
2226
|
-
"description": "No content"
|
|
2227
2286
|
},
|
|
2228
2287
|
"404": {
|
|
2229
2288
|
"description": "Not found",
|
|
2230
2289
|
"content": {
|
|
2231
2290
|
"application/json": {
|
|
2232
2291
|
"schema": {
|
|
2233
|
-
"$ref": "#/components/schemas/
|
|
2292
|
+
"$ref": "#/components/schemas/SharesExchange404Response"
|
|
2234
2293
|
}
|
|
2235
2294
|
}
|
|
2236
2295
|
}
|
|
2237
2296
|
},
|
|
2238
|
-
"
|
|
2239
|
-
"description": "
|
|
2297
|
+
"410": {
|
|
2298
|
+
"description": "Gone",
|
|
2240
2299
|
"content": {
|
|
2241
2300
|
"application/json": {
|
|
2242
2301
|
"schema": {
|
|
2243
|
-
"$ref": "#/components/schemas/
|
|
2302
|
+
"$ref": "#/components/schemas/SharesExchange410Response"
|
|
2244
2303
|
}
|
|
2245
2304
|
}
|
|
2246
2305
|
}
|
|
2247
|
-
}
|
|
2248
|
-
|
|
2249
|
-
|
|
2250
|
-
|
|
2251
|
-
|
|
2252
|
-
|
|
2253
|
-
|
|
2254
|
-
|
|
2255
|
-
|
|
2256
|
-
|
|
2257
|
-
|
|
2306
|
+
},
|
|
2307
|
+
"422": {
|
|
2308
|
+
"description": "Unprocessable",
|
|
2309
|
+
"content": {
|
|
2310
|
+
"application/json": {
|
|
2311
|
+
"schema": {
|
|
2312
|
+
"$ref": "#/components/schemas/SharesExchange422Response"
|
|
2313
|
+
}
|
|
2314
|
+
}
|
|
2315
|
+
}
|
|
2316
|
+
},
|
|
2317
|
+
"default": {
|
|
2318
|
+
"description": "Error",
|
|
2319
|
+
"content": {
|
|
2320
|
+
"application/json": {
|
|
2321
|
+
"schema": {
|
|
2322
|
+
"$ref": "#/components/schemas/AdminErrorPayload"
|
|
2323
|
+
}
|
|
2324
|
+
}
|
|
2325
|
+
}
|
|
2326
|
+
}
|
|
2327
|
+
}
|
|
2328
|
+
}
|
|
2329
|
+
},
|
|
2330
|
+
"/v1/tenants": {
|
|
2331
|
+
"post": {
|
|
2332
|
+
"operationId": "tenants.create",
|
|
2333
|
+
"x-fern-sdk-group-name": ["tenants"],
|
|
2334
|
+
"x-fern-sdk-method-name": "create",
|
|
2335
|
+
"x-docs-title": "Create tenant",
|
|
2336
|
+
"summary": "Create a tenant, or confirm it already exists — ensure-style, idempotent.",
|
|
2258
2337
|
"security": [
|
|
2259
2338
|
{
|
|
2260
2339
|
"apiToken": []
|
|
2340
|
+
}
|
|
2341
|
+
],
|
|
2342
|
+
"x-required-scope": [],
|
|
2343
|
+
"requestBody": {
|
|
2344
|
+
"required": true,
|
|
2345
|
+
"content": {
|
|
2346
|
+
"application/json": {
|
|
2347
|
+
"schema": {
|
|
2348
|
+
"$ref": "#/components/schemas/TenantsCreateRequest"
|
|
2349
|
+
}
|
|
2350
|
+
}
|
|
2351
|
+
}
|
|
2352
|
+
},
|
|
2353
|
+
"responses": {
|
|
2354
|
+
"200": {
|
|
2355
|
+
"description": "OK",
|
|
2356
|
+
"content": {
|
|
2357
|
+
"application/json": {
|
|
2358
|
+
"schema": {
|
|
2359
|
+
"$ref": "#/components/schemas/TenantsCreate200Response"
|
|
2360
|
+
}
|
|
2361
|
+
}
|
|
2362
|
+
}
|
|
2363
|
+
},
|
|
2364
|
+
"400": {
|
|
2365
|
+
"description": "Bad request",
|
|
2366
|
+
"content": {
|
|
2367
|
+
"application/json": {
|
|
2368
|
+
"schema": {
|
|
2369
|
+
"$ref": "#/components/schemas/TenantsCreate400Response"
|
|
2370
|
+
}
|
|
2371
|
+
}
|
|
2372
|
+
}
|
|
2261
2373
|
},
|
|
2374
|
+
"default": {
|
|
2375
|
+
"description": "Error",
|
|
2376
|
+
"content": {
|
|
2377
|
+
"application/json": {
|
|
2378
|
+
"schema": {
|
|
2379
|
+
"$ref": "#/components/schemas/AdminErrorPayload"
|
|
2380
|
+
}
|
|
2381
|
+
}
|
|
2382
|
+
}
|
|
2383
|
+
}
|
|
2384
|
+
}
|
|
2385
|
+
},
|
|
2386
|
+
"get": {
|
|
2387
|
+
"operationId": "tenants.list",
|
|
2388
|
+
"x-fern-sdk-group-name": ["tenants"],
|
|
2389
|
+
"x-fern-sdk-method-name": "list",
|
|
2390
|
+
"x-docs-title": "List tenants",
|
|
2391
|
+
"summary": "List tenants, newest first, cursor-paginated.",
|
|
2392
|
+
"security": [
|
|
2262
2393
|
{
|
|
2263
|
-
"
|
|
2394
|
+
"apiToken": []
|
|
2264
2395
|
}
|
|
2265
2396
|
],
|
|
2266
|
-
"x-required-scope": [
|
|
2397
|
+
"x-required-scope": [],
|
|
2267
2398
|
"parameters": [
|
|
2268
|
-
{
|
|
2269
|
-
"name": "tenantId",
|
|
2270
|
-
"in": "path",
|
|
2271
|
-
"required": true,
|
|
2272
|
-
"schema": {
|
|
2273
|
-
"type": "string",
|
|
2274
|
-
"pattern": "^[A-Za-z0-9_-]+$"
|
|
2275
|
-
}
|
|
2276
|
-
},
|
|
2277
2399
|
{
|
|
2278
2400
|
"name": "limit",
|
|
2279
2401
|
"in": "query",
|
|
@@ -2293,15 +2415,6 @@
|
|
|
2293
2415
|
"type": "string",
|
|
2294
2416
|
"minLength": 1
|
|
2295
2417
|
}
|
|
2296
|
-
},
|
|
2297
|
-
{
|
|
2298
|
-
"name": "state",
|
|
2299
|
-
"in": "query",
|
|
2300
|
-
"required": false,
|
|
2301
|
-
"schema": {
|
|
2302
|
-
"type": "string",
|
|
2303
|
-
"enum": ["pending", "ready", "failed", "deleting"]
|
|
2304
|
-
}
|
|
2305
2418
|
}
|
|
2306
2419
|
],
|
|
2307
2420
|
"responses": {
|
|
@@ -2310,7 +2423,7 @@
|
|
|
2310
2423
|
"content": {
|
|
2311
2424
|
"application/json": {
|
|
2312
2425
|
"schema": {
|
|
2313
|
-
"$ref": "#/components/schemas/
|
|
2426
|
+
"$ref": "#/components/schemas/TenantsList200Response"
|
|
2314
2427
|
}
|
|
2315
2428
|
}
|
|
2316
2429
|
}
|
|
@@ -2320,7 +2433,7 @@
|
|
|
2320
2433
|
"content": {
|
|
2321
2434
|
"application/json": {
|
|
2322
2435
|
"schema": {
|
|
2323
|
-
"$ref": "#/components/schemas/
|
|
2436
|
+
"$ref": "#/components/schemas/TenantsList400Response"
|
|
2324
2437
|
}
|
|
2325
2438
|
}
|
|
2326
2439
|
}
|
|
@@ -2338,22 +2451,19 @@
|
|
|
2338
2451
|
}
|
|
2339
2452
|
}
|
|
2340
2453
|
},
|
|
2341
|
-
"/v1/tenants/{tenantId}
|
|
2454
|
+
"/v1/tenants/{tenantId}": {
|
|
2342
2455
|
"get": {
|
|
2343
|
-
"operationId": "
|
|
2344
|
-
"x-fern-sdk-group-name": ["
|
|
2456
|
+
"operationId": "tenants.get",
|
|
2457
|
+
"x-fern-sdk-group-name": ["tenants"],
|
|
2345
2458
|
"x-fern-sdk-method-name": "get",
|
|
2346
|
-
"x-docs-title": "Get
|
|
2347
|
-
"summary": "Fetch one
|
|
2459
|
+
"x-docs-title": "Get tenant",
|
|
2460
|
+
"summary": "Fetch one tenant record.",
|
|
2348
2461
|
"security": [
|
|
2349
2462
|
{
|
|
2350
2463
|
"apiToken": []
|
|
2351
|
-
},
|
|
2352
|
-
{
|
|
2353
|
-
"tenantToken": []
|
|
2354
2464
|
}
|
|
2355
2465
|
],
|
|
2356
|
-
"x-required-scope": [
|
|
2466
|
+
"x-required-scope": [],
|
|
2357
2467
|
"parameters": [
|
|
2358
2468
|
{
|
|
2359
2469
|
"name": "tenantId",
|
|
@@ -2363,15 +2473,6 @@
|
|
|
2363
2473
|
"type": "string",
|
|
2364
2474
|
"pattern": "^[A-Za-z0-9_-]+$"
|
|
2365
2475
|
}
|
|
2366
|
-
},
|
|
2367
|
-
{
|
|
2368
|
-
"name": "id",
|
|
2369
|
-
"in": "path",
|
|
2370
|
-
"required": true,
|
|
2371
|
-
"schema": {
|
|
2372
|
-
"type": "string",
|
|
2373
|
-
"pattern": "^[A-Za-z0-9_-]+$"
|
|
2374
|
-
}
|
|
2375
2476
|
}
|
|
2376
2477
|
],
|
|
2377
2478
|
"responses": {
|
|
@@ -2380,17 +2481,7 @@
|
|
|
2380
2481
|
"content": {
|
|
2381
2482
|
"application/json": {
|
|
2382
2483
|
"schema": {
|
|
2383
|
-
"$ref": "#/components/schemas/
|
|
2384
|
-
}
|
|
2385
|
-
}
|
|
2386
|
-
}
|
|
2387
|
-
},
|
|
2388
|
-
"403": {
|
|
2389
|
-
"description": "Forbidden",
|
|
2390
|
-
"content": {
|
|
2391
|
-
"application/json": {
|
|
2392
|
-
"schema": {
|
|
2393
|
-
"$ref": "#/components/schemas/DocumentsGet403Response"
|
|
2484
|
+
"$ref": "#/components/schemas/TenantsGet200Response"
|
|
2394
2485
|
}
|
|
2395
2486
|
}
|
|
2396
2487
|
}
|
|
@@ -2400,7 +2491,7 @@
|
|
|
2400
2491
|
"content": {
|
|
2401
2492
|
"application/json": {
|
|
2402
2493
|
"schema": {
|
|
2403
|
-
"$ref": "#/components/schemas/
|
|
2494
|
+
"$ref": "#/components/schemas/TenantsGet404Response"
|
|
2404
2495
|
}
|
|
2405
2496
|
}
|
|
2406
2497
|
}
|
|
@@ -2418,20 +2509,18 @@
|
|
|
2418
2509
|
}
|
|
2419
2510
|
},
|
|
2420
2511
|
"delete": {
|
|
2421
|
-
"operationId": "
|
|
2422
|
-
"x-fern-sdk-group-name": ["
|
|
2512
|
+
"operationId": "tenants.delete",
|
|
2513
|
+
"x-fern-sdk-group-name": ["tenants"],
|
|
2423
2514
|
"x-fern-sdk-method-name": "delete",
|
|
2424
|
-
"x-docs-title": "Delete
|
|
2425
|
-
"summary": "Delete a
|
|
2515
|
+
"x-docs-title": "Delete tenant",
|
|
2516
|
+
"summary": "Delete a tenant and everything under it.",
|
|
2517
|
+
"description": "Destroys the tenant and everything in its namespace — documents, layers, stored bytes, audit history. Irreversible.",
|
|
2426
2518
|
"security": [
|
|
2427
2519
|
{
|
|
2428
2520
|
"apiToken": []
|
|
2429
|
-
},
|
|
2430
|
-
{
|
|
2431
|
-
"tenantToken": []
|
|
2432
2521
|
}
|
|
2433
2522
|
],
|
|
2434
|
-
"x-required-scope": [
|
|
2523
|
+
"x-required-scope": [],
|
|
2435
2524
|
"parameters": [
|
|
2436
2525
|
{
|
|
2437
2526
|
"name": "tenantId",
|
|
@@ -2441,37 +2530,18 @@
|
|
|
2441
2530
|
"type": "string",
|
|
2442
2531
|
"pattern": "^[A-Za-z0-9_-]+$"
|
|
2443
2532
|
}
|
|
2444
|
-
},
|
|
2445
|
-
{
|
|
2446
|
-
"name": "id",
|
|
2447
|
-
"in": "path",
|
|
2448
|
-
"required": true,
|
|
2449
|
-
"schema": {
|
|
2450
|
-
"type": "string",
|
|
2451
|
-
"pattern": "^[A-Za-z0-9_-]+$"
|
|
2452
|
-
}
|
|
2453
2533
|
}
|
|
2454
2534
|
],
|
|
2455
2535
|
"responses": {
|
|
2456
2536
|
"204": {
|
|
2457
2537
|
"description": "No content"
|
|
2458
2538
|
},
|
|
2459
|
-
"403": {
|
|
2460
|
-
"description": "Forbidden",
|
|
2461
|
-
"content": {
|
|
2462
|
-
"application/json": {
|
|
2463
|
-
"schema": {
|
|
2464
|
-
"$ref": "#/components/schemas/DocumentsDelete403Response"
|
|
2465
|
-
}
|
|
2466
|
-
}
|
|
2467
|
-
}
|
|
2468
|
-
},
|
|
2469
2539
|
"404": {
|
|
2470
2540
|
"description": "Not found",
|
|
2471
2541
|
"content": {
|
|
2472
2542
|
"application/json": {
|
|
2473
2543
|
"schema": {
|
|
2474
|
-
"$ref": "#/components/schemas/
|
|
2544
|
+
"$ref": "#/components/schemas/TenantsDeleteResponse"
|
|
2475
2545
|
}
|
|
2476
2546
|
}
|
|
2477
2547
|
}
|
|
@@ -2489,13 +2559,13 @@
|
|
|
2489
2559
|
}
|
|
2490
2560
|
}
|
|
2491
2561
|
},
|
|
2492
|
-
"/v1/tenants/{tenantId}/documents
|
|
2493
|
-
"
|
|
2494
|
-
"operationId": "documents.
|
|
2562
|
+
"/v1/tenants/{tenantId}/documents": {
|
|
2563
|
+
"get": {
|
|
2564
|
+
"operationId": "documents.list",
|
|
2495
2565
|
"x-fern-sdk-group-name": ["documents"],
|
|
2496
|
-
"x-fern-sdk-method-name": "
|
|
2497
|
-
"x-docs-title": "
|
|
2498
|
-
"summary": "
|
|
2566
|
+
"x-fern-sdk-method-name": "list",
|
|
2567
|
+
"x-docs-title": "List documents",
|
|
2568
|
+
"summary": "List documents in the tenant, newest first, cursor-paginated.",
|
|
2499
2569
|
"security": [
|
|
2500
2570
|
{
|
|
2501
2571
|
"apiToken": []
|
|
@@ -2504,7 +2574,7 @@
|
|
|
2504
2574
|
"tenantToken": []
|
|
2505
2575
|
}
|
|
2506
2576
|
],
|
|
2507
|
-
"x-required-scope": ["docs.
|
|
2577
|
+
"x-required-scope": ["docs.read"],
|
|
2508
2578
|
"parameters": [
|
|
2509
2579
|
{
|
|
2510
2580
|
"name": "tenantId",
|
|
@@ -2516,32 +2586,42 @@
|
|
|
2516
2586
|
}
|
|
2517
2587
|
},
|
|
2518
2588
|
{
|
|
2519
|
-
"name": "
|
|
2520
|
-
"in": "
|
|
2521
|
-
"required":
|
|
2589
|
+
"name": "limit",
|
|
2590
|
+
"in": "query",
|
|
2591
|
+
"required": false,
|
|
2592
|
+
"schema": {
|
|
2593
|
+
"type": "integer",
|
|
2594
|
+
"minimum": 1,
|
|
2595
|
+
"maximum": 200,
|
|
2596
|
+
"default": 100
|
|
2597
|
+
}
|
|
2598
|
+
},
|
|
2599
|
+
{
|
|
2600
|
+
"name": "cursor",
|
|
2601
|
+
"in": "query",
|
|
2602
|
+
"required": false,
|
|
2522
2603
|
"schema": {
|
|
2523
2604
|
"type": "string",
|
|
2524
|
-
"
|
|
2605
|
+
"minLength": 1
|
|
2525
2606
|
}
|
|
2526
|
-
}
|
|
2527
|
-
|
|
2528
|
-
|
|
2529
|
-
|
|
2530
|
-
|
|
2531
|
-
"
|
|
2532
|
-
"
|
|
2533
|
-
|
|
2534
|
-
}
|
|
2607
|
+
},
|
|
2608
|
+
{
|
|
2609
|
+
"name": "state",
|
|
2610
|
+
"in": "query",
|
|
2611
|
+
"required": false,
|
|
2612
|
+
"schema": {
|
|
2613
|
+
"type": "string",
|
|
2614
|
+
"enum": ["pending", "ready", "failed", "deleting"]
|
|
2535
2615
|
}
|
|
2536
2616
|
}
|
|
2537
|
-
|
|
2617
|
+
],
|
|
2538
2618
|
"responses": {
|
|
2539
2619
|
"200": {
|
|
2540
2620
|
"description": "OK",
|
|
2541
2621
|
"content": {
|
|
2542
2622
|
"application/json": {
|
|
2543
2623
|
"schema": {
|
|
2544
|
-
"$ref": "#/components/schemas/
|
|
2624
|
+
"$ref": "#/components/schemas/DocumentsList200Response"
|
|
2545
2625
|
}
|
|
2546
2626
|
}
|
|
2547
2627
|
}
|
|
@@ -2551,17 +2631,7 @@
|
|
|
2551
2631
|
"content": {
|
|
2552
2632
|
"application/json": {
|
|
2553
2633
|
"schema": {
|
|
2554
|
-
"$ref": "#/components/schemas/
|
|
2555
|
-
}
|
|
2556
|
-
}
|
|
2557
|
-
}
|
|
2558
|
-
},
|
|
2559
|
-
"404": {
|
|
2560
|
-
"description": "Not found",
|
|
2561
|
-
"content": {
|
|
2562
|
-
"application/json": {
|
|
2563
|
-
"schema": {
|
|
2564
|
-
"$ref": "#/components/schemas/DocumentsCommit404Response"
|
|
2634
|
+
"$ref": "#/components/schemas/DocumentsList400Response"
|
|
2565
2635
|
}
|
|
2566
2636
|
}
|
|
2567
2637
|
}
|
|
@@ -2579,12 +2649,253 @@
|
|
|
2579
2649
|
}
|
|
2580
2650
|
}
|
|
2581
2651
|
},
|
|
2582
|
-
"/v1/tenants/{tenantId}/documents/{id}
|
|
2652
|
+
"/v1/tenants/{tenantId}/documents/{id}": {
|
|
2583
2653
|
"get": {
|
|
2584
|
-
"operationId": "documents.
|
|
2654
|
+
"operationId": "documents.get",
|
|
2585
2655
|
"x-fern-sdk-group-name": ["documents"],
|
|
2586
|
-
"x-fern-sdk-method-name": "
|
|
2587
|
-
"x-docs-title": "
|
|
2656
|
+
"x-fern-sdk-method-name": "get",
|
|
2657
|
+
"x-docs-title": "Get document",
|
|
2658
|
+
"summary": "Fetch one document record.",
|
|
2659
|
+
"security": [
|
|
2660
|
+
{
|
|
2661
|
+
"apiToken": []
|
|
2662
|
+
},
|
|
2663
|
+
{
|
|
2664
|
+
"tenantToken": []
|
|
2665
|
+
}
|
|
2666
|
+
],
|
|
2667
|
+
"x-required-scope": ["docs.read"],
|
|
2668
|
+
"parameters": [
|
|
2669
|
+
{
|
|
2670
|
+
"name": "tenantId",
|
|
2671
|
+
"in": "path",
|
|
2672
|
+
"required": true,
|
|
2673
|
+
"schema": {
|
|
2674
|
+
"type": "string",
|
|
2675
|
+
"pattern": "^[A-Za-z0-9_-]+$"
|
|
2676
|
+
}
|
|
2677
|
+
},
|
|
2678
|
+
{
|
|
2679
|
+
"name": "id",
|
|
2680
|
+
"in": "path",
|
|
2681
|
+
"required": true,
|
|
2682
|
+
"schema": {
|
|
2683
|
+
"type": "string",
|
|
2684
|
+
"pattern": "^[A-Za-z0-9_-]+$"
|
|
2685
|
+
}
|
|
2686
|
+
}
|
|
2687
|
+
],
|
|
2688
|
+
"responses": {
|
|
2689
|
+
"200": {
|
|
2690
|
+
"description": "OK",
|
|
2691
|
+
"content": {
|
|
2692
|
+
"application/json": {
|
|
2693
|
+
"schema": {
|
|
2694
|
+
"$ref": "#/components/schemas/DocumentsGet200Response"
|
|
2695
|
+
}
|
|
2696
|
+
}
|
|
2697
|
+
}
|
|
2698
|
+
},
|
|
2699
|
+
"403": {
|
|
2700
|
+
"description": "Forbidden",
|
|
2701
|
+
"content": {
|
|
2702
|
+
"application/json": {
|
|
2703
|
+
"schema": {
|
|
2704
|
+
"$ref": "#/components/schemas/DocumentsGet403Response"
|
|
2705
|
+
}
|
|
2706
|
+
}
|
|
2707
|
+
}
|
|
2708
|
+
},
|
|
2709
|
+
"404": {
|
|
2710
|
+
"description": "Not found",
|
|
2711
|
+
"content": {
|
|
2712
|
+
"application/json": {
|
|
2713
|
+
"schema": {
|
|
2714
|
+
"$ref": "#/components/schemas/DocumentsGet404Response"
|
|
2715
|
+
}
|
|
2716
|
+
}
|
|
2717
|
+
}
|
|
2718
|
+
},
|
|
2719
|
+
"default": {
|
|
2720
|
+
"description": "Error",
|
|
2721
|
+
"content": {
|
|
2722
|
+
"application/json": {
|
|
2723
|
+
"schema": {
|
|
2724
|
+
"$ref": "#/components/schemas/AdminErrorPayload"
|
|
2725
|
+
}
|
|
2726
|
+
}
|
|
2727
|
+
}
|
|
2728
|
+
}
|
|
2729
|
+
}
|
|
2730
|
+
},
|
|
2731
|
+
"delete": {
|
|
2732
|
+
"operationId": "documents.delete",
|
|
2733
|
+
"x-fern-sdk-group-name": ["documents"],
|
|
2734
|
+
"x-fern-sdk-method-name": "delete",
|
|
2735
|
+
"x-docs-title": "Delete document",
|
|
2736
|
+
"summary": "Delete a document and its stored artifacts.",
|
|
2737
|
+
"security": [
|
|
2738
|
+
{
|
|
2739
|
+
"apiToken": []
|
|
2740
|
+
},
|
|
2741
|
+
{
|
|
2742
|
+
"tenantToken": []
|
|
2743
|
+
}
|
|
2744
|
+
],
|
|
2745
|
+
"x-required-scope": ["docs.delete"],
|
|
2746
|
+
"parameters": [
|
|
2747
|
+
{
|
|
2748
|
+
"name": "tenantId",
|
|
2749
|
+
"in": "path",
|
|
2750
|
+
"required": true,
|
|
2751
|
+
"schema": {
|
|
2752
|
+
"type": "string",
|
|
2753
|
+
"pattern": "^[A-Za-z0-9_-]+$"
|
|
2754
|
+
}
|
|
2755
|
+
},
|
|
2756
|
+
{
|
|
2757
|
+
"name": "id",
|
|
2758
|
+
"in": "path",
|
|
2759
|
+
"required": true,
|
|
2760
|
+
"schema": {
|
|
2761
|
+
"type": "string",
|
|
2762
|
+
"pattern": "^[A-Za-z0-9_-]+$"
|
|
2763
|
+
}
|
|
2764
|
+
}
|
|
2765
|
+
],
|
|
2766
|
+
"responses": {
|
|
2767
|
+
"204": {
|
|
2768
|
+
"description": "No content"
|
|
2769
|
+
},
|
|
2770
|
+
"403": {
|
|
2771
|
+
"description": "Forbidden",
|
|
2772
|
+
"content": {
|
|
2773
|
+
"application/json": {
|
|
2774
|
+
"schema": {
|
|
2775
|
+
"$ref": "#/components/schemas/DocumentsDelete403Response"
|
|
2776
|
+
}
|
|
2777
|
+
}
|
|
2778
|
+
}
|
|
2779
|
+
},
|
|
2780
|
+
"404": {
|
|
2781
|
+
"description": "Not found",
|
|
2782
|
+
"content": {
|
|
2783
|
+
"application/json": {
|
|
2784
|
+
"schema": {
|
|
2785
|
+
"$ref": "#/components/schemas/DocumentsDelete404Response"
|
|
2786
|
+
}
|
|
2787
|
+
}
|
|
2788
|
+
}
|
|
2789
|
+
},
|
|
2790
|
+
"default": {
|
|
2791
|
+
"description": "Error",
|
|
2792
|
+
"content": {
|
|
2793
|
+
"application/json": {
|
|
2794
|
+
"schema": {
|
|
2795
|
+
"$ref": "#/components/schemas/AdminErrorPayload"
|
|
2796
|
+
}
|
|
2797
|
+
}
|
|
2798
|
+
}
|
|
2799
|
+
}
|
|
2800
|
+
}
|
|
2801
|
+
}
|
|
2802
|
+
},
|
|
2803
|
+
"/v1/tenants/{tenantId}/documents/{id}/commit": {
|
|
2804
|
+
"post": {
|
|
2805
|
+
"operationId": "documents.commit",
|
|
2806
|
+
"x-fern-sdk-group-name": ["documents"],
|
|
2807
|
+
"x-fern-sdk-method-name": "commit",
|
|
2808
|
+
"x-docs-title": "Commit upload",
|
|
2809
|
+
"summary": "Finish an upload: verify the SHA-256 and promote the document to ready.",
|
|
2810
|
+
"security": [
|
|
2811
|
+
{
|
|
2812
|
+
"apiToken": []
|
|
2813
|
+
},
|
|
2814
|
+
{
|
|
2815
|
+
"tenantToken": []
|
|
2816
|
+
}
|
|
2817
|
+
],
|
|
2818
|
+
"x-required-scope": ["docs.create"],
|
|
2819
|
+
"parameters": [
|
|
2820
|
+
{
|
|
2821
|
+
"name": "tenantId",
|
|
2822
|
+
"in": "path",
|
|
2823
|
+
"required": true,
|
|
2824
|
+
"schema": {
|
|
2825
|
+
"type": "string",
|
|
2826
|
+
"pattern": "^[A-Za-z0-9_-]+$"
|
|
2827
|
+
}
|
|
2828
|
+
},
|
|
2829
|
+
{
|
|
2830
|
+
"name": "id",
|
|
2831
|
+
"in": "path",
|
|
2832
|
+
"required": true,
|
|
2833
|
+
"schema": {
|
|
2834
|
+
"type": "string",
|
|
2835
|
+
"pattern": "^[A-Za-z0-9_-]+$"
|
|
2836
|
+
}
|
|
2837
|
+
}
|
|
2838
|
+
],
|
|
2839
|
+
"requestBody": {
|
|
2840
|
+
"required": true,
|
|
2841
|
+
"content": {
|
|
2842
|
+
"application/json": {
|
|
2843
|
+
"schema": {
|
|
2844
|
+
"$ref": "#/components/schemas/DocumentsCommitRequest"
|
|
2845
|
+
}
|
|
2846
|
+
}
|
|
2847
|
+
}
|
|
2848
|
+
},
|
|
2849
|
+
"responses": {
|
|
2850
|
+
"200": {
|
|
2851
|
+
"description": "OK",
|
|
2852
|
+
"content": {
|
|
2853
|
+
"application/json": {
|
|
2854
|
+
"schema": {
|
|
2855
|
+
"$ref": "#/components/schemas/DocumentsCommit200Response"
|
|
2856
|
+
}
|
|
2857
|
+
}
|
|
2858
|
+
}
|
|
2859
|
+
},
|
|
2860
|
+
"400": {
|
|
2861
|
+
"description": "Bad request",
|
|
2862
|
+
"content": {
|
|
2863
|
+
"application/json": {
|
|
2864
|
+
"schema": {
|
|
2865
|
+
"$ref": "#/components/schemas/DocumentsCommit400Response"
|
|
2866
|
+
}
|
|
2867
|
+
}
|
|
2868
|
+
}
|
|
2869
|
+
},
|
|
2870
|
+
"404": {
|
|
2871
|
+
"description": "Not found",
|
|
2872
|
+
"content": {
|
|
2873
|
+
"application/json": {
|
|
2874
|
+
"schema": {
|
|
2875
|
+
"$ref": "#/components/schemas/DocumentsCommit404Response"
|
|
2876
|
+
}
|
|
2877
|
+
}
|
|
2878
|
+
}
|
|
2879
|
+
},
|
|
2880
|
+
"default": {
|
|
2881
|
+
"description": "Error",
|
|
2882
|
+
"content": {
|
|
2883
|
+
"application/json": {
|
|
2884
|
+
"schema": {
|
|
2885
|
+
"$ref": "#/components/schemas/AdminErrorPayload"
|
|
2886
|
+
}
|
|
2887
|
+
}
|
|
2888
|
+
}
|
|
2889
|
+
}
|
|
2890
|
+
}
|
|
2891
|
+
}
|
|
2892
|
+
},
|
|
2893
|
+
"/v1/tenants/{tenantId}/documents/{id}/download": {
|
|
2894
|
+
"get": {
|
|
2895
|
+
"operationId": "documents.download",
|
|
2896
|
+
"x-fern-sdk-group-name": ["documents"],
|
|
2897
|
+
"x-fern-sdk-method-name": "download",
|
|
2898
|
+
"x-docs-title": "Download document",
|
|
2588
2899
|
"summary": "Download the stored base PDF bytes.",
|
|
2589
2900
|
"security": [
|
|
2590
2901
|
{
|
|
@@ -11162,25 +11473,451 @@
|
|
|
11162
11473
|
],
|
|
11163
11474
|
"additionalProperties": false
|
|
11164
11475
|
}
|
|
11165
|
-
]
|
|
11166
|
-
}
|
|
11476
|
+
]
|
|
11477
|
+
}
|
|
11478
|
+
},
|
|
11479
|
+
"calculationOrder": {
|
|
11480
|
+
"type": "array",
|
|
11481
|
+
"items": {
|
|
11482
|
+
"allOf": [
|
|
11483
|
+
{
|
|
11484
|
+
"$ref": "#/components/schemas/DocFormsGet200Response/properties/fields/items/anyOf/0/properties/ref"
|
|
11485
|
+
}
|
|
11486
|
+
],
|
|
11487
|
+
"nullable": true
|
|
11488
|
+
}
|
|
11489
|
+
}
|
|
11490
|
+
},
|
|
11491
|
+
"required": ["formKind", "needsAppearances", "fields", "calculationOrder"],
|
|
11492
|
+
"additionalProperties": false
|
|
11493
|
+
},
|
|
11494
|
+
"DocFormsGet404Response": {
|
|
11495
|
+
"type": "object",
|
|
11496
|
+
"properties": {
|
|
11497
|
+
"name": {
|
|
11498
|
+
"type": "string",
|
|
11499
|
+
"enum": ["EngineError"]
|
|
11500
|
+
},
|
|
11501
|
+
"code": {
|
|
11502
|
+
"type": "string",
|
|
11503
|
+
"enum": [
|
|
11504
|
+
"Unknown",
|
|
11505
|
+
"InvalidArg",
|
|
11506
|
+
"DocNotOpen",
|
|
11507
|
+
"DocOpenFailed",
|
|
11508
|
+
"DocPasswordRequired",
|
|
11509
|
+
"DocPasswordIncorrect",
|
|
11510
|
+
"SharePasswordRequired",
|
|
11511
|
+
"Aborted",
|
|
11512
|
+
"Network",
|
|
11513
|
+
"Unauthenticated",
|
|
11514
|
+
"Forbidden",
|
|
11515
|
+
"NotFound",
|
|
11516
|
+
"WireFormat",
|
|
11517
|
+
"RuntimeUnavailable",
|
|
11518
|
+
"InvalidReference",
|
|
11519
|
+
"WeakAnnotationSessionConflict",
|
|
11520
|
+
"LayerVersionConflict",
|
|
11521
|
+
"NotImplemented",
|
|
11522
|
+
"MalformedPdf"
|
|
11523
|
+
]
|
|
11524
|
+
},
|
|
11525
|
+
"message": {
|
|
11526
|
+
"type": "string"
|
|
11527
|
+
},
|
|
11528
|
+
"details": {
|
|
11529
|
+
"type": "object",
|
|
11530
|
+
"additionalProperties": {}
|
|
11531
|
+
}
|
|
11532
|
+
},
|
|
11533
|
+
"required": ["name", "code", "message"],
|
|
11534
|
+
"additionalProperties": false
|
|
11535
|
+
},
|
|
11536
|
+
"DocFormsSetValueRequest": {
|
|
11537
|
+
"type": "object",
|
|
11538
|
+
"additionalProperties": {}
|
|
11539
|
+
},
|
|
11540
|
+
"DocFormsSetValue200Response": {
|
|
11541
|
+
"type": "object",
|
|
11542
|
+
"properties": {
|
|
11543
|
+
"meta": {
|
|
11544
|
+
"type": "object",
|
|
11545
|
+
"properties": {
|
|
11546
|
+
"affectedPages": {
|
|
11547
|
+
"type": "array",
|
|
11548
|
+
"items": {
|
|
11549
|
+
"type": "object",
|
|
11550
|
+
"properties": {
|
|
11551
|
+
"pageObjectNumber": {
|
|
11552
|
+
"type": "integer",
|
|
11553
|
+
"exclusiveMinimum": true,
|
|
11554
|
+
"minimum": 0
|
|
11555
|
+
},
|
|
11556
|
+
"revision": {
|
|
11557
|
+
"type": "object",
|
|
11558
|
+
"properties": {
|
|
11559
|
+
"docSessionId": {
|
|
11560
|
+
"type": "string"
|
|
11561
|
+
},
|
|
11562
|
+
"pageObjectNumber": {
|
|
11563
|
+
"type": "integer",
|
|
11564
|
+
"exclusiveMinimum": true,
|
|
11565
|
+
"minimum": 0
|
|
11566
|
+
},
|
|
11567
|
+
"generation": {
|
|
11568
|
+
"type": "integer",
|
|
11569
|
+
"minimum": 0
|
|
11570
|
+
}
|
|
11571
|
+
},
|
|
11572
|
+
"required": ["docSessionId", "pageObjectNumber", "generation"],
|
|
11573
|
+
"additionalProperties": false
|
|
11574
|
+
},
|
|
11575
|
+
"weakAnnotationState": {
|
|
11576
|
+
"anyOf": [
|
|
11577
|
+
{
|
|
11578
|
+
"type": "object",
|
|
11579
|
+
"properties": {
|
|
11580
|
+
"kind": {
|
|
11581
|
+
"type": "string",
|
|
11582
|
+
"enum": ["unknown"]
|
|
11583
|
+
}
|
|
11584
|
+
},
|
|
11585
|
+
"required": ["kind"],
|
|
11586
|
+
"additionalProperties": false
|
|
11587
|
+
},
|
|
11588
|
+
{
|
|
11589
|
+
"type": "object",
|
|
11590
|
+
"properties": {
|
|
11591
|
+
"kind": {
|
|
11592
|
+
"type": "string",
|
|
11593
|
+
"enum": ["known"]
|
|
11594
|
+
},
|
|
11595
|
+
"hasAnyWeakAnnotations": {
|
|
11596
|
+
"type": "boolean"
|
|
11597
|
+
}
|
|
11598
|
+
},
|
|
11599
|
+
"required": ["kind", "hasAnyWeakAnnotations"],
|
|
11600
|
+
"additionalProperties": false
|
|
11601
|
+
}
|
|
11602
|
+
]
|
|
11603
|
+
}
|
|
11604
|
+
},
|
|
11605
|
+
"required": ["pageObjectNumber", "revision", "weakAnnotationState"],
|
|
11606
|
+
"additionalProperties": false
|
|
11607
|
+
}
|
|
11608
|
+
},
|
|
11609
|
+
"cacheDelta": {
|
|
11610
|
+
"type": "object",
|
|
11611
|
+
"properties": {
|
|
11612
|
+
"previousDocVersion": {
|
|
11613
|
+
"type": "integer",
|
|
11614
|
+
"exclusiveMinimum": true,
|
|
11615
|
+
"minimum": 0
|
|
11616
|
+
},
|
|
11617
|
+
"docVersion": {
|
|
11618
|
+
"type": "integer",
|
|
11619
|
+
"exclusiveMinimum": true,
|
|
11620
|
+
"minimum": 0
|
|
11621
|
+
},
|
|
11622
|
+
"pages": {
|
|
11623
|
+
"type": "array",
|
|
11624
|
+
"items": {
|
|
11625
|
+
"type": "object",
|
|
11626
|
+
"properties": {
|
|
11627
|
+
"pageObjectNumber": {
|
|
11628
|
+
"type": "integer",
|
|
11629
|
+
"exclusiveMinimum": true,
|
|
11630
|
+
"minimum": 0
|
|
11631
|
+
},
|
|
11632
|
+
"cache": {
|
|
11633
|
+
"type": "object",
|
|
11634
|
+
"properties": {
|
|
11635
|
+
"contentVersion": {
|
|
11636
|
+
"type": "integer",
|
|
11637
|
+
"exclusiveMinimum": true,
|
|
11638
|
+
"minimum": 0
|
|
11639
|
+
},
|
|
11640
|
+
"annotationVersion": {
|
|
11641
|
+
"type": "integer",
|
|
11642
|
+
"exclusiveMinimum": true,
|
|
11643
|
+
"minimum": 0
|
|
11644
|
+
}
|
|
11645
|
+
},
|
|
11646
|
+
"required": ["contentVersion", "annotationVersion"],
|
|
11647
|
+
"additionalProperties": false
|
|
11648
|
+
}
|
|
11649
|
+
},
|
|
11650
|
+
"required": ["pageObjectNumber", "cache"],
|
|
11651
|
+
"additionalProperties": false
|
|
11652
|
+
}
|
|
11653
|
+
}
|
|
11654
|
+
},
|
|
11655
|
+
"required": ["previousDocVersion", "docVersion", "pages"],
|
|
11656
|
+
"additionalProperties": false,
|
|
11657
|
+
"nullable": true
|
|
11658
|
+
}
|
|
11659
|
+
},
|
|
11660
|
+
"required": ["affectedPages", "cacheDelta"],
|
|
11661
|
+
"additionalProperties": false
|
|
11662
|
+
}
|
|
11663
|
+
},
|
|
11664
|
+
"required": ["meta"],
|
|
11665
|
+
"additionalProperties": true
|
|
11666
|
+
},
|
|
11667
|
+
"DocFormsSetValue400Response": {
|
|
11668
|
+
"type": "object",
|
|
11669
|
+
"properties": {
|
|
11670
|
+
"name": {
|
|
11671
|
+
"type": "string",
|
|
11672
|
+
"enum": ["EngineError"]
|
|
11673
|
+
},
|
|
11674
|
+
"code": {
|
|
11675
|
+
"type": "string",
|
|
11676
|
+
"enum": [
|
|
11677
|
+
"Unknown",
|
|
11678
|
+
"InvalidArg",
|
|
11679
|
+
"DocNotOpen",
|
|
11680
|
+
"DocOpenFailed",
|
|
11681
|
+
"DocPasswordRequired",
|
|
11682
|
+
"DocPasswordIncorrect",
|
|
11683
|
+
"SharePasswordRequired",
|
|
11684
|
+
"Aborted",
|
|
11685
|
+
"Network",
|
|
11686
|
+
"Unauthenticated",
|
|
11687
|
+
"Forbidden",
|
|
11688
|
+
"NotFound",
|
|
11689
|
+
"WireFormat",
|
|
11690
|
+
"RuntimeUnavailable",
|
|
11691
|
+
"InvalidReference",
|
|
11692
|
+
"WeakAnnotationSessionConflict",
|
|
11693
|
+
"LayerVersionConflict",
|
|
11694
|
+
"NotImplemented",
|
|
11695
|
+
"MalformedPdf"
|
|
11696
|
+
]
|
|
11697
|
+
},
|
|
11698
|
+
"message": {
|
|
11699
|
+
"type": "string"
|
|
11700
|
+
},
|
|
11701
|
+
"details": {
|
|
11702
|
+
"type": "object",
|
|
11703
|
+
"additionalProperties": {}
|
|
11704
|
+
}
|
|
11705
|
+
},
|
|
11706
|
+
"required": ["name", "code", "message"],
|
|
11707
|
+
"additionalProperties": false
|
|
11708
|
+
},
|
|
11709
|
+
"DocFormsSetValue404Response": {
|
|
11710
|
+
"type": "object",
|
|
11711
|
+
"properties": {
|
|
11712
|
+
"name": {
|
|
11713
|
+
"type": "string",
|
|
11714
|
+
"enum": ["EngineError"]
|
|
11715
|
+
},
|
|
11716
|
+
"code": {
|
|
11717
|
+
"type": "string",
|
|
11718
|
+
"enum": [
|
|
11719
|
+
"Unknown",
|
|
11720
|
+
"InvalidArg",
|
|
11721
|
+
"DocNotOpen",
|
|
11722
|
+
"DocOpenFailed",
|
|
11723
|
+
"DocPasswordRequired",
|
|
11724
|
+
"DocPasswordIncorrect",
|
|
11725
|
+
"SharePasswordRequired",
|
|
11726
|
+
"Aborted",
|
|
11727
|
+
"Network",
|
|
11728
|
+
"Unauthenticated",
|
|
11729
|
+
"Forbidden",
|
|
11730
|
+
"NotFound",
|
|
11731
|
+
"WireFormat",
|
|
11732
|
+
"RuntimeUnavailable",
|
|
11733
|
+
"InvalidReference",
|
|
11734
|
+
"WeakAnnotationSessionConflict",
|
|
11735
|
+
"LayerVersionConflict",
|
|
11736
|
+
"NotImplemented",
|
|
11737
|
+
"MalformedPdf"
|
|
11738
|
+
]
|
|
11739
|
+
},
|
|
11740
|
+
"message": {
|
|
11741
|
+
"type": "string"
|
|
11742
|
+
},
|
|
11743
|
+
"details": {
|
|
11744
|
+
"type": "object",
|
|
11745
|
+
"additionalProperties": {}
|
|
11746
|
+
}
|
|
11747
|
+
},
|
|
11748
|
+
"required": ["name", "code", "message"],
|
|
11749
|
+
"additionalProperties": false
|
|
11750
|
+
},
|
|
11751
|
+
"DocFormsReset200Response": {
|
|
11752
|
+
"type": "object",
|
|
11753
|
+
"properties": {
|
|
11754
|
+
"meta": {
|
|
11755
|
+
"type": "object",
|
|
11756
|
+
"properties": {
|
|
11757
|
+
"affectedPages": {
|
|
11758
|
+
"type": "array",
|
|
11759
|
+
"items": {
|
|
11760
|
+
"type": "object",
|
|
11761
|
+
"properties": {
|
|
11762
|
+
"pageObjectNumber": {
|
|
11763
|
+
"type": "integer",
|
|
11764
|
+
"exclusiveMinimum": true,
|
|
11765
|
+
"minimum": 0
|
|
11766
|
+
},
|
|
11767
|
+
"revision": {
|
|
11768
|
+
"type": "object",
|
|
11769
|
+
"properties": {
|
|
11770
|
+
"docSessionId": {
|
|
11771
|
+
"type": "string"
|
|
11772
|
+
},
|
|
11773
|
+
"pageObjectNumber": {
|
|
11774
|
+
"type": "integer",
|
|
11775
|
+
"exclusiveMinimum": true,
|
|
11776
|
+
"minimum": 0
|
|
11777
|
+
},
|
|
11778
|
+
"generation": {
|
|
11779
|
+
"type": "integer",
|
|
11780
|
+
"minimum": 0
|
|
11781
|
+
}
|
|
11782
|
+
},
|
|
11783
|
+
"required": ["docSessionId", "pageObjectNumber", "generation"],
|
|
11784
|
+
"additionalProperties": false
|
|
11785
|
+
},
|
|
11786
|
+
"weakAnnotationState": {
|
|
11787
|
+
"anyOf": [
|
|
11788
|
+
{
|
|
11789
|
+
"type": "object",
|
|
11790
|
+
"properties": {
|
|
11791
|
+
"kind": {
|
|
11792
|
+
"type": "string",
|
|
11793
|
+
"enum": ["unknown"]
|
|
11794
|
+
}
|
|
11795
|
+
},
|
|
11796
|
+
"required": ["kind"],
|
|
11797
|
+
"additionalProperties": false
|
|
11798
|
+
},
|
|
11799
|
+
{
|
|
11800
|
+
"type": "object",
|
|
11801
|
+
"properties": {
|
|
11802
|
+
"kind": {
|
|
11803
|
+
"type": "string",
|
|
11804
|
+
"enum": ["known"]
|
|
11805
|
+
},
|
|
11806
|
+
"hasAnyWeakAnnotations": {
|
|
11807
|
+
"type": "boolean"
|
|
11808
|
+
}
|
|
11809
|
+
},
|
|
11810
|
+
"required": ["kind", "hasAnyWeakAnnotations"],
|
|
11811
|
+
"additionalProperties": false
|
|
11812
|
+
}
|
|
11813
|
+
]
|
|
11814
|
+
}
|
|
11815
|
+
},
|
|
11816
|
+
"required": ["pageObjectNumber", "revision", "weakAnnotationState"],
|
|
11817
|
+
"additionalProperties": false
|
|
11818
|
+
}
|
|
11819
|
+
},
|
|
11820
|
+
"cacheDelta": {
|
|
11821
|
+
"type": "object",
|
|
11822
|
+
"properties": {
|
|
11823
|
+
"previousDocVersion": {
|
|
11824
|
+
"type": "integer",
|
|
11825
|
+
"exclusiveMinimum": true,
|
|
11826
|
+
"minimum": 0
|
|
11827
|
+
},
|
|
11828
|
+
"docVersion": {
|
|
11829
|
+
"type": "integer",
|
|
11830
|
+
"exclusiveMinimum": true,
|
|
11831
|
+
"minimum": 0
|
|
11832
|
+
},
|
|
11833
|
+
"pages": {
|
|
11834
|
+
"type": "array",
|
|
11835
|
+
"items": {
|
|
11836
|
+
"type": "object",
|
|
11837
|
+
"properties": {
|
|
11838
|
+
"pageObjectNumber": {
|
|
11839
|
+
"type": "integer",
|
|
11840
|
+
"exclusiveMinimum": true,
|
|
11841
|
+
"minimum": 0
|
|
11842
|
+
},
|
|
11843
|
+
"cache": {
|
|
11844
|
+
"type": "object",
|
|
11845
|
+
"properties": {
|
|
11846
|
+
"contentVersion": {
|
|
11847
|
+
"type": "integer",
|
|
11848
|
+
"exclusiveMinimum": true,
|
|
11849
|
+
"minimum": 0
|
|
11850
|
+
},
|
|
11851
|
+
"annotationVersion": {
|
|
11852
|
+
"type": "integer",
|
|
11853
|
+
"exclusiveMinimum": true,
|
|
11854
|
+
"minimum": 0
|
|
11855
|
+
}
|
|
11856
|
+
},
|
|
11857
|
+
"required": ["contentVersion", "annotationVersion"],
|
|
11858
|
+
"additionalProperties": false
|
|
11859
|
+
}
|
|
11860
|
+
},
|
|
11861
|
+
"required": ["pageObjectNumber", "cache"],
|
|
11862
|
+
"additionalProperties": false
|
|
11863
|
+
}
|
|
11864
|
+
}
|
|
11865
|
+
},
|
|
11866
|
+
"required": ["previousDocVersion", "docVersion", "pages"],
|
|
11867
|
+
"additionalProperties": false,
|
|
11868
|
+
"nullable": true
|
|
11869
|
+
}
|
|
11870
|
+
},
|
|
11871
|
+
"required": ["affectedPages", "cacheDelta"],
|
|
11872
|
+
"additionalProperties": false
|
|
11873
|
+
}
|
|
11874
|
+
},
|
|
11875
|
+
"required": ["meta"],
|
|
11876
|
+
"additionalProperties": true
|
|
11877
|
+
},
|
|
11878
|
+
"DocFormsReset404Response": {
|
|
11879
|
+
"type": "object",
|
|
11880
|
+
"properties": {
|
|
11881
|
+
"name": {
|
|
11882
|
+
"type": "string",
|
|
11883
|
+
"enum": ["EngineError"]
|
|
11167
11884
|
},
|
|
11168
|
-
"
|
|
11169
|
-
"type": "
|
|
11170
|
-
"
|
|
11171
|
-
"
|
|
11172
|
-
|
|
11173
|
-
|
|
11174
|
-
|
|
11175
|
-
|
|
11176
|
-
"
|
|
11177
|
-
|
|
11885
|
+
"code": {
|
|
11886
|
+
"type": "string",
|
|
11887
|
+
"enum": [
|
|
11888
|
+
"Unknown",
|
|
11889
|
+
"InvalidArg",
|
|
11890
|
+
"DocNotOpen",
|
|
11891
|
+
"DocOpenFailed",
|
|
11892
|
+
"DocPasswordRequired",
|
|
11893
|
+
"DocPasswordIncorrect",
|
|
11894
|
+
"SharePasswordRequired",
|
|
11895
|
+
"Aborted",
|
|
11896
|
+
"Network",
|
|
11897
|
+
"Unauthenticated",
|
|
11898
|
+
"Forbidden",
|
|
11899
|
+
"NotFound",
|
|
11900
|
+
"WireFormat",
|
|
11901
|
+
"RuntimeUnavailable",
|
|
11902
|
+
"InvalidReference",
|
|
11903
|
+
"WeakAnnotationSessionConflict",
|
|
11904
|
+
"LayerVersionConflict",
|
|
11905
|
+
"NotImplemented",
|
|
11906
|
+
"MalformedPdf"
|
|
11907
|
+
]
|
|
11908
|
+
},
|
|
11909
|
+
"message": {
|
|
11910
|
+
"type": "string"
|
|
11911
|
+
},
|
|
11912
|
+
"details": {
|
|
11913
|
+
"type": "object",
|
|
11914
|
+
"additionalProperties": {}
|
|
11178
11915
|
}
|
|
11179
11916
|
},
|
|
11180
|
-
"required": ["
|
|
11917
|
+
"required": ["name", "code", "message"],
|
|
11181
11918
|
"additionalProperties": false
|
|
11182
11919
|
},
|
|
11183
|
-
"
|
|
11920
|
+
"DocFormsExportDataResponse": {
|
|
11184
11921
|
"type": "object",
|
|
11185
11922
|
"properties": {
|
|
11186
11923
|
"name": {
|
|
@@ -11222,11 +11959,11 @@
|
|
|
11222
11959
|
"required": ["name", "code", "message"],
|
|
11223
11960
|
"additionalProperties": false
|
|
11224
11961
|
},
|
|
11225
|
-
"
|
|
11962
|
+
"DocFormsImportDataRequest": {
|
|
11226
11963
|
"type": "object",
|
|
11227
11964
|
"additionalProperties": {}
|
|
11228
11965
|
},
|
|
11229
|
-
"
|
|
11966
|
+
"DocFormsImportData200Response": {
|
|
11230
11967
|
"type": "object",
|
|
11231
11968
|
"properties": {
|
|
11232
11969
|
"meta": {
|
|
@@ -11353,7 +12090,7 @@
|
|
|
11353
12090
|
"required": ["meta"],
|
|
11354
12091
|
"additionalProperties": true
|
|
11355
12092
|
},
|
|
11356
|
-
"
|
|
12093
|
+
"DocFormsImportData400Response": {
|
|
11357
12094
|
"type": "object",
|
|
11358
12095
|
"properties": {
|
|
11359
12096
|
"name": {
|
|
@@ -11395,7 +12132,7 @@
|
|
|
11395
12132
|
"required": ["name", "code", "message"],
|
|
11396
12133
|
"additionalProperties": false
|
|
11397
12134
|
},
|
|
11398
|
-
"
|
|
12135
|
+
"DocFormsImportData404Response": {
|
|
11399
12136
|
"type": "object",
|
|
11400
12137
|
"properties": {
|
|
11401
12138
|
"name": {
|
|
@@ -11437,7 +12174,11 @@
|
|
|
11437
12174
|
"required": ["name", "code", "message"],
|
|
11438
12175
|
"additionalProperties": false
|
|
11439
12176
|
},
|
|
11440
|
-
"
|
|
12177
|
+
"DocPagesMoveRequest": {
|
|
12178
|
+
"type": "object",
|
|
12179
|
+
"additionalProperties": {}
|
|
12180
|
+
},
|
|
12181
|
+
"DocPagesMove200Response": {
|
|
11441
12182
|
"type": "object",
|
|
11442
12183
|
"properties": {
|
|
11443
12184
|
"meta": {
|
|
@@ -11564,7 +12305,7 @@
|
|
|
11564
12305
|
"required": ["meta"],
|
|
11565
12306
|
"additionalProperties": true
|
|
11566
12307
|
},
|
|
11567
|
-
"
|
|
12308
|
+
"DocPagesMove400Response": {
|
|
11568
12309
|
"type": "object",
|
|
11569
12310
|
"properties": {
|
|
11570
12311
|
"name": {
|
|
@@ -11606,7 +12347,7 @@
|
|
|
11606
12347
|
"required": ["name", "code", "message"],
|
|
11607
12348
|
"additionalProperties": false
|
|
11608
12349
|
},
|
|
11609
|
-
"
|
|
12350
|
+
"DocPagesMove404Response": {
|
|
11610
12351
|
"type": "object",
|
|
11611
12352
|
"properties": {
|
|
11612
12353
|
"name": {
|
|
@@ -11648,11 +12389,11 @@
|
|
|
11648
12389
|
"required": ["name", "code", "message"],
|
|
11649
12390
|
"additionalProperties": false
|
|
11650
12391
|
},
|
|
11651
|
-
"
|
|
12392
|
+
"DocPagesRotateRequest": {
|
|
11652
12393
|
"type": "object",
|
|
11653
12394
|
"additionalProperties": {}
|
|
11654
12395
|
},
|
|
11655
|
-
"
|
|
12396
|
+
"DocPagesRotate200Response": {
|
|
11656
12397
|
"type": "object",
|
|
11657
12398
|
"properties": {
|
|
11658
12399
|
"meta": {
|
|
@@ -11779,7 +12520,7 @@
|
|
|
11779
12520
|
"required": ["meta"],
|
|
11780
12521
|
"additionalProperties": true
|
|
11781
12522
|
},
|
|
11782
|
-
"
|
|
12523
|
+
"DocPagesRotate400Response": {
|
|
11783
12524
|
"type": "object",
|
|
11784
12525
|
"properties": {
|
|
11785
12526
|
"name": {
|
|
@@ -11821,7 +12562,7 @@
|
|
|
11821
12562
|
"required": ["name", "code", "message"],
|
|
11822
12563
|
"additionalProperties": false
|
|
11823
12564
|
},
|
|
11824
|
-
"
|
|
12565
|
+
"DocPagesRotate404Response": {
|
|
11825
12566
|
"type": "object",
|
|
11826
12567
|
"properties": {
|
|
11827
12568
|
"name": {
|
|
@@ -11863,11 +12604,11 @@
|
|
|
11863
12604
|
"required": ["name", "code", "message"],
|
|
11864
12605
|
"additionalProperties": false
|
|
11865
12606
|
},
|
|
11866
|
-
"
|
|
12607
|
+
"DocPagesDeleteRequest": {
|
|
11867
12608
|
"type": "object",
|
|
11868
12609
|
"additionalProperties": {}
|
|
11869
12610
|
},
|
|
11870
|
-
"
|
|
12611
|
+
"DocPagesDelete200Response": {
|
|
11871
12612
|
"type": "object",
|
|
11872
12613
|
"properties": {
|
|
11873
12614
|
"meta": {
|
|
@@ -11994,7 +12735,7 @@
|
|
|
11994
12735
|
"required": ["meta"],
|
|
11995
12736
|
"additionalProperties": true
|
|
11996
12737
|
},
|
|
11997
|
-
"
|
|
12738
|
+
"DocPagesDelete400Response": {
|
|
11998
12739
|
"type": "object",
|
|
11999
12740
|
"properties": {
|
|
12000
12741
|
"name": {
|
|
@@ -12036,7 +12777,7 @@
|
|
|
12036
12777
|
"required": ["name", "code", "message"],
|
|
12037
12778
|
"additionalProperties": false
|
|
12038
12779
|
},
|
|
12039
|
-
"
|
|
12780
|
+
"DocPagesDelete404Response": {
|
|
12040
12781
|
"type": "object",
|
|
12041
12782
|
"properties": {
|
|
12042
12783
|
"name": {
|
|
@@ -12078,11 +12819,11 @@
|
|
|
12078
12819
|
"required": ["name", "code", "message"],
|
|
12079
12820
|
"additionalProperties": false
|
|
12080
12821
|
},
|
|
12081
|
-
"
|
|
12822
|
+
"DocPagesFlattenRequest": {
|
|
12082
12823
|
"type": "object",
|
|
12083
12824
|
"additionalProperties": {}
|
|
12084
12825
|
},
|
|
12085
|
-
"
|
|
12826
|
+
"DocPagesFlatten200Response": {
|
|
12086
12827
|
"type": "object",
|
|
12087
12828
|
"properties": {
|
|
12088
12829
|
"meta": {
|
|
@@ -12209,7 +12950,7 @@
|
|
|
12209
12950
|
"required": ["meta"],
|
|
12210
12951
|
"additionalProperties": true
|
|
12211
12952
|
},
|
|
12212
|
-
"
|
|
12953
|
+
"DocPagesFlatten400Response": {
|
|
12213
12954
|
"type": "object",
|
|
12214
12955
|
"properties": {
|
|
12215
12956
|
"name": {
|
|
@@ -12251,7 +12992,7 @@
|
|
|
12251
12992
|
"required": ["name", "code", "message"],
|
|
12252
12993
|
"additionalProperties": false
|
|
12253
12994
|
},
|
|
12254
|
-
"
|
|
12995
|
+
"DocPagesFlatten404Response": {
|
|
12255
12996
|
"type": "object",
|
|
12256
12997
|
"properties": {
|
|
12257
12998
|
"name": {
|
|
@@ -12293,11 +13034,7 @@
|
|
|
12293
13034
|
"required": ["name", "code", "message"],
|
|
12294
13035
|
"additionalProperties": false
|
|
12295
13036
|
},
|
|
12296
|
-
"
|
|
12297
|
-
"type": "object",
|
|
12298
|
-
"additionalProperties": {}
|
|
12299
|
-
},
|
|
12300
|
-
"DocPagesDelete200Response": {
|
|
13037
|
+
"DocPagesInsert200Response": {
|
|
12301
13038
|
"type": "object",
|
|
12302
13039
|
"properties": {
|
|
12303
13040
|
"meta": {
|
|
@@ -12424,7 +13161,7 @@
|
|
|
12424
13161
|
"required": ["meta"],
|
|
12425
13162
|
"additionalProperties": true
|
|
12426
13163
|
},
|
|
12427
|
-
"
|
|
13164
|
+
"DocPagesInsert400Response": {
|
|
12428
13165
|
"type": "object",
|
|
12429
13166
|
"properties": {
|
|
12430
13167
|
"name": {
|
|
@@ -12466,7 +13203,7 @@
|
|
|
12466
13203
|
"required": ["name", "code", "message"],
|
|
12467
13204
|
"additionalProperties": false
|
|
12468
13205
|
},
|
|
12469
|
-
"
|
|
13206
|
+
"DocPagesInsert404Response": {
|
|
12470
13207
|
"type": "object",
|
|
12471
13208
|
"properties": {
|
|
12472
13209
|
"name": {
|
|
@@ -12508,11 +13245,11 @@
|
|
|
12508
13245
|
"required": ["name", "code", "message"],
|
|
12509
13246
|
"additionalProperties": false
|
|
12510
13247
|
},
|
|
12511
|
-
"
|
|
13248
|
+
"DocPagesInsertBlankRequest": {
|
|
12512
13249
|
"type": "object",
|
|
12513
13250
|
"additionalProperties": {}
|
|
12514
13251
|
},
|
|
12515
|
-
"
|
|
13252
|
+
"DocPagesInsertBlank200Response": {
|
|
12516
13253
|
"type": "object",
|
|
12517
13254
|
"properties": {
|
|
12518
13255
|
"meta": {
|
|
@@ -12639,7 +13376,7 @@
|
|
|
12639
13376
|
"required": ["meta"],
|
|
12640
13377
|
"additionalProperties": true
|
|
12641
13378
|
},
|
|
12642
|
-
"
|
|
13379
|
+
"DocPagesInsertBlank400Response": {
|
|
12643
13380
|
"type": "object",
|
|
12644
13381
|
"properties": {
|
|
12645
13382
|
"name": {
|
|
@@ -12681,7 +13418,95 @@
|
|
|
12681
13418
|
"required": ["name", "code", "message"],
|
|
12682
13419
|
"additionalProperties": false
|
|
12683
13420
|
},
|
|
12684
|
-
"
|
|
13421
|
+
"DocPagesInsertBlank404Response": {
|
|
13422
|
+
"type": "object",
|
|
13423
|
+
"properties": {
|
|
13424
|
+
"name": {
|
|
13425
|
+
"type": "string",
|
|
13426
|
+
"enum": ["EngineError"]
|
|
13427
|
+
},
|
|
13428
|
+
"code": {
|
|
13429
|
+
"type": "string",
|
|
13430
|
+
"enum": [
|
|
13431
|
+
"Unknown",
|
|
13432
|
+
"InvalidArg",
|
|
13433
|
+
"DocNotOpen",
|
|
13434
|
+
"DocOpenFailed",
|
|
13435
|
+
"DocPasswordRequired",
|
|
13436
|
+
"DocPasswordIncorrect",
|
|
13437
|
+
"SharePasswordRequired",
|
|
13438
|
+
"Aborted",
|
|
13439
|
+
"Network",
|
|
13440
|
+
"Unauthenticated",
|
|
13441
|
+
"Forbidden",
|
|
13442
|
+
"NotFound",
|
|
13443
|
+
"WireFormat",
|
|
13444
|
+
"RuntimeUnavailable",
|
|
13445
|
+
"InvalidReference",
|
|
13446
|
+
"WeakAnnotationSessionConflict",
|
|
13447
|
+
"LayerVersionConflict",
|
|
13448
|
+
"NotImplemented",
|
|
13449
|
+
"MalformedPdf"
|
|
13450
|
+
]
|
|
13451
|
+
},
|
|
13452
|
+
"message": {
|
|
13453
|
+
"type": "string"
|
|
13454
|
+
},
|
|
13455
|
+
"details": {
|
|
13456
|
+
"type": "object",
|
|
13457
|
+
"additionalProperties": {}
|
|
13458
|
+
}
|
|
13459
|
+
},
|
|
13460
|
+
"required": ["name", "code", "message"],
|
|
13461
|
+
"additionalProperties": false
|
|
13462
|
+
},
|
|
13463
|
+
"DocPagesExtractRequest": {
|
|
13464
|
+
"type": "object",
|
|
13465
|
+
"additionalProperties": {}
|
|
13466
|
+
},
|
|
13467
|
+
"DocPagesExtract400Response": {
|
|
13468
|
+
"type": "object",
|
|
13469
|
+
"properties": {
|
|
13470
|
+
"name": {
|
|
13471
|
+
"type": "string",
|
|
13472
|
+
"enum": ["EngineError"]
|
|
13473
|
+
},
|
|
13474
|
+
"code": {
|
|
13475
|
+
"type": "string",
|
|
13476
|
+
"enum": [
|
|
13477
|
+
"Unknown",
|
|
13478
|
+
"InvalidArg",
|
|
13479
|
+
"DocNotOpen",
|
|
13480
|
+
"DocOpenFailed",
|
|
13481
|
+
"DocPasswordRequired",
|
|
13482
|
+
"DocPasswordIncorrect",
|
|
13483
|
+
"SharePasswordRequired",
|
|
13484
|
+
"Aborted",
|
|
13485
|
+
"Network",
|
|
13486
|
+
"Unauthenticated",
|
|
13487
|
+
"Forbidden",
|
|
13488
|
+
"NotFound",
|
|
13489
|
+
"WireFormat",
|
|
13490
|
+
"RuntimeUnavailable",
|
|
13491
|
+
"InvalidReference",
|
|
13492
|
+
"WeakAnnotationSessionConflict",
|
|
13493
|
+
"LayerVersionConflict",
|
|
13494
|
+
"NotImplemented",
|
|
13495
|
+
"MalformedPdf"
|
|
13496
|
+
]
|
|
13497
|
+
},
|
|
13498
|
+
"message": {
|
|
13499
|
+
"type": "string"
|
|
13500
|
+
},
|
|
13501
|
+
"details": {
|
|
13502
|
+
"type": "object",
|
|
13503
|
+
"additionalProperties": {}
|
|
13504
|
+
}
|
|
13505
|
+
},
|
|
13506
|
+
"required": ["name", "code", "message"],
|
|
13507
|
+
"additionalProperties": false
|
|
13508
|
+
},
|
|
13509
|
+
"DocPagesExtract404Response": {
|
|
12685
13510
|
"type": "object",
|
|
12686
13511
|
"properties": {
|
|
12687
13512
|
"name": {
|