cloudpdf 3.0.0.alpha.17 → 3.0.0.alpha.18
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 +4 -4
- data/.fern/metadata.json +2 -2
- data/lib/CloudPDF/client.rb +5 -0
- data/lib/CloudPDF/doc/signatures/client.rb +5 -4
- data/lib/CloudPDF/doc/versions/client.rb +27 -10
- data/lib/CloudPDF/doc/versions/types/analysis_versions_request.rb +2 -0
- data/lib/CloudPDF/doc/versions/types/download_versions_request.rb +2 -0
- data/lib/CloudPDF/doc/versions/types/list_versions_request.rb +2 -0
- data/lib/CloudPDF/doc/versions/types/revision_versions_request.rb +2 -0
- data/lib/CloudPDF/doc/versions/types/signature_contents_versions_request.rb +2 -0
- data/lib/CloudPDF/doc/versions/types/signature_digest_versions_request.rb +2 -0
- data/lib/CloudPDF/doc/versions/types/signatures_versions_request.rb +2 -0
- data/lib/CloudPDF/documents/client.rb +55 -0
- data/lib/CloudPDF/documents/types/documents_import_from_request.rb +4 -0
- data/lib/CloudPDF/documents/types/documents_init_request.rb +4 -0
- data/lib/CloudPDF/documents/types/documents_update_request.rb +15 -0
- data/lib/CloudPDF/documents/types/list_documents_request.rb +8 -0
- data/lib/CloudPDF/documents/types/list_documents_request_order.rb +14 -0
- data/lib/CloudPDF/documents/types/list_documents_request_sort.rb +15 -0
- data/lib/CloudPDF/folders/client.rb +286 -0
- data/lib/CloudPDF/folders/types/delete_folders_request.rb +15 -0
- data/lib/CloudPDF/folders/types/folders_create_request.rb +15 -0
- data/lib/CloudPDF/folders/types/folders_move_into_request.rb +17 -0
- data/lib/CloudPDF/folders/types/folders_update_request.rb +15 -0
- data/lib/CloudPDF/folders/types/get_folders_request.rb +13 -0
- data/lib/CloudPDF/folders/types/list_folders_request.rb +17 -0
- data/lib/CloudPDF/shares/types/shares_create_request.rb +2 -0
- data/lib/CloudPDF/shares/types/shares_update_request.rb +2 -0
- data/lib/CloudPDF/types/doc_versions_list200response.rb +1 -1
- data/lib/CloudPDF/types/documents_commit200response_document.rb +4 -0
- data/lib/CloudPDF/types/documents_get200response_document.rb +4 -0
- data/lib/CloudPDF/types/documents_import_from200response_document.rb +4 -0
- data/lib/CloudPDF/types/documents_import_from202response_document.rb +4 -0
- data/lib/CloudPDF/types/documents_init200response_created_document.rb +4 -0
- data/lib/CloudPDF/types/documents_init200response_deduped_document.rb +4 -0
- data/lib/CloudPDF/types/documents_init200response_resumed_document.rb +4 -0
- data/lib/CloudPDF/types/documents_list200response_documents_item.rb +4 -0
- data/lib/CloudPDF/types/documents_update200response.rb +9 -0
- data/lib/CloudPDF/types/documents_update200response_document.rb +37 -0
- data/lib/CloudPDF/types/documents_update200response_document_state.rb +14 -0
- data/lib/CloudPDF/types/documents_update200response_document_thumbnail_state.rb +14 -0
- data/lib/CloudPDF/types/documents_update400response.rb +23 -0
- data/lib/CloudPDF/types/documents_update403response.rb +23 -0
- data/lib/CloudPDF/types/documents_update404response.rb +23 -0
- data/lib/CloudPDF/types/engine_error_payload_code.rb +0 -1
- data/lib/CloudPDF/types/folders_create200response.rb +9 -0
- data/lib/CloudPDF/types/folders_create200response_folder.rb +21 -0
- data/lib/CloudPDF/types/folders_create400response.rb +23 -0
- data/lib/CloudPDF/types/folders_create403response.rb +23 -0
- data/lib/CloudPDF/types/folders_create404response.rb +23 -0
- data/lib/CloudPDF/types/folders_create409response.rb +23 -0
- data/lib/CloudPDF/types/folders_delete403response.rb +23 -0
- data/lib/CloudPDF/types/folders_delete404response.rb +23 -0
- data/lib/CloudPDF/types/folders_delete409response.rb +23 -0
- data/lib/CloudPDF/types/folders_get200response.rb +11 -0
- data/lib/CloudPDF/types/folders_get200response_folder.rb +21 -0
- data/lib/CloudPDF/types/folders_get200response_path_item.rb +11 -0
- data/lib/CloudPDF/types/folders_get403response.rb +23 -0
- data/lib/CloudPDF/types/folders_get404response.rb +23 -0
- data/lib/CloudPDF/types/folders_list200response.rb +11 -0
- data/lib/CloudPDF/types/folders_list200response_folders_item.rb +21 -0
- data/lib/CloudPDF/types/folders_list400response.rb +23 -0
- data/lib/CloudPDF/types/folders_list403response.rb +23 -0
- data/lib/CloudPDF/types/folders_list404response.rb +23 -0
- data/lib/CloudPDF/types/folders_move_into400response.rb +23 -0
- data/lib/CloudPDF/types/folders_move_into403response.rb +23 -0
- data/lib/CloudPDF/types/folders_move_into404response.rb +23 -0
- data/lib/CloudPDF/types/folders_move_into409response.rb +23 -0
- data/lib/CloudPDF/types/folders_update200response.rb +9 -0
- data/lib/CloudPDF/types/folders_update200response_folder.rb +21 -0
- data/lib/CloudPDF/types/folders_update400response.rb +23 -0
- data/lib/CloudPDF/types/folders_update403response.rb +23 -0
- data/lib/CloudPDF/types/folders_update404response.rb +23 -0
- data/lib/CloudPDF/types/folders_update409response.rb +23 -0
- data/lib/CloudPDF/types/{tokens_issue_request_doc_identity.rb → identity.rb} +1 -1
- data/lib/CloudPDF/types/shares_archive200response_share.rb +2 -0
- data/lib/CloudPDF/types/shares_create200response_share.rb +2 -0
- data/lib/CloudPDF/types/shares_get200response_share.rb +2 -0
- data/lib/CloudPDF/types/shares_list200response_shares_item.rb +2 -0
- data/lib/CloudPDF/types/shares_update200response_share.rb +2 -0
- data/lib/CloudPDF/types/tokens_issue_request_doc.rb +1 -1
- data/lib/CloudPDF/types/tokens_issue_request_tenant.rb +1 -1
- data/lib/CloudPDF/version.rb +1 -1
- data/lib/cloudpdf.rb +47 -4
- data/reference.md +833 -141
- metadata +49 -6
- data/lib/CloudPDF/types/tokens_issue_request_tenant_scope_item.rb +0 -13
- data/lib/CloudPDF/types/tokens_issue_request_tenant_scope_item_one.rb +0 -16
- data/lib/CloudPDF/types/tokens_issue_request_tenant_scope_item_zero.rb +0 -11
data/reference.md
CHANGED
|
@@ -855,6 +855,14 @@ client.shares.create(
|
|
|
855
855
|
<dl>
|
|
856
856
|
<dd>
|
|
857
857
|
|
|
858
|
+
**identity:** `CloudPDF::Types::Identity`
|
|
859
|
+
|
|
860
|
+
</dd>
|
|
861
|
+
</dl>
|
|
862
|
+
|
|
863
|
+
<dl>
|
|
864
|
+
<dd>
|
|
865
|
+
|
|
858
866
|
**scope:** `Internal::Types::Array[String]`
|
|
859
867
|
|
|
860
868
|
</dd>
|
|
@@ -1112,6 +1120,14 @@ client.shares.update(
|
|
|
1112
1120
|
<dl>
|
|
1113
1121
|
<dd>
|
|
1114
1122
|
|
|
1123
|
+
**identity:** `CloudPDF::Types::Identity`
|
|
1124
|
+
|
|
1125
|
+
</dd>
|
|
1126
|
+
</dl>
|
|
1127
|
+
|
|
1128
|
+
<dl>
|
|
1129
|
+
<dd>
|
|
1130
|
+
|
|
1115
1131
|
**scope:** `Internal::Types::Array[String]`
|
|
1116
1132
|
|
|
1117
1133
|
</dd>
|
|
@@ -1709,7 +1725,39 @@ client.documents.list(tenant_id: "tenantId")
|
|
|
1709
1725
|
<dl>
|
|
1710
1726
|
<dd>
|
|
1711
1727
|
|
|
1712
|
-
**state:** `CloudPDF::Documents::Types::ListDocumentsRequestState`
|
|
1728
|
+
**state:** `CloudPDF::Documents::Types::ListDocumentsRequestState` — Only documents in this state. Without it, every state except deleting.
|
|
1729
|
+
|
|
1730
|
+
</dd>
|
|
1731
|
+
</dl>
|
|
1732
|
+
|
|
1733
|
+
<dl>
|
|
1734
|
+
<dd>
|
|
1735
|
+
|
|
1736
|
+
**q:** `String` — Only documents whose name contains this text, ignoring case.
|
|
1737
|
+
|
|
1738
|
+
</dd>
|
|
1739
|
+
</dl>
|
|
1740
|
+
|
|
1741
|
+
<dl>
|
|
1742
|
+
<dd>
|
|
1743
|
+
|
|
1744
|
+
**folder_id:** `String` — Only documents directly in this folder (root: the top level). Without it, documents in every folder.
|
|
1745
|
+
|
|
1746
|
+
</dd>
|
|
1747
|
+
</dl>
|
|
1748
|
+
|
|
1749
|
+
<dl>
|
|
1750
|
+
<dd>
|
|
1751
|
+
|
|
1752
|
+
**sort:** `CloudPDF::Documents::Types::ListDocumentsRequestSort` — createdAt (default), name (ignoring case), or size (stored bytes; 0 while pending).
|
|
1753
|
+
|
|
1754
|
+
</dd>
|
|
1755
|
+
</dl>
|
|
1756
|
+
|
|
1757
|
+
<dl>
|
|
1758
|
+
<dd>
|
|
1759
|
+
|
|
1760
|
+
**order:** `CloudPDF::Documents::Types::ListDocumentsRequestOrder` — Defaults to the reading order of the sort: A to Z for name, newest and largest first otherwise.
|
|
1713
1761
|
|
|
1714
1762
|
</dd>
|
|
1715
1763
|
</dl>
|
|
@@ -1786,40 +1834,650 @@ client.documents.get(
|
|
|
1786
1834
|
|
|
1787
1835
|
</dd>
|
|
1788
1836
|
</dl>
|
|
1789
|
-
</details>
|
|
1837
|
+
</details>
|
|
1838
|
+
|
|
1839
|
+
<details><summary><code>client.documents.<a href="/lib/CloudPDF/documents/client.rb">delete</a>(tenant_id:, id:) -> </code></summary>
|
|
1840
|
+
<dl>
|
|
1841
|
+
<dd>
|
|
1842
|
+
|
|
1843
|
+
#### 🔌 Usage
|
|
1844
|
+
|
|
1845
|
+
<dl>
|
|
1846
|
+
<dd>
|
|
1847
|
+
|
|
1848
|
+
<dl>
|
|
1849
|
+
<dd>
|
|
1850
|
+
|
|
1851
|
+
```ruby
|
|
1852
|
+
client.documents.delete(
|
|
1853
|
+
tenant_id: "tenantId",
|
|
1854
|
+
id: "id"
|
|
1855
|
+
)
|
|
1856
|
+
```
|
|
1857
|
+
</dd>
|
|
1858
|
+
</dl>
|
|
1859
|
+
</dd>
|
|
1860
|
+
</dl>
|
|
1861
|
+
|
|
1862
|
+
#### ⚙️ Parameters
|
|
1863
|
+
|
|
1864
|
+
<dl>
|
|
1865
|
+
<dd>
|
|
1866
|
+
|
|
1867
|
+
<dl>
|
|
1868
|
+
<dd>
|
|
1869
|
+
|
|
1870
|
+
**tenant_id:** `String`
|
|
1871
|
+
|
|
1872
|
+
</dd>
|
|
1873
|
+
</dl>
|
|
1874
|
+
|
|
1875
|
+
<dl>
|
|
1876
|
+
<dd>
|
|
1877
|
+
|
|
1878
|
+
**id:** `String`
|
|
1879
|
+
|
|
1880
|
+
</dd>
|
|
1881
|
+
</dl>
|
|
1882
|
+
|
|
1883
|
+
<dl>
|
|
1884
|
+
<dd>
|
|
1885
|
+
|
|
1886
|
+
**request_options:** `CloudPDF::Documents::RequestOptions`
|
|
1887
|
+
|
|
1888
|
+
</dd>
|
|
1889
|
+
</dl>
|
|
1890
|
+
</dd>
|
|
1891
|
+
</dl>
|
|
1892
|
+
|
|
1893
|
+
|
|
1894
|
+
</dd>
|
|
1895
|
+
</dl>
|
|
1896
|
+
</details>
|
|
1897
|
+
|
|
1898
|
+
<details><summary><code>client.documents.<a href="/lib/CloudPDF/documents/client.rb">update</a>(tenant_id:, id:, request) -> CloudPDF::Types::DocumentsUpdate200Response</code></summary>
|
|
1899
|
+
<dl>
|
|
1900
|
+
<dd>
|
|
1901
|
+
|
|
1902
|
+
#### 📝 Description
|
|
1903
|
+
|
|
1904
|
+
<dl>
|
|
1905
|
+
<dd>
|
|
1906
|
+
|
|
1907
|
+
<dl>
|
|
1908
|
+
<dd>
|
|
1909
|
+
|
|
1910
|
+
A document that is being deleted answers 404.
|
|
1911
|
+
</dd>
|
|
1912
|
+
</dl>
|
|
1913
|
+
</dd>
|
|
1914
|
+
</dl>
|
|
1915
|
+
|
|
1916
|
+
#### 🔌 Usage
|
|
1917
|
+
|
|
1918
|
+
<dl>
|
|
1919
|
+
<dd>
|
|
1920
|
+
|
|
1921
|
+
<dl>
|
|
1922
|
+
<dd>
|
|
1923
|
+
|
|
1924
|
+
```ruby
|
|
1925
|
+
client.documents.update(
|
|
1926
|
+
tenant_id: "tenantId",
|
|
1927
|
+
id: "id",
|
|
1928
|
+
name: "name"
|
|
1929
|
+
)
|
|
1930
|
+
```
|
|
1931
|
+
</dd>
|
|
1932
|
+
</dl>
|
|
1933
|
+
</dd>
|
|
1934
|
+
</dl>
|
|
1935
|
+
|
|
1936
|
+
#### ⚙️ Parameters
|
|
1937
|
+
|
|
1938
|
+
<dl>
|
|
1939
|
+
<dd>
|
|
1940
|
+
|
|
1941
|
+
<dl>
|
|
1942
|
+
<dd>
|
|
1943
|
+
|
|
1944
|
+
**tenant_id:** `String`
|
|
1945
|
+
|
|
1946
|
+
</dd>
|
|
1947
|
+
</dl>
|
|
1948
|
+
|
|
1949
|
+
<dl>
|
|
1950
|
+
<dd>
|
|
1951
|
+
|
|
1952
|
+
**id:** `String`
|
|
1953
|
+
|
|
1954
|
+
</dd>
|
|
1955
|
+
</dl>
|
|
1956
|
+
|
|
1957
|
+
<dl>
|
|
1958
|
+
<dd>
|
|
1959
|
+
|
|
1960
|
+
**name:** `String` — What people call the document: shown in dashboards, searched and sorted by. 1 to 255 characters, no control characters, no leading or trailing whitespace. Names need not be unique.
|
|
1961
|
+
|
|
1962
|
+
</dd>
|
|
1963
|
+
</dl>
|
|
1964
|
+
|
|
1965
|
+
<dl>
|
|
1966
|
+
<dd>
|
|
1967
|
+
|
|
1968
|
+
**request_options:** `CloudPDF::Documents::RequestOptions`
|
|
1969
|
+
|
|
1970
|
+
</dd>
|
|
1971
|
+
</dl>
|
|
1972
|
+
</dd>
|
|
1973
|
+
</dl>
|
|
1974
|
+
|
|
1975
|
+
|
|
1976
|
+
</dd>
|
|
1977
|
+
</dl>
|
|
1978
|
+
</details>
|
|
1979
|
+
|
|
1980
|
+
<details><summary><code>client.documents.<a href="/lib/CloudPDF/documents/client.rb">commit</a>(tenant_id:, id:, request) -> CloudPDF::Types::DocumentsCommit200Response</code></summary>
|
|
1981
|
+
<dl>
|
|
1982
|
+
<dd>
|
|
1983
|
+
|
|
1984
|
+
#### 🔌 Usage
|
|
1985
|
+
|
|
1986
|
+
<dl>
|
|
1987
|
+
<dd>
|
|
1988
|
+
|
|
1989
|
+
<dl>
|
|
1990
|
+
<dd>
|
|
1991
|
+
|
|
1992
|
+
```ruby
|
|
1993
|
+
client.documents.commit(
|
|
1994
|
+
tenant_id: "tenantId",
|
|
1995
|
+
id: "id",
|
|
1996
|
+
sha256: "sha256"
|
|
1997
|
+
)
|
|
1998
|
+
```
|
|
1999
|
+
</dd>
|
|
2000
|
+
</dl>
|
|
2001
|
+
</dd>
|
|
2002
|
+
</dl>
|
|
2003
|
+
|
|
2004
|
+
#### ⚙️ Parameters
|
|
2005
|
+
|
|
2006
|
+
<dl>
|
|
2007
|
+
<dd>
|
|
2008
|
+
|
|
2009
|
+
<dl>
|
|
2010
|
+
<dd>
|
|
2011
|
+
|
|
2012
|
+
**tenant_id:** `String`
|
|
2013
|
+
|
|
2014
|
+
</dd>
|
|
2015
|
+
</dl>
|
|
2016
|
+
|
|
2017
|
+
<dl>
|
|
2018
|
+
<dd>
|
|
2019
|
+
|
|
2020
|
+
**id:** `String`
|
|
2021
|
+
|
|
2022
|
+
</dd>
|
|
2023
|
+
</dl>
|
|
2024
|
+
|
|
2025
|
+
<dl>
|
|
2026
|
+
<dd>
|
|
2027
|
+
|
|
2028
|
+
**sha256:** `String`
|
|
2029
|
+
|
|
2030
|
+
</dd>
|
|
2031
|
+
</dl>
|
|
2032
|
+
|
|
2033
|
+
<dl>
|
|
2034
|
+
<dd>
|
|
2035
|
+
|
|
2036
|
+
**request_options:** `CloudPDF::Documents::RequestOptions`
|
|
2037
|
+
|
|
2038
|
+
</dd>
|
|
2039
|
+
</dl>
|
|
2040
|
+
</dd>
|
|
2041
|
+
</dl>
|
|
2042
|
+
|
|
2043
|
+
|
|
2044
|
+
</dd>
|
|
2045
|
+
</dl>
|
|
2046
|
+
</details>
|
|
2047
|
+
|
|
2048
|
+
<details><summary><code>client.documents.<a href="/lib/CloudPDF/documents/client.rb">download</a>(tenant_id:, id:) -> String</code></summary>
|
|
2049
|
+
<dl>
|
|
2050
|
+
<dd>
|
|
2051
|
+
|
|
2052
|
+
#### 🔌 Usage
|
|
2053
|
+
|
|
2054
|
+
<dl>
|
|
2055
|
+
<dd>
|
|
2056
|
+
|
|
2057
|
+
<dl>
|
|
2058
|
+
<dd>
|
|
2059
|
+
|
|
2060
|
+
```ruby
|
|
2061
|
+
client.documents.download(
|
|
2062
|
+
tenant_id: "tenantId",
|
|
2063
|
+
id: "id"
|
|
2064
|
+
)
|
|
2065
|
+
```
|
|
2066
|
+
</dd>
|
|
2067
|
+
</dl>
|
|
2068
|
+
</dd>
|
|
2069
|
+
</dl>
|
|
2070
|
+
|
|
2071
|
+
#### ⚙️ Parameters
|
|
2072
|
+
|
|
2073
|
+
<dl>
|
|
2074
|
+
<dd>
|
|
2075
|
+
|
|
2076
|
+
<dl>
|
|
2077
|
+
<dd>
|
|
2078
|
+
|
|
2079
|
+
**tenant_id:** `String`
|
|
2080
|
+
|
|
2081
|
+
</dd>
|
|
2082
|
+
</dl>
|
|
2083
|
+
|
|
2084
|
+
<dl>
|
|
2085
|
+
<dd>
|
|
2086
|
+
|
|
2087
|
+
**id:** `String`
|
|
2088
|
+
|
|
2089
|
+
</dd>
|
|
2090
|
+
</dl>
|
|
2091
|
+
|
|
2092
|
+
<dl>
|
|
2093
|
+
<dd>
|
|
2094
|
+
|
|
2095
|
+
**request_options:** `CloudPDF::Documents::RequestOptions`
|
|
2096
|
+
|
|
2097
|
+
</dd>
|
|
2098
|
+
</dl>
|
|
2099
|
+
</dd>
|
|
2100
|
+
</dl>
|
|
2101
|
+
|
|
2102
|
+
|
|
2103
|
+
</dd>
|
|
2104
|
+
</dl>
|
|
2105
|
+
</details>
|
|
2106
|
+
|
|
2107
|
+
<details><summary><code>client.documents.<a href="/lib/CloudPDF/documents/client.rb">thumbnail</a>(tenant_id:, id:) -> String</code></summary>
|
|
2108
|
+
<dl>
|
|
2109
|
+
<dd>
|
|
2110
|
+
|
|
2111
|
+
#### 🔌 Usage
|
|
2112
|
+
|
|
2113
|
+
<dl>
|
|
2114
|
+
<dd>
|
|
2115
|
+
|
|
2116
|
+
<dl>
|
|
2117
|
+
<dd>
|
|
2118
|
+
|
|
2119
|
+
```ruby
|
|
2120
|
+
client.documents.thumbnail(
|
|
2121
|
+
tenant_id: "tenantId",
|
|
2122
|
+
id: "id"
|
|
2123
|
+
)
|
|
2124
|
+
```
|
|
2125
|
+
</dd>
|
|
2126
|
+
</dl>
|
|
2127
|
+
</dd>
|
|
2128
|
+
</dl>
|
|
2129
|
+
|
|
2130
|
+
#### ⚙️ Parameters
|
|
2131
|
+
|
|
2132
|
+
<dl>
|
|
2133
|
+
<dd>
|
|
2134
|
+
|
|
2135
|
+
<dl>
|
|
2136
|
+
<dd>
|
|
2137
|
+
|
|
2138
|
+
**tenant_id:** `String`
|
|
2139
|
+
|
|
2140
|
+
</dd>
|
|
2141
|
+
</dl>
|
|
2142
|
+
|
|
2143
|
+
<dl>
|
|
2144
|
+
<dd>
|
|
2145
|
+
|
|
2146
|
+
**id:** `String`
|
|
2147
|
+
|
|
2148
|
+
</dd>
|
|
2149
|
+
</dl>
|
|
2150
|
+
|
|
2151
|
+
<dl>
|
|
2152
|
+
<dd>
|
|
2153
|
+
|
|
2154
|
+
**request_options:** `CloudPDF::Documents::RequestOptions`
|
|
2155
|
+
|
|
2156
|
+
</dd>
|
|
2157
|
+
</dl>
|
|
2158
|
+
</dd>
|
|
2159
|
+
</dl>
|
|
2160
|
+
|
|
2161
|
+
|
|
2162
|
+
</dd>
|
|
2163
|
+
</dl>
|
|
2164
|
+
</details>
|
|
2165
|
+
|
|
2166
|
+
<details><summary><code>client.documents.<a href="/lib/CloudPDF/documents/client.rb">upload_proxy</a>(tenant_id:, id:, request) -> CloudPDF::Types::DocumentsUploadProxy200Response</code></summary>
|
|
2167
|
+
<dl>
|
|
2168
|
+
<dd>
|
|
2169
|
+
|
|
2170
|
+
#### 📝 Description
|
|
2171
|
+
|
|
2172
|
+
<dl>
|
|
2173
|
+
<dd>
|
|
2174
|
+
|
|
2175
|
+
<dl>
|
|
2176
|
+
<dd>
|
|
2177
|
+
|
|
2178
|
+
This bounded origin-mediated fallback must only be used after documents.init returns upload.kind=proxy. Auto mode prefers a presigned object-store PUT whenever available.
|
|
2179
|
+
</dd>
|
|
2180
|
+
</dl>
|
|
2181
|
+
</dd>
|
|
2182
|
+
</dl>
|
|
2183
|
+
|
|
2184
|
+
#### 🔌 Usage
|
|
2185
|
+
|
|
2186
|
+
<dl>
|
|
2187
|
+
<dd>
|
|
2188
|
+
|
|
2189
|
+
<dl>
|
|
2190
|
+
<dd>
|
|
2191
|
+
|
|
2192
|
+
```ruby
|
|
2193
|
+
File.open("document.pdf", "rb") do |file|
|
|
2194
|
+
client.documents.upload_proxy(
|
|
2195
|
+
tenant_id: "tenantId",
|
|
2196
|
+
id: "id",
|
|
2197
|
+
file: file
|
|
2198
|
+
)
|
|
2199
|
+
end
|
|
2200
|
+
```
|
|
2201
|
+
</dd>
|
|
2202
|
+
</dl>
|
|
2203
|
+
</dd>
|
|
2204
|
+
</dl>
|
|
2205
|
+
|
|
2206
|
+
#### ⚙️ Parameters
|
|
2207
|
+
|
|
2208
|
+
<dl>
|
|
2209
|
+
<dd>
|
|
2210
|
+
|
|
2211
|
+
<dl>
|
|
2212
|
+
<dd>
|
|
2213
|
+
|
|
2214
|
+
**tenant_id:** `String`
|
|
2215
|
+
|
|
2216
|
+
</dd>
|
|
2217
|
+
</dl>
|
|
2218
|
+
|
|
2219
|
+
<dl>
|
|
2220
|
+
<dd>
|
|
2221
|
+
|
|
2222
|
+
**id:** `String`
|
|
2223
|
+
|
|
2224
|
+
</dd>
|
|
2225
|
+
</dl>
|
|
2226
|
+
|
|
2227
|
+
<dl>
|
|
2228
|
+
<dd>
|
|
2229
|
+
|
|
2230
|
+
**request_options:** `CloudPDF::Documents::RequestOptions`
|
|
2231
|
+
|
|
2232
|
+
</dd>
|
|
2233
|
+
</dl>
|
|
2234
|
+
</dd>
|
|
2235
|
+
</dl>
|
|
2236
|
+
|
|
2237
|
+
|
|
2238
|
+
</dd>
|
|
2239
|
+
</dl>
|
|
2240
|
+
</details>
|
|
2241
|
+
|
|
2242
|
+
<details><summary><code>client.documents.<a href="/lib/CloudPDF/documents/client.rb">import_from</a>(tenant_id:, request) -> CloudPDF::Types::DocumentsImportFrom200Response</code></summary>
|
|
2243
|
+
<dl>
|
|
2244
|
+
<dd>
|
|
2245
|
+
|
|
2246
|
+
#### 📝 Description
|
|
2247
|
+
|
|
2248
|
+
<dl>
|
|
2249
|
+
<dd>
|
|
2250
|
+
|
|
2251
|
+
<dl>
|
|
2252
|
+
<dd>
|
|
2253
|
+
|
|
2254
|
+
Default mode is synchronous and bounded: the response returns only after the transfer verified and committed (or failed). mode=async (connection sources only) answers 202 immediately and an in-process worker performs the transfer with leased, fenced retries; poll the document until ready/failed. The deployment import policy gates scheme, network range, and size; sources must declare a length. CloudPDF copies and owns the bytes — the source is never referenced in place. A 502 marks a retryable upstream failure: retry with the same idempotencyKey to resume the same document. URL sources are capabilities and never echoed back. Connection sources name operator-registered storage (bucket/prefix scope, allowed credential classes, and tenant bindings are deployment configuration); `revision` is provider-interpreted (S3 VersionId, GCS generation, Azure version id).
|
|
2255
|
+
</dd>
|
|
2256
|
+
</dl>
|
|
2257
|
+
</dd>
|
|
2258
|
+
</dl>
|
|
2259
|
+
|
|
2260
|
+
#### 🔌 Usage
|
|
2261
|
+
|
|
2262
|
+
<dl>
|
|
2263
|
+
<dd>
|
|
2264
|
+
|
|
2265
|
+
<dl>
|
|
2266
|
+
<dd>
|
|
2267
|
+
|
|
2268
|
+
```ruby
|
|
2269
|
+
client.documents.import_from(tenant_id: "tenantId")
|
|
2270
|
+
```
|
|
2271
|
+
</dd>
|
|
2272
|
+
</dl>
|
|
2273
|
+
</dd>
|
|
2274
|
+
</dl>
|
|
2275
|
+
|
|
2276
|
+
#### ⚙️ Parameters
|
|
2277
|
+
|
|
2278
|
+
<dl>
|
|
2279
|
+
<dd>
|
|
2280
|
+
|
|
2281
|
+
<dl>
|
|
2282
|
+
<dd>
|
|
2283
|
+
|
|
2284
|
+
**tenant_id:** `String`
|
|
2285
|
+
|
|
2286
|
+
</dd>
|
|
2287
|
+
</dl>
|
|
2288
|
+
|
|
2289
|
+
<dl>
|
|
2290
|
+
<dd>
|
|
2291
|
+
|
|
2292
|
+
**source:** `CloudPDF::Documents::Types::DocumentsImportFromRequestSource` — Where CloudPDF pulls the bytes from. The two shapes differ in who supplies the authority to read, not in which storage vendor holds the file.
|
|
2293
|
+
|
|
2294
|
+
</dd>
|
|
2295
|
+
</dl>
|
|
2296
|
+
|
|
2297
|
+
<dl>
|
|
2298
|
+
<dd>
|
|
2299
|
+
|
|
2300
|
+
**expected:** `CloudPDF::Documents::Types::DocumentsImportFromRequestExpected` — Integrity pins, enforced when present. When absent, the server-observed values become authoritative.
|
|
2301
|
+
|
|
2302
|
+
</dd>
|
|
2303
|
+
</dl>
|
|
2304
|
+
|
|
2305
|
+
<dl>
|
|
2306
|
+
<dd>
|
|
2307
|
+
|
|
2308
|
+
**name:** `String` — What people call the document: shown in dashboards, searched and sorted by. 1 to 255 characters, no control characters, no leading or trailing whitespace. Names need not be unique.
|
|
2309
|
+
|
|
2310
|
+
</dd>
|
|
2311
|
+
</dl>
|
|
2312
|
+
|
|
2313
|
+
<dl>
|
|
2314
|
+
<dd>
|
|
2315
|
+
|
|
2316
|
+
**folder_id:** `String` — A folder id, or root for the top level.
|
|
2317
|
+
|
|
2318
|
+
</dd>
|
|
2319
|
+
</dl>
|
|
2320
|
+
|
|
2321
|
+
<dl>
|
|
2322
|
+
<dd>
|
|
2323
|
+
|
|
2324
|
+
**metadata:** `Internal::Types::Hash[String, Object]`
|
|
2325
|
+
|
|
2326
|
+
</dd>
|
|
2327
|
+
</dl>
|
|
2328
|
+
|
|
2329
|
+
<dl>
|
|
2330
|
+
<dd>
|
|
2331
|
+
|
|
2332
|
+
**idempotency_key:** `String` — Retrying with the same key resumes the same document rather than importing a second copy — including after a 502.
|
|
2333
|
+
|
|
2334
|
+
</dd>
|
|
2335
|
+
</dl>
|
|
2336
|
+
|
|
2337
|
+
<dl>
|
|
2338
|
+
<dd>
|
|
2339
|
+
|
|
2340
|
+
**dedup_mode:** `CloudPDF::Documents::Types::DocumentsImportFromRequestDedupMode` — always-create (default) creates a new document every time. reuse-existing returns a document that already holds the same content instead of storing it twice.
|
|
2341
|
+
|
|
2342
|
+
</dd>
|
|
2343
|
+
</dl>
|
|
2344
|
+
|
|
2345
|
+
<dl>
|
|
2346
|
+
<dd>
|
|
2347
|
+
|
|
2348
|
+
**doc_id:** `String`
|
|
2349
|
+
|
|
2350
|
+
</dd>
|
|
2351
|
+
</dl>
|
|
2352
|
+
|
|
2353
|
+
<dl>
|
|
2354
|
+
<dd>
|
|
2355
|
+
|
|
2356
|
+
**mode:** `CloudPDF::Documents::Types::DocumentsImportFromRequestMode` — sync (default) holds the response open for the whole transfer. async answers 202 with the document pending and transfers in the background; it requires a connection source, and filesystem connections additionally require expected.sha256.
|
|
2357
|
+
|
|
2358
|
+
</dd>
|
|
2359
|
+
</dl>
|
|
2360
|
+
|
|
2361
|
+
<dl>
|
|
2362
|
+
<dd>
|
|
2363
|
+
|
|
2364
|
+
**request_options:** `CloudPDF::Documents::RequestOptions`
|
|
2365
|
+
|
|
2366
|
+
</dd>
|
|
2367
|
+
</dl>
|
|
2368
|
+
</dd>
|
|
2369
|
+
</dl>
|
|
2370
|
+
|
|
2371
|
+
|
|
2372
|
+
</dd>
|
|
2373
|
+
</dl>
|
|
2374
|
+
</details>
|
|
2375
|
+
|
|
2376
|
+
<details><summary><code>client.documents.<a href="/lib/CloudPDF/documents/client.rb">init</a>(tenant_id:, request) -> CloudPDF::Types::DocumentsInit200Response</code></summary>
|
|
2377
|
+
<dl>
|
|
2378
|
+
<dd>
|
|
2379
|
+
|
|
2380
|
+
#### 🔌 Usage
|
|
2381
|
+
|
|
2382
|
+
<dl>
|
|
2383
|
+
<dd>
|
|
2384
|
+
|
|
2385
|
+
<dl>
|
|
2386
|
+
<dd>
|
|
2387
|
+
|
|
2388
|
+
```ruby
|
|
2389
|
+
client.documents.init(
|
|
2390
|
+
tenant_id: "tenantId",
|
|
2391
|
+
content_length: 1.1,
|
|
2392
|
+
content_sha256: "contentSha256"
|
|
2393
|
+
)
|
|
2394
|
+
```
|
|
2395
|
+
</dd>
|
|
2396
|
+
</dl>
|
|
2397
|
+
</dd>
|
|
2398
|
+
</dl>
|
|
2399
|
+
|
|
2400
|
+
#### ⚙️ Parameters
|
|
2401
|
+
|
|
2402
|
+
<dl>
|
|
2403
|
+
<dd>
|
|
2404
|
+
|
|
2405
|
+
<dl>
|
|
2406
|
+
<dd>
|
|
2407
|
+
|
|
2408
|
+
**tenant_id:** `String`
|
|
2409
|
+
|
|
2410
|
+
</dd>
|
|
2411
|
+
</dl>
|
|
2412
|
+
|
|
2413
|
+
<dl>
|
|
2414
|
+
<dd>
|
|
2415
|
+
|
|
2416
|
+
**content_length:** `Integer`
|
|
2417
|
+
|
|
2418
|
+
</dd>
|
|
2419
|
+
</dl>
|
|
2420
|
+
|
|
2421
|
+
<dl>
|
|
2422
|
+
<dd>
|
|
2423
|
+
|
|
2424
|
+
**content_sha256:** `String`
|
|
2425
|
+
|
|
2426
|
+
</dd>
|
|
2427
|
+
</dl>
|
|
2428
|
+
|
|
2429
|
+
<dl>
|
|
2430
|
+
<dd>
|
|
2431
|
+
|
|
2432
|
+
**name:** `String` — What people call the document: shown in dashboards, searched and sorted by. 1 to 255 characters, no control characters, no leading or trailing whitespace. Names need not be unique.
|
|
2433
|
+
|
|
2434
|
+
</dd>
|
|
2435
|
+
</dl>
|
|
2436
|
+
|
|
2437
|
+
<dl>
|
|
2438
|
+
<dd>
|
|
2439
|
+
|
|
2440
|
+
**folder_id:** `String` — A folder id, or root for the top level.
|
|
2441
|
+
|
|
2442
|
+
</dd>
|
|
2443
|
+
</dl>
|
|
1790
2444
|
|
|
1791
|
-
<details><summary><code>client.documents.<a href="/lib/CloudPDF/documents/client.rb">delete</a>(tenant_id:, id:) -> </code></summary>
|
|
1792
2445
|
<dl>
|
|
1793
2446
|
<dd>
|
|
1794
2447
|
|
|
1795
|
-
|
|
2448
|
+
**metadata:** `Internal::Types::Hash[String, Object]`
|
|
2449
|
+
|
|
2450
|
+
</dd>
|
|
2451
|
+
</dl>
|
|
1796
2452
|
|
|
1797
2453
|
<dl>
|
|
1798
2454
|
<dd>
|
|
1799
2455
|
|
|
2456
|
+
**idempotency_key:** `String`
|
|
2457
|
+
|
|
2458
|
+
</dd>
|
|
2459
|
+
</dl>
|
|
2460
|
+
|
|
1800
2461
|
<dl>
|
|
1801
2462
|
<dd>
|
|
1802
2463
|
|
|
1803
|
-
|
|
1804
|
-
|
|
1805
|
-
tenant_id: "tenantId",
|
|
1806
|
-
id: "id"
|
|
1807
|
-
)
|
|
1808
|
-
```
|
|
1809
|
-
</dd>
|
|
1810
|
-
</dl>
|
|
2464
|
+
**dedup_mode:** `CloudPDF::Documents::Types::DocumentsInitRequestDedupMode` — always-create (default) creates a new document every time. reuse-existing returns a document that already holds the same content instead of storing it twice.
|
|
2465
|
+
|
|
1811
2466
|
</dd>
|
|
1812
2467
|
</dl>
|
|
1813
2468
|
|
|
1814
|
-
#### ⚙️ Parameters
|
|
1815
|
-
|
|
1816
2469
|
<dl>
|
|
1817
2470
|
<dd>
|
|
1818
2471
|
|
|
2472
|
+
**doc_id:** `String`
|
|
2473
|
+
|
|
2474
|
+
</dd>
|
|
2475
|
+
</dl>
|
|
2476
|
+
|
|
1819
2477
|
<dl>
|
|
1820
2478
|
<dd>
|
|
1821
2479
|
|
|
1822
|
-
**
|
|
2480
|
+
**upload_ttl_sec:** `Integer`
|
|
1823
2481
|
|
|
1824
2482
|
</dd>
|
|
1825
2483
|
</dl>
|
|
@@ -1827,7 +2485,7 @@ client.documents.delete(
|
|
|
1827
2485
|
<dl>
|
|
1828
2486
|
<dd>
|
|
1829
2487
|
|
|
1830
|
-
**
|
|
2488
|
+
**upload_preference:** `CloudPDF::Documents::Types::DocumentsInitRequestUploadPreference`
|
|
1831
2489
|
|
|
1832
2490
|
</dd>
|
|
1833
2491
|
</dl>
|
|
@@ -1847,7 +2505,8 @@ client.documents.delete(
|
|
|
1847
2505
|
</dl>
|
|
1848
2506
|
</details>
|
|
1849
2507
|
|
|
1850
|
-
|
|
2508
|
+
## Folders
|
|
2509
|
+
<details><summary><code>client.folders.<a href="/lib/CloudPDF/folders/client.rb">list</a>(tenant_id:) -> CloudPDF::Types::FoldersList200Response</code></summary>
|
|
1851
2510
|
<dl>
|
|
1852
2511
|
<dd>
|
|
1853
2512
|
|
|
@@ -1860,11 +2519,7 @@ client.documents.delete(
|
|
|
1860
2519
|
<dd>
|
|
1861
2520
|
|
|
1862
2521
|
```ruby
|
|
1863
|
-
client.
|
|
1864
|
-
tenant_id: "tenantId",
|
|
1865
|
-
id: "id",
|
|
1866
|
-
sha256: "sha256"
|
|
1867
|
-
)
|
|
2522
|
+
client.folders.list(tenant_id: "tenantId")
|
|
1868
2523
|
```
|
|
1869
2524
|
</dd>
|
|
1870
2525
|
</dl>
|
|
@@ -1887,7 +2542,7 @@ client.documents.commit(
|
|
|
1887
2542
|
<dl>
|
|
1888
2543
|
<dd>
|
|
1889
2544
|
|
|
1890
|
-
**
|
|
2545
|
+
**limit:** `Integer`
|
|
1891
2546
|
|
|
1892
2547
|
</dd>
|
|
1893
2548
|
</dl>
|
|
@@ -1895,7 +2550,7 @@ client.documents.commit(
|
|
|
1895
2550
|
<dl>
|
|
1896
2551
|
<dd>
|
|
1897
2552
|
|
|
1898
|
-
**
|
|
2553
|
+
**cursor:** `String`
|
|
1899
2554
|
|
|
1900
2555
|
</dd>
|
|
1901
2556
|
</dl>
|
|
@@ -1903,7 +2558,15 @@ client.documents.commit(
|
|
|
1903
2558
|
<dl>
|
|
1904
2559
|
<dd>
|
|
1905
2560
|
|
|
1906
|
-
**
|
|
2561
|
+
**parent_id:** `String` — Only the folders directly in this folder (root: the top level). Without it, every folder.
|
|
2562
|
+
|
|
2563
|
+
</dd>
|
|
2564
|
+
</dl>
|
|
2565
|
+
|
|
2566
|
+
<dl>
|
|
2567
|
+
<dd>
|
|
2568
|
+
|
|
2569
|
+
**request_options:** `CloudPDF::Folders::RequestOptions`
|
|
1907
2570
|
|
|
1908
2571
|
</dd>
|
|
1909
2572
|
</dl>
|
|
@@ -1915,10 +2578,24 @@ client.documents.commit(
|
|
|
1915
2578
|
</dl>
|
|
1916
2579
|
</details>
|
|
1917
2580
|
|
|
1918
|
-
<details><summary><code>client.
|
|
2581
|
+
<details><summary><code>client.folders.<a href="/lib/CloudPDF/folders/client.rb">create</a>(tenant_id:, request) -> CloudPDF::Types::FoldersCreate200Response</code></summary>
|
|
2582
|
+
<dl>
|
|
2583
|
+
<dd>
|
|
2584
|
+
|
|
2585
|
+
#### 📝 Description
|
|
2586
|
+
|
|
1919
2587
|
<dl>
|
|
1920
2588
|
<dd>
|
|
1921
2589
|
|
|
2590
|
+
<dl>
|
|
2591
|
+
<dd>
|
|
2592
|
+
|
|
2593
|
+
409 Conflict carries `details.reason`: `name-taken` (a sibling has the name, ignoring case; `details.name`) or `too-deep` (folders nest at most 100 levels; `details.maxDepth`). 404 when the parent folder does not exist.
|
|
2594
|
+
</dd>
|
|
2595
|
+
</dl>
|
|
2596
|
+
</dd>
|
|
2597
|
+
</dl>
|
|
2598
|
+
|
|
1922
2599
|
#### 🔌 Usage
|
|
1923
2600
|
|
|
1924
2601
|
<dl>
|
|
@@ -1928,9 +2605,9 @@ client.documents.commit(
|
|
|
1928
2605
|
<dd>
|
|
1929
2606
|
|
|
1930
2607
|
```ruby
|
|
1931
|
-
client.
|
|
2608
|
+
client.folders.create(
|
|
1932
2609
|
tenant_id: "tenantId",
|
|
1933
|
-
|
|
2610
|
+
name: "name"
|
|
1934
2611
|
)
|
|
1935
2612
|
```
|
|
1936
2613
|
</dd>
|
|
@@ -1954,7 +2631,7 @@ client.documents.download(
|
|
|
1954
2631
|
<dl>
|
|
1955
2632
|
<dd>
|
|
1956
2633
|
|
|
1957
|
-
**
|
|
2634
|
+
**name:** `String` — What people call the folder: 1 to 255 characters, no control characters, no leading or trailing whitespace, and unique among the folder's siblings, ignoring case.
|
|
1958
2635
|
|
|
1959
2636
|
</dd>
|
|
1960
2637
|
</dl>
|
|
@@ -1962,7 +2639,15 @@ client.documents.download(
|
|
|
1962
2639
|
<dl>
|
|
1963
2640
|
<dd>
|
|
1964
2641
|
|
|
1965
|
-
**
|
|
2642
|
+
**parent_id:** `String` — A folder id, or root for the top level.
|
|
2643
|
+
|
|
2644
|
+
</dd>
|
|
2645
|
+
</dl>
|
|
2646
|
+
|
|
2647
|
+
<dl>
|
|
2648
|
+
<dd>
|
|
2649
|
+
|
|
2650
|
+
**request_options:** `CloudPDF::Folders::RequestOptions`
|
|
1966
2651
|
|
|
1967
2652
|
</dd>
|
|
1968
2653
|
</dl>
|
|
@@ -1974,7 +2659,7 @@ client.documents.download(
|
|
|
1974
2659
|
</dl>
|
|
1975
2660
|
</details>
|
|
1976
2661
|
|
|
1977
|
-
<details><summary><code>client.
|
|
2662
|
+
<details><summary><code>client.folders.<a href="/lib/CloudPDF/folders/client.rb">get</a>(tenant_id:, folder_id:) -> CloudPDF::Types::FoldersGet200Response</code></summary>
|
|
1978
2663
|
<dl>
|
|
1979
2664
|
<dd>
|
|
1980
2665
|
|
|
@@ -1987,9 +2672,9 @@ client.documents.download(
|
|
|
1987
2672
|
<dd>
|
|
1988
2673
|
|
|
1989
2674
|
```ruby
|
|
1990
|
-
client.
|
|
2675
|
+
client.folders.get(
|
|
1991
2676
|
tenant_id: "tenantId",
|
|
1992
|
-
|
|
2677
|
+
folder_id: "folderId"
|
|
1993
2678
|
)
|
|
1994
2679
|
```
|
|
1995
2680
|
</dd>
|
|
@@ -2013,7 +2698,7 @@ client.documents.thumbnail(
|
|
|
2013
2698
|
<dl>
|
|
2014
2699
|
<dd>
|
|
2015
2700
|
|
|
2016
|
-
**
|
|
2701
|
+
**folder_id:** `String`
|
|
2017
2702
|
|
|
2018
2703
|
</dd>
|
|
2019
2704
|
</dl>
|
|
@@ -2021,7 +2706,7 @@ client.documents.thumbnail(
|
|
|
2021
2706
|
<dl>
|
|
2022
2707
|
<dd>
|
|
2023
2708
|
|
|
2024
|
-
**request_options:** `CloudPDF::
|
|
2709
|
+
**request_options:** `CloudPDF::Folders::RequestOptions`
|
|
2025
2710
|
|
|
2026
2711
|
</dd>
|
|
2027
2712
|
</dl>
|
|
@@ -2033,7 +2718,7 @@ client.documents.thumbnail(
|
|
|
2033
2718
|
</dl>
|
|
2034
2719
|
</details>
|
|
2035
2720
|
|
|
2036
|
-
<details><summary><code>client.
|
|
2721
|
+
<details><summary><code>client.folders.<a href="/lib/CloudPDF/folders/client.rb">delete</a>(tenant_id:, folder_id:) -> </code></summary>
|
|
2037
2722
|
<dl>
|
|
2038
2723
|
<dd>
|
|
2039
2724
|
|
|
@@ -2045,7 +2730,7 @@ client.documents.thumbnail(
|
|
|
2045
2730
|
<dl>
|
|
2046
2731
|
<dd>
|
|
2047
2732
|
|
|
2048
|
-
|
|
2733
|
+
Without recursive, a folder with anything inside is refused: 409 Conflict with `details.reason` `not-empty` and what it holds, counted over every level below, in `details.folders` and `details.documents`. With recursive=true, the folder and every folder under it go at once, and every document in them stops opening, leaves every list and stops answering its share links at once; their stored files and links are removed in the background. Uploads into those folders that have not committed cannot commit.
|
|
2049
2734
|
</dd>
|
|
2050
2735
|
</dl>
|
|
2051
2736
|
</dd>
|
|
@@ -2060,13 +2745,10 @@ This bounded origin-mediated fallback must only be used after documents.init ret
|
|
|
2060
2745
|
<dd>
|
|
2061
2746
|
|
|
2062
2747
|
```ruby
|
|
2063
|
-
|
|
2064
|
-
|
|
2065
|
-
|
|
2066
|
-
|
|
2067
|
-
file: file
|
|
2068
|
-
)
|
|
2069
|
-
end
|
|
2748
|
+
client.folders.delete(
|
|
2749
|
+
tenant_id: "tenantId",
|
|
2750
|
+
folder_id: "folderId"
|
|
2751
|
+
)
|
|
2070
2752
|
```
|
|
2071
2753
|
</dd>
|
|
2072
2754
|
</dl>
|
|
@@ -2089,7 +2771,7 @@ end
|
|
|
2089
2771
|
<dl>
|
|
2090
2772
|
<dd>
|
|
2091
2773
|
|
|
2092
|
-
**
|
|
2774
|
+
**folder_id:** `String`
|
|
2093
2775
|
|
|
2094
2776
|
</dd>
|
|
2095
2777
|
</dl>
|
|
@@ -2097,7 +2779,15 @@ end
|
|
|
2097
2779
|
<dl>
|
|
2098
2780
|
<dd>
|
|
2099
2781
|
|
|
2100
|
-
**
|
|
2782
|
+
**recursive:** `Internal::Types::Boolean` — true deletes everything in the folder too. Never the default.
|
|
2783
|
+
|
|
2784
|
+
</dd>
|
|
2785
|
+
</dl>
|
|
2786
|
+
|
|
2787
|
+
<dl>
|
|
2788
|
+
<dd>
|
|
2789
|
+
|
|
2790
|
+
**request_options:** `CloudPDF::Folders::RequestOptions`
|
|
2101
2791
|
|
|
2102
2792
|
</dd>
|
|
2103
2793
|
</dl>
|
|
@@ -2109,7 +2799,7 @@ end
|
|
|
2109
2799
|
</dl>
|
|
2110
2800
|
</details>
|
|
2111
2801
|
|
|
2112
|
-
<details><summary><code>client.
|
|
2802
|
+
<details><summary><code>client.folders.<a href="/lib/CloudPDF/folders/client.rb">update</a>(tenant_id:, folder_id:, request) -> CloudPDF::Types::FoldersUpdate200Response</code></summary>
|
|
2113
2803
|
<dl>
|
|
2114
2804
|
<dd>
|
|
2115
2805
|
|
|
@@ -2121,7 +2811,7 @@ end
|
|
|
2121
2811
|
<dl>
|
|
2122
2812
|
<dd>
|
|
2123
2813
|
|
|
2124
|
-
|
|
2814
|
+
409 Conflict with `details.reason` `name-taken` when a sibling has the name, ignoring case.
|
|
2125
2815
|
</dd>
|
|
2126
2816
|
</dl>
|
|
2127
2817
|
</dd>
|
|
@@ -2136,7 +2826,11 @@ Default mode is synchronous and bounded: the response returns only after the tra
|
|
|
2136
2826
|
<dd>
|
|
2137
2827
|
|
|
2138
2828
|
```ruby
|
|
2139
|
-
client.
|
|
2829
|
+
client.folders.update(
|
|
2830
|
+
tenant_id: "tenantId",
|
|
2831
|
+
folder_id: "folderId",
|
|
2832
|
+
name: "name"
|
|
2833
|
+
)
|
|
2140
2834
|
```
|
|
2141
2835
|
</dd>
|
|
2142
2836
|
</dl>
|
|
@@ -2159,7 +2853,7 @@ client.documents.import_from(tenant_id: "tenantId")
|
|
|
2159
2853
|
<dl>
|
|
2160
2854
|
<dd>
|
|
2161
2855
|
|
|
2162
|
-
**
|
|
2856
|
+
**folder_id:** `String`
|
|
2163
2857
|
|
|
2164
2858
|
</dd>
|
|
2165
2859
|
</dl>
|
|
@@ -2167,7 +2861,7 @@ client.documents.import_from(tenant_id: "tenantId")
|
|
|
2167
2861
|
<dl>
|
|
2168
2862
|
<dd>
|
|
2169
2863
|
|
|
2170
|
-
**
|
|
2864
|
+
**name:** `String` — What people call the folder: 1 to 255 characters, no control characters, no leading or trailing whitespace, and unique among the folder's siblings, ignoring case.
|
|
2171
2865
|
|
|
2172
2866
|
</dd>
|
|
2173
2867
|
</dl>
|
|
@@ -2175,61 +2869,35 @@ client.documents.import_from(tenant_id: "tenantId")
|
|
|
2175
2869
|
<dl>
|
|
2176
2870
|
<dd>
|
|
2177
2871
|
|
|
2178
|
-
**
|
|
2872
|
+
**request_options:** `CloudPDF::Folders::RequestOptions`
|
|
2179
2873
|
|
|
2180
2874
|
</dd>
|
|
2181
2875
|
</dl>
|
|
2182
|
-
|
|
2183
|
-
<dl>
|
|
2184
|
-
<dd>
|
|
2185
|
-
|
|
2186
|
-
**idempotency_key:** `String` — Retrying with the same key resumes the same document rather than importing a second copy — including after a 502.
|
|
2187
|
-
|
|
2188
2876
|
</dd>
|
|
2189
2877
|
</dl>
|
|
2190
2878
|
|
|
2191
|
-
<dl>
|
|
2192
|
-
<dd>
|
|
2193
2879
|
|
|
2194
|
-
**dedup_mode:** `CloudPDF::Documents::Types::DocumentsImportFromRequestDedupMode` — always-create (default) creates a new document every time. reuse-existing returns a document that already holds the same content instead of storing it twice.
|
|
2195
|
-
|
|
2196
2880
|
</dd>
|
|
2197
2881
|
</dl>
|
|
2882
|
+
</details>
|
|
2198
2883
|
|
|
2884
|
+
<details><summary><code>client.folders.<a href="/lib/CloudPDF/folders/client.rb">move_into</a>(tenant_id:, folder_id:, request) -> </code></summary>
|
|
2199
2885
|
<dl>
|
|
2200
2886
|
<dd>
|
|
2201
2887
|
|
|
2202
|
-
|
|
2203
|
-
|
|
2204
|
-
</dd>
|
|
2205
|
-
</dl>
|
|
2888
|
+
#### 📝 Description
|
|
2206
2889
|
|
|
2207
2890
|
<dl>
|
|
2208
2891
|
<dd>
|
|
2209
2892
|
|
|
2210
|
-
**mode:** `CloudPDF::Documents::Types::DocumentsImportFromRequestMode` — sync (default) holds the response open for the whole transfer. async answers 202 with the document pending and transfers in the background; it requires a connection source, and filesystem connections additionally require expected.sha256.
|
|
2211
|
-
|
|
2212
|
-
</dd>
|
|
2213
|
-
</dl>
|
|
2214
|
-
|
|
2215
2893
|
<dl>
|
|
2216
2894
|
<dd>
|
|
2217
2895
|
|
|
2218
|
-
|
|
2219
|
-
|
|
2220
|
-
</dd>
|
|
2221
|
-
</dl>
|
|
2896
|
+
Up to 1,000 ids in total. A folder moves with everything in it. 404 NotFound names the ids that do not exist or are being deleted in `details.documentIds` and `details.folderIds`. 409 Conflict carries `details.reason`: `cycle` (the destination is a moved folder or inside one; `details.folderId`), `too-deep` (the move would nest folders deeper than 100 levels; `details.maxDepth`) or `name-taken` (a moved folder's name is taken in the destination, ignoring case; `details.name`).
|
|
2222
2897
|
</dd>
|
|
2223
2898
|
</dl>
|
|
2224
|
-
|
|
2225
|
-
|
|
2226
2899
|
</dd>
|
|
2227
2900
|
</dl>
|
|
2228
|
-
</details>
|
|
2229
|
-
|
|
2230
|
-
<details><summary><code>client.documents.<a href="/lib/CloudPDF/documents/client.rb">init</a>(tenant_id:, request) -> CloudPDF::Types::DocumentsInit200Response</code></summary>
|
|
2231
|
-
<dl>
|
|
2232
|
-
<dd>
|
|
2233
2901
|
|
|
2234
2902
|
#### 🔌 Usage
|
|
2235
2903
|
|
|
@@ -2240,10 +2908,9 @@ client.documents.import_from(tenant_id: "tenantId")
|
|
|
2240
2908
|
<dd>
|
|
2241
2909
|
|
|
2242
2910
|
```ruby
|
|
2243
|
-
client.
|
|
2911
|
+
client.folders.move_into(
|
|
2244
2912
|
tenant_id: "tenantId",
|
|
2245
|
-
|
|
2246
|
-
content_sha256: "contentSha256"
|
|
2913
|
+
folder_id: "folderId"
|
|
2247
2914
|
)
|
|
2248
2915
|
```
|
|
2249
2916
|
</dd>
|
|
@@ -2267,47 +2934,7 @@ client.documents.init(
|
|
|
2267
2934
|
<dl>
|
|
2268
2935
|
<dd>
|
|
2269
2936
|
|
|
2270
|
-
**
|
|
2271
|
-
|
|
2272
|
-
</dd>
|
|
2273
|
-
</dl>
|
|
2274
|
-
|
|
2275
|
-
<dl>
|
|
2276
|
-
<dd>
|
|
2277
|
-
|
|
2278
|
-
**content_sha256:** `String`
|
|
2279
|
-
|
|
2280
|
-
</dd>
|
|
2281
|
-
</dl>
|
|
2282
|
-
|
|
2283
|
-
<dl>
|
|
2284
|
-
<dd>
|
|
2285
|
-
|
|
2286
|
-
**metadata:** `Internal::Types::Hash[String, Object]`
|
|
2287
|
-
|
|
2288
|
-
</dd>
|
|
2289
|
-
</dl>
|
|
2290
|
-
|
|
2291
|
-
<dl>
|
|
2292
|
-
<dd>
|
|
2293
|
-
|
|
2294
|
-
**idempotency_key:** `String`
|
|
2295
|
-
|
|
2296
|
-
</dd>
|
|
2297
|
-
</dl>
|
|
2298
|
-
|
|
2299
|
-
<dl>
|
|
2300
|
-
<dd>
|
|
2301
|
-
|
|
2302
|
-
**dedup_mode:** `CloudPDF::Documents::Types::DocumentsInitRequestDedupMode` — always-create (default) creates a new document every time. reuse-existing returns a document that already holds the same content instead of storing it twice.
|
|
2303
|
-
|
|
2304
|
-
</dd>
|
|
2305
|
-
</dl>
|
|
2306
|
-
|
|
2307
|
-
<dl>
|
|
2308
|
-
<dd>
|
|
2309
|
-
|
|
2310
|
-
**doc_id:** `String`
|
|
2937
|
+
**folder_id:** `String` — A folder id, or root for the top level.
|
|
2311
2938
|
|
|
2312
2939
|
</dd>
|
|
2313
2940
|
</dl>
|
|
@@ -2315,7 +2942,7 @@ client.documents.init(
|
|
|
2315
2942
|
<dl>
|
|
2316
2943
|
<dd>
|
|
2317
2944
|
|
|
2318
|
-
**
|
|
2945
|
+
**document_ids:** `Internal::Types::Array[String]`
|
|
2319
2946
|
|
|
2320
2947
|
</dd>
|
|
2321
2948
|
</dl>
|
|
@@ -2323,7 +2950,7 @@ client.documents.init(
|
|
|
2323
2950
|
<dl>
|
|
2324
2951
|
<dd>
|
|
2325
2952
|
|
|
2326
|
-
**
|
|
2953
|
+
**folder_ids:** `Internal::Types::Array[String]`
|
|
2327
2954
|
|
|
2328
2955
|
</dd>
|
|
2329
2956
|
</dl>
|
|
@@ -2331,7 +2958,7 @@ client.documents.init(
|
|
|
2331
2958
|
<dl>
|
|
2332
2959
|
<dd>
|
|
2333
2960
|
|
|
2334
|
-
**request_options:** `CloudPDF::
|
|
2961
|
+
**request_options:** `CloudPDF::Folders::RequestOptions`
|
|
2335
2962
|
|
|
2336
2963
|
</dd>
|
|
2337
2964
|
</dl>
|
|
@@ -5164,7 +5791,7 @@ client.doc.signatures.cancel(
|
|
|
5164
5791
|
<dl>
|
|
5165
5792
|
<dd>
|
|
5166
5793
|
|
|
5167
|
-
`cms` is the detached CMS over the prepared digest, base64. `expectedVersion` must be what prepare returned. Idempotent by signing id: the same CMS again answers `already-completed`.
|
|
5794
|
+
`cms` is the detached CMS over the prepared digest, base64. `expectedVersion` must be what prepare returned. Idempotent by signing id: the same CMS again answers `already-completed`. The new version is the layer's own: only this layer moves to it, and the document and every other layer stay as they were. Refetch the manifest after a completion.
|
|
5168
5795
|
</dd>
|
|
5169
5796
|
</dl>
|
|
5170
5797
|
</dd>
|
|
@@ -5380,7 +6007,7 @@ client.doc.signatures.analysis(
|
|
|
5380
6007
|
<dl>
|
|
5381
6008
|
<dd>
|
|
5382
6009
|
|
|
5383
|
-
Multipart: a JSON `body` part (field, subFilter, digest, contentsSize, signer, certify, lock), naming the appearance PDF it may carry as `resources: { appearance: '<key>' }`, and that PDF as the part `resource:<key>`. A certification (`certify.permission`) additionally requires `doc.sign.certify`. The layer is read-only until the signing completes, is cancelled, or expires (15 minutes).
|
|
6010
|
+
Multipart: a JSON `body` part (field, subFilter, digest, contentsSize, signer, certify, lock), naming the appearance PDF it may carry as `resources: { appearance: '<key>' }`, and that PDF as the part `resource:<key>`. A certification (`certify.permission`) additionally requires `doc.sign.certify`. The layer is read-only until the signing completes, is cancelled, or expires (15 minutes). The signature is made over the layer's own base: the upload, or the version its last signature made.
|
|
5384
6011
|
</dd>
|
|
5385
6012
|
</dl>
|
|
5386
6013
|
</dd>
|
|
@@ -5450,7 +6077,7 @@ client.doc.signatures.prepare(
|
|
|
5450
6077
|
</details>
|
|
5451
6078
|
|
|
5452
6079
|
## Doc Versions
|
|
5453
|
-
<details><summary><code>client.doc.versions.<a href="/lib/CloudPDF/doc/versions/client.rb">list</a>(doc_id:) -> CloudPDF::Types::DocVersionsList200Response</code></summary>
|
|
6080
|
+
<details><summary><code>client.doc.versions.<a href="/lib/CloudPDF/doc/versions/client.rb">list</a>(doc_id:, layer_name:) -> CloudPDF::Types::DocVersionsList200Response</code></summary>
|
|
5454
6081
|
<dl>
|
|
5455
6082
|
<dd>
|
|
5456
6083
|
|
|
@@ -5462,7 +6089,7 @@ client.doc.signatures.prepare(
|
|
|
5462
6089
|
<dl>
|
|
5463
6090
|
<dd>
|
|
5464
6091
|
|
|
5465
|
-
Every completed signature
|
|
6092
|
+
Every completed signature makes a new version of its layer; another layer's versions are never listed. Never cached: the list grows.
|
|
5466
6093
|
</dd>
|
|
5467
6094
|
</dl>
|
|
5468
6095
|
</dd>
|
|
@@ -5477,7 +6104,10 @@ Every completed signature publishes a new version. Never cached: the list grows.
|
|
|
5477
6104
|
<dd>
|
|
5478
6105
|
|
|
5479
6106
|
```ruby
|
|
5480
|
-
client.doc.versions.list(
|
|
6107
|
+
client.doc.versions.list(
|
|
6108
|
+
doc_id: "docId",
|
|
6109
|
+
layer_name: "layerName"
|
|
6110
|
+
)
|
|
5481
6111
|
```
|
|
5482
6112
|
</dd>
|
|
5483
6113
|
</dl>
|
|
@@ -5500,6 +6130,14 @@ client.doc.versions.list(doc_id: "docId")
|
|
|
5500
6130
|
<dl>
|
|
5501
6131
|
<dd>
|
|
5502
6132
|
|
|
6133
|
+
**layer_name:** `String`
|
|
6134
|
+
|
|
6135
|
+
</dd>
|
|
6136
|
+
</dl>
|
|
6137
|
+
|
|
6138
|
+
<dl>
|
|
6139
|
+
<dd>
|
|
6140
|
+
|
|
5503
6141
|
**document_password:** `String` — 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.
|
|
5504
6142
|
|
|
5505
6143
|
</dd>
|
|
@@ -5520,7 +6158,7 @@ client.doc.versions.list(doc_id: "docId")
|
|
|
5520
6158
|
</dl>
|
|
5521
6159
|
</details>
|
|
5522
6160
|
|
|
5523
|
-
<details><summary><code>client.doc.versions.<a href="/lib/CloudPDF/doc/versions/client.rb">analysis</a>(doc_id:, sha:) -> CloudPDF::Types::DocVersionsAnalysis200Response</code></summary>
|
|
6161
|
+
<details><summary><code>client.doc.versions.<a href="/lib/CloudPDF/doc/versions/client.rb">analysis</a>(doc_id:, layer_name:, sha:) -> CloudPDF::Types::DocVersionsAnalysis200Response</code></summary>
|
|
5524
6162
|
<dl>
|
|
5525
6163
|
<dd>
|
|
5526
6164
|
|
|
@@ -5532,7 +6170,7 @@ client.doc.versions.list(doc_id: "docId")
|
|
|
5532
6170
|
<dl>
|
|
5533
6171
|
<dd>
|
|
5534
6172
|
|
|
5535
|
-
Exactly one of `since.signature` / `since.revision`; `until=<revision>` defaults to the last. The same answer for every
|
|
6173
|
+
Exactly one of `since.signature` / `since.revision`; `until=<revision>` defaults to the last. The same answer for every caller.
|
|
5536
6174
|
</dd>
|
|
5537
6175
|
</dl>
|
|
5538
6176
|
</dd>
|
|
@@ -5549,6 +6187,7 @@ Exactly one of `since.signature` / `since.revision`; `until=<revision>` defaults
|
|
|
5549
6187
|
```ruby
|
|
5550
6188
|
client.doc.versions.analysis(
|
|
5551
6189
|
doc_id: "docId",
|
|
6190
|
+
layer_name: "layerName",
|
|
5552
6191
|
sha: "sha"
|
|
5553
6192
|
)
|
|
5554
6193
|
```
|
|
@@ -5573,6 +6212,14 @@ client.doc.versions.analysis(
|
|
|
5573
6212
|
<dl>
|
|
5574
6213
|
<dd>
|
|
5575
6214
|
|
|
6215
|
+
**layer_name:** `String`
|
|
6216
|
+
|
|
6217
|
+
</dd>
|
|
6218
|
+
</dl>
|
|
6219
|
+
|
|
6220
|
+
<dl>
|
|
6221
|
+
<dd>
|
|
6222
|
+
|
|
5576
6223
|
**sha:** `String`
|
|
5577
6224
|
|
|
5578
6225
|
</dd>
|
|
@@ -5641,7 +6288,7 @@ client.doc.versions.analysis(
|
|
|
5641
6288
|
</dl>
|
|
5642
6289
|
</details>
|
|
5643
6290
|
|
|
5644
|
-
<details><summary><code>client.doc.versions.<a href="/lib/CloudPDF/doc/versions/client.rb">download</a>(doc_id:, sha:) -> String</code></summary>
|
|
6291
|
+
<details><summary><code>client.doc.versions.<a href="/lib/CloudPDF/doc/versions/client.rb">download</a>(doc_id:, layer_name:, sha:) -> String</code></summary>
|
|
5645
6292
|
<dl>
|
|
5646
6293
|
<dd>
|
|
5647
6294
|
|
|
@@ -5656,6 +6303,7 @@ client.doc.versions.analysis(
|
|
|
5656
6303
|
```ruby
|
|
5657
6304
|
client.doc.versions.download(
|
|
5658
6305
|
doc_id: "docId",
|
|
6306
|
+
layer_name: "layerName",
|
|
5659
6307
|
sha: "sha"
|
|
5660
6308
|
)
|
|
5661
6309
|
```
|
|
@@ -5680,6 +6328,14 @@ client.doc.versions.download(
|
|
|
5680
6328
|
<dl>
|
|
5681
6329
|
<dd>
|
|
5682
6330
|
|
|
6331
|
+
**layer_name:** `String`
|
|
6332
|
+
|
|
6333
|
+
</dd>
|
|
6334
|
+
</dl>
|
|
6335
|
+
|
|
6336
|
+
<dl>
|
|
6337
|
+
<dd>
|
|
6338
|
+
|
|
5683
6339
|
**sha:** `String`
|
|
5684
6340
|
|
|
5685
6341
|
</dd>
|
|
@@ -5708,7 +6364,7 @@ client.doc.versions.download(
|
|
|
5708
6364
|
</dl>
|
|
5709
6365
|
</details>
|
|
5710
6366
|
|
|
5711
|
-
<details><summary><code>client.doc.versions.<a href="/lib/CloudPDF/doc/versions/client.rb">revision</a>(doc_id:, sha:, index:) -> String</code></summary>
|
|
6367
|
+
<details><summary><code>client.doc.versions.<a href="/lib/CloudPDF/doc/versions/client.rb">revision</a>(doc_id:, layer_name:, sha:, index:) -> String</code></summary>
|
|
5712
6368
|
<dl>
|
|
5713
6369
|
<dd>
|
|
5714
6370
|
|
|
@@ -5723,6 +6379,7 @@ client.doc.versions.download(
|
|
|
5723
6379
|
```ruby
|
|
5724
6380
|
client.doc.versions.revision(
|
|
5725
6381
|
doc_id: "docId",
|
|
6382
|
+
layer_name: "layerName",
|
|
5726
6383
|
sha: "sha",
|
|
5727
6384
|
index: 1
|
|
5728
6385
|
)
|
|
@@ -5748,6 +6405,14 @@ client.doc.versions.revision(
|
|
|
5748
6405
|
<dl>
|
|
5749
6406
|
<dd>
|
|
5750
6407
|
|
|
6408
|
+
**layer_name:** `String`
|
|
6409
|
+
|
|
6410
|
+
</dd>
|
|
6411
|
+
</dl>
|
|
6412
|
+
|
|
6413
|
+
<dl>
|
|
6414
|
+
<dd>
|
|
6415
|
+
|
|
5751
6416
|
**sha:** `String`
|
|
5752
6417
|
|
|
5753
6418
|
</dd>
|
|
@@ -5784,7 +6449,7 @@ client.doc.versions.revision(
|
|
|
5784
6449
|
</dl>
|
|
5785
6450
|
</details>
|
|
5786
6451
|
|
|
5787
|
-
<details><summary><code>client.doc.versions.<a href="/lib/CloudPDF/doc/versions/client.rb">signatures</a>(doc_id:, sha:) -> CloudPDF::Types::DocVersionsSignatures200Response</code></summary>
|
|
6452
|
+
<details><summary><code>client.doc.versions.<a href="/lib/CloudPDF/doc/versions/client.rb">signatures</a>(doc_id:, layer_name:, sha:) -> CloudPDF::Types::DocVersionsSignatures200Response</code></summary>
|
|
5788
6453
|
<dl>
|
|
5789
6454
|
<dd>
|
|
5790
6455
|
|
|
@@ -5799,6 +6464,7 @@ client.doc.versions.revision(
|
|
|
5799
6464
|
```ruby
|
|
5800
6465
|
client.doc.versions.signatures(
|
|
5801
6466
|
doc_id: "docId",
|
|
6467
|
+
layer_name: "layerName",
|
|
5802
6468
|
sha: "sha"
|
|
5803
6469
|
)
|
|
5804
6470
|
```
|
|
@@ -5823,6 +6489,14 @@ client.doc.versions.signatures(
|
|
|
5823
6489
|
<dl>
|
|
5824
6490
|
<dd>
|
|
5825
6491
|
|
|
6492
|
+
**layer_name:** `String`
|
|
6493
|
+
|
|
6494
|
+
</dd>
|
|
6495
|
+
</dl>
|
|
6496
|
+
|
|
6497
|
+
<dl>
|
|
6498
|
+
<dd>
|
|
6499
|
+
|
|
5826
6500
|
**sha:** `String`
|
|
5827
6501
|
|
|
5828
6502
|
</dd>
|
|
@@ -5851,7 +6525,7 @@ client.doc.versions.signatures(
|
|
|
5851
6525
|
</dl>
|
|
5852
6526
|
</details>
|
|
5853
6527
|
|
|
5854
|
-
<details><summary><code>client.doc.versions.<a href="/lib/CloudPDF/doc/versions/client.rb">signature_contents</a>(doc_id:, sha:, field_key:) -> String</code></summary>
|
|
6528
|
+
<details><summary><code>client.doc.versions.<a href="/lib/CloudPDF/doc/versions/client.rb">signature_contents</a>(doc_id:, layer_name:, sha:, field_key:) -> String</code></summary>
|
|
5855
6529
|
<dl>
|
|
5856
6530
|
<dd>
|
|
5857
6531
|
|
|
@@ -5880,6 +6554,7 @@ client.doc.versions.signatures(
|
|
|
5880
6554
|
```ruby
|
|
5881
6555
|
client.doc.versions.signature_contents(
|
|
5882
6556
|
doc_id: "docId",
|
|
6557
|
+
layer_name: "layerName",
|
|
5883
6558
|
sha: "sha",
|
|
5884
6559
|
field_key: "fieldKey"
|
|
5885
6560
|
)
|
|
@@ -5905,6 +6580,14 @@ client.doc.versions.signature_contents(
|
|
|
5905
6580
|
<dl>
|
|
5906
6581
|
<dd>
|
|
5907
6582
|
|
|
6583
|
+
**layer_name:** `String`
|
|
6584
|
+
|
|
6585
|
+
</dd>
|
|
6586
|
+
</dl>
|
|
6587
|
+
|
|
6588
|
+
<dl>
|
|
6589
|
+
<dd>
|
|
6590
|
+
|
|
5908
6591
|
**sha:** `String`
|
|
5909
6592
|
|
|
5910
6593
|
</dd>
|
|
@@ -5941,7 +6624,7 @@ client.doc.versions.signature_contents(
|
|
|
5941
6624
|
</dl>
|
|
5942
6625
|
</details>
|
|
5943
6626
|
|
|
5944
|
-
<details><summary><code>client.doc.versions.<a href="/lib/CloudPDF/doc/versions/client.rb">signature_digest</a>(doc_id:, sha:, field_key:, algorithm:) -> String</code></summary>
|
|
6627
|
+
<details><summary><code>client.doc.versions.<a href="/lib/CloudPDF/doc/versions/client.rb">signature_digest</a>(doc_id:, layer_name:, sha:, field_key:, algorithm:) -> String</code></summary>
|
|
5945
6628
|
<dl>
|
|
5946
6629
|
<dd>
|
|
5947
6630
|
|
|
@@ -5970,6 +6653,7 @@ What a CMS verifier compares its message digest to.
|
|
|
5970
6653
|
```ruby
|
|
5971
6654
|
client.doc.versions.signature_digest(
|
|
5972
6655
|
doc_id: "docId",
|
|
6656
|
+
layer_name: "layerName",
|
|
5973
6657
|
sha: "sha",
|
|
5974
6658
|
field_key: "fieldKey",
|
|
5975
6659
|
algorithm: "sha1"
|
|
@@ -5996,6 +6680,14 @@ client.doc.versions.signature_digest(
|
|
|
5996
6680
|
<dl>
|
|
5997
6681
|
<dd>
|
|
5998
6682
|
|
|
6683
|
+
**layer_name:** `String`
|
|
6684
|
+
|
|
6685
|
+
</dd>
|
|
6686
|
+
</dl>
|
|
6687
|
+
|
|
6688
|
+
<dl>
|
|
6689
|
+
<dd>
|
|
6690
|
+
|
|
5999
6691
|
**sha:** `String`
|
|
6000
6692
|
|
|
6001
6693
|
</dd>
|