Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
4 changes: 2 additions & 2 deletions .fern/metadata.json
Original file line number Diff line number Diff line change
Expand Up @@ -7,9 +7,9 @@
"client_class_name": "CloudPDFClient",
"environment_class_name": "CloudPDFEnvironment"
},
"originGitCommit": "e5cd0731cb3a1f2ed5821f8d60191bd58934c3dd",
"originGitCommit": "31a712963c171ce9ebd6815e873c9895e389afc2",
"originGitCommitIsDirty": false,
"invokedBy": "ci",
"requestedVersion": "3.0.0a9",
"requestedVersion": "3.0.0a10",
"ciProvider": "github"
}
8 changes: 4 additions & 4 deletions cloudpdf-generation.json
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
{
"language": "python",
"canonicalVersion": "3.0.0-next.9",
"sdkVersion": "3.0.0a9",
"canonicalVersion": "3.0.0-next.10",
"sdkVersion": "3.0.0a10",
"source": {
"repository": "embedpdf/embed-pdf-viewer",
"openapi": "cloudpdf/contract/openapi.json",
"openapiSha256": "4ee27900dbb0b13408ce00a0e80d606444ab81e9d5a76186fa984c8c8dfe09fe",
"gitCommit": "e5cd0731cb3a1f2ed5821f8d60191bd58934c3dd",
"openapiSha256": "9d6c7cdd459982ba9e718a3842c969003b466e3fd73883fef7783dc78e12cdfe",
"gitCommit": "31a712963c171ce9ebd6815e873c9895e389afc2",
"gitCommitIsDirty": false
},
"fern": {
Expand Down
2 changes: 1 addition & 1 deletion pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ dynamic = ["version"]

[tool.poetry]
name = "cloudpdf"
version = "3.0.0a9"
version = "3.0.0a10"
description = "The official Python SDK for the CloudPDF API."
readme = "README.md"
authors = ["CloudPDF <hello@cloudpdf.com>"]
Expand Down
89 changes: 89 additions & 0 deletions reference.md
Original file line number Diff line number Diff line change
Expand Up @@ -2430,6 +2430,95 @@ client.tokens.revoke(
</details>

## Doc Annotations
<details><summary><code>client.doc.annotations.<a href="src/cloudpdf/doc/annotations/client.py">list_all</a>(...) -> DocAnnotationsListAll200Response</code></summary>
<dl>
<dd>

#### 📝 Description

<dl>
<dd>

<dl>
<dd>

Returns one entry per page plus the audit-log cursor for reconciling subsequent document events. Page order is unspecified; join by `pageState.pageObjectNumber` when display order matters.
</dd>
</dl>
</dd>
</dl>

#### 🔌 Usage

<dl>
<dd>

<dl>
<dd>

```python
from cloudpdf import CloudPDFClient

client = CloudPDFClient(
token="<token>",
base_url="https://yourhost.com/path/to/api",
)

client.doc.annotations.list_all(
doc_id="docId",
layer_name="layerName",
)

```
</dd>
</dl>
</dd>
</dl>

#### ⚙️ Parameters

<dl>
<dd>

<dl>
<dd>

**doc_id:** `str`

</dd>
</dl>

<dl>
<dd>

**layer_name:** `str`

</dd>
</dl>

<dl>
<dd>

**document_password:** `typing.Optional[str]` — 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.

</dd>
</dl>

<dl>
<dd>

**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.

</dd>
</dl>
</dd>
</dl>


</dd>
</dl>
</details>

<details><summary><code>client.doc.annotations.<a href="src/cloudpdf/doc/annotations/client.py">list</a>(...) -> DocAnnotationsList200Response</code></summary>
<dl>
<dd>
Expand Down
4,308 changes: 4,308 additions & 0 deletions src/cloudpdf/__init__.py

Large diffs are not rendered by default.

4 changes: 2 additions & 2 deletions src/cloudpdf/core/client_wrapper.py
Original file line number Diff line number Diff line change
Expand Up @@ -33,12 +33,12 @@ def get_headers(self) -> typing.Dict[str, str]:
import platform

headers: typing.Dict[str, str] = {
"User-Agent": "cloudpdf/3.0.0a9",
"User-Agent": "cloudpdf/3.0.0a10",
"X-Fern-Language": "Python",
"X-Fern-Runtime": f"python/{platform.python_version()}",
"X-Fern-Platform": f"{platform.system().lower()}/{platform.release()}",
"X-Fern-SDK-Name": "cloudpdf",
"X-Fern-SDK-Version": "3.0.0a9",
"X-Fern-SDK-Version": "3.0.0a10",
**(self.get_custom_headers() or {}),
}
token = self._get_token()
Expand Down
101 changes: 101 additions & 0 deletions src/cloudpdf/doc/annotations/client.py
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@
from ...types.doc_annotations_create_request import DocAnnotationsCreateRequest
from ...types.doc_annotations_delete200response import DocAnnotationsDelete200Response
from ...types.doc_annotations_list200response import DocAnnotationsList200Response
from ...types.doc_annotations_list_all200response import DocAnnotationsListAll200Response
from ...types.doc_annotations_update200response import DocAnnotationsUpdate200Response
from ...types.doc_annotations_update_request import DocAnnotationsUpdateRequest
from .raw_client import AsyncRawAnnotationsClient, RawAnnotationsClient
Expand All @@ -31,6 +32,52 @@ def with_raw_response(self) -> RawAnnotationsClient:
"""
return self._raw_client

def list_all(
self,
doc_id: str,
layer_name: str,
*,
document_password: typing.Optional[str] = None,
request_options: typing.Optional[RequestOptions] = None,
) -> DocAnnotationsListAll200Response:
"""
Returns one entry per page plus the audit-log cursor for reconciling subsequent document events. Page order is unspecified; join by `pageState.pageObjectNumber` when display order matters.

Parameters
----------
doc_id : str

layer_name : str

document_password : typing.Optional[str]
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.

request_options : typing.Optional[RequestOptions]
Request-specific configuration.

Returns
-------
DocAnnotationsListAll200Response
OK

Examples
--------
from cloudpdf import CloudPDFClient

client = CloudPDFClient(
token="YOUR_TOKEN",
base_url="https://yourhost.com/path/to/api",
)
client.doc.annotations.list_all(
doc_id="docId",
layer_name="layerName",
)
"""
_response = self._raw_client.list_all(
doc_id, layer_name, document_password=document_password, request_options=request_options
)
return _response.data

def list(
self,
doc_id: str,
Expand Down Expand Up @@ -268,6 +315,60 @@ def with_raw_response(self) -> AsyncRawAnnotationsClient:
"""
return self._raw_client

async def list_all(
self,
doc_id: str,
layer_name: str,
*,
document_password: typing.Optional[str] = None,
request_options: typing.Optional[RequestOptions] = None,
) -> DocAnnotationsListAll200Response:
"""
Returns one entry per page plus the audit-log cursor for reconciling subsequent document events. Page order is unspecified; join by `pageState.pageObjectNumber` when display order matters.

Parameters
----------
doc_id : str

layer_name : str

document_password : typing.Optional[str]
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.

request_options : typing.Optional[RequestOptions]
Request-specific configuration.

Returns
-------
DocAnnotationsListAll200Response
OK

Examples
--------
import asyncio

from cloudpdf import AsyncCloudPDFClient

client = AsyncCloudPDFClient(
token="YOUR_TOKEN",
base_url="https://yourhost.com/path/to/api",
)


async def main() -> None:
await client.doc.annotations.list_all(
doc_id="docId",
layer_name="layerName",
)


asyncio.run(main())
"""
_response = await self._raw_client.list_all(
doc_id, layer_name, document_password=document_password, request_options=request_options
)
return _response.data

async def list(
self,
doc_id: str,
Expand Down
Loading
Loading