diff --git a/.fern/metadata.json b/.fern/metadata.json index 90da5f9..5410961 100644 --- a/.fern/metadata.json +++ b/.fern/metadata.json @@ -3,9 +3,11 @@ "generatorName": "fernapi/fern-python-sdk", "generatorVersion": "5.26.0", "generatorConfig": { - "package_name": "cloudpdf" + "package_name": "cloudpdf", + "client_class_name": "CloudPDFClient", + "environment_class_name": "CloudPDFEnvironment" }, - "originGitCommit": "232d5e0240d5673a73c9ea7c7ae9e7b937fdd5b3", + "originGitCommit": "a0adb9e77ef16feaef2358d71b247b4f5a98fd23", "originGitCommitIsDirty": false, "invokedBy": "ci", "requestedVersion": "3.0.0a1", diff --git a/.github/workflows/sdk-ci.yml b/.github/workflows/sdk-ci.yml index 65cee60..c2005f6 100644 --- a/.github/workflows/sdk-ci.yml +++ b/.github/workflows/sdk-ci.yml @@ -18,4 +18,4 @@ jobs: with: python-version: '3.12' - run: python -m pip install --disable-pip-version-check build - - run: python -m build --wheel + - run: python -m build diff --git a/.github/workflows/sdk-release.yml b/.github/workflows/sdk-release.yml new file mode 100644 index 0000000..30d3315 --- /dev/null +++ b/.github/workflows/sdk-release.yml @@ -0,0 +1,132 @@ +name: SDK Release + +on: + push: + branches: [main] + paths-ignore: + - '.github/**' + workflow_dispatch: + +permissions: + contents: read + +concurrency: + group: sdk-release + cancel-in-progress: false + +jobs: + release: + name: Publish cloudpdf + if: github.event_name == 'workflow_dispatch' || vars.SDK_AUTO_PUBLISH_ENABLED == 'true' + runs-on: ubuntu-latest + environment: release + permissions: + contents: write + id-token: write + steps: + - uses: actions/checkout@v4 + with: + fetch-depth: 0 + + - uses: actions/setup-python@v5 + with: + python-version: '3.12' + + - name: Verify generated release version + id: version + run: | + python - <<'PY' + import json + import os + import tomllib + + with open('pyproject.toml', 'rb') as file: + manifest = tomllib.load(file) + with open('cloudpdf-generation.json', encoding='utf-8') as file: + generation = json.load(file) + name = manifest['tool']['poetry']['name'] + version = manifest['tool']['poetry']['version'] + if generation['language'] != 'python': + raise RuntimeError('generation language is not python') + if name != 'cloudpdf': + raise RuntimeError(f'unexpected PyPI project {name}') + if version != generation['sdkVersion']: + raise RuntimeError(f'package version {version} does not match generated version {generation["sdkVersion"]}') + prerelease = '-' in generation['canonicalVersion'] + with open(os.environ['GITHUB_OUTPUT'], 'a', encoding='utf-8') as output: + output.write(f'version={version}\n') + output.write(f'tag=v{version}\n') + output.write(f'prerelease={str(prerelease).lower()}\n') + PY + + - name: Build and inspect distributions + run: | + python -m pip install --disable-pip-version-check build + python -m build --outdir dist + python -m zipfile --list dist/*.whl >/dev/null + + - name: Protect immutable release tag + id: release-tag + env: + RELEASE_TAG: ${{ steps.version.outputs.tag }} + run: | + git fetch --force --tags origin + if git rev-parse --quiet --verify "refs/tags/$RELEASE_TAG" >/dev/null; then + tagged_commit="$(git rev-list -n 1 "$RELEASE_TAG")" + if [ "$tagged_commit" != "$GITHUB_SHA" ]; then + if git diff --quiet "$RELEASE_TAG" "$GITHUB_SHA" -- . ':(exclude).github/**'; then + echo "::notice::Reusing $RELEASE_TAG after a workflow-only change." + else + echo "::error::Release tag $RELEASE_TAG already points to different package source at $tagged_commit; bump the SDK version." + exit 1 + fi + fi + echo "existed=true" >> "$GITHUB_OUTPUT" + else + git config user.name cloudpdf-sdk-bot + git config user.email hello@cloudpdf.com + git tag -a "$RELEASE_TAG" -m "CloudPDF Python SDK $RELEASE_TAG" + git push origin "refs/tags/$RELEASE_TAG" + echo "existed=false" >> "$GITHUB_OUTPUT" + fi + + - name: Check PyPI publication state + id: registry + env: + VERSION: ${{ steps.version.outputs.version }} + TAG_EXISTED: ${{ steps.release-tag.outputs.existed }} + run: | + http_status="$(curl --silent --show-error --output /dev/null --write-out '%{http_code}' "https://pypi.org/pypi/cloudpdf/$VERSION/json")" + case "$http_status" in + 200) + if [ "$TAG_EXISTED" != 'true' ]; then + echo "::error::cloudpdf==$VERSION already exists on PyPI but its release tag did not exist." + exit 1 + fi + echo "publish=false" >> "$GITHUB_OUTPUT" + ;; + 404) + echo "publish=true" >> "$GITHUB_OUTPUT" + ;; + *) + echo "::error::PyPI returned HTTP $http_status while checking cloudpdf==$VERSION." + exit 1 + ;; + esac + + - name: Publish to PyPI + if: steps.registry.outputs.publish == 'true' + uses: pypa/gh-action-pypi-publish@release/v1 + + - name: Create GitHub release + env: + GH_TOKEN: ${{ github.token }} + RELEASE_TAG: ${{ steps.version.outputs.tag }} + PRERELEASE: ${{ steps.version.outputs.prerelease }} + run: | + if gh release view "$RELEASE_TAG" >/dev/null 2>&1; then + exit 0 + fi + args=(--verify-tag --generate-notes --title "CloudPDF Python SDK $RELEASE_TAG") + if [ "$PRERELEASE" = 'true' ]; then args+=(--prerelease); fi + gh release create "$RELEASE_TAG" "${args[@]}" diff --git a/README.md b/README.md index cf1cb48..ba68b39 100644 --- a/README.md +++ b/README.md @@ -1,9 +1,9 @@ -# Cloudpdf Python Library +# CloudPDF Python SDK [![fern shield](https://img.shields.io/badge/%F0%9F%8C%BF-Built%20with%20Fern-brightgreen)](https://buildwithfern.com?utm_source=github&utm_medium=github&utm_campaign=readme&utm_source=Cloudpdf%2FPython) [![pypi](https://img.shields.io/pypi/v/cloudpdf)](https://pypi.python.org/pypi/cloudpdf) -The Cloudpdf Python library provides convenient access to the Cloudpdf APIs from Python. +The official Python SDK for the CloudPDF API. ## Table of Contents @@ -34,9 +34,9 @@ A full reference for this library is available [here](./reference.md). Instantiate and use the client with the following: ```python -from cloudpdf import CloudpdfApi +from cloudpdf import CloudPDFClient -client = CloudpdfApi( +client = CloudPDFClient( token="", base_url="https://yourhost.com/path/to/api", ) @@ -53,9 +53,9 @@ The SDK also exports an `async` client so that you can make non-blocking calls t ```python import asyncio -from cloudpdf import AsyncCloudpdfApi +from cloudpdf import AsyncCloudPDFClient -client = AsyncCloudpdfApi( +client = AsyncCloudPDFClient( token="", base_url="https://yourhost.com/path/to/api", ) @@ -93,9 +93,9 @@ The SDK provides access to raw response data, including headers, through the `.w The `.with_raw_response` property returns a "raw" client that can be used to access the `.headers` and `.data` attributes. ```python -from cloudpdf import CloudpdfApi +from cloudpdf import CloudPDFClient -client = CloudpdfApi(...) +client = CloudPDFClient(...) response = client.tenants.with_raw_response.create(...) print(response.headers) # access the response headers print(response.status_code) # access the response status code @@ -137,9 +137,9 @@ client.tenants.create(..., request_options={ The SDK defaults to a 60 second timeout. You can configure this with a timeout option at the client or request level. ```python -from cloudpdf import CloudpdfApi +from cloudpdf import CloudPDFClient -client = CloudpdfApi(..., timeout=20.0) +client = CloudPDFClient(..., timeout=20.0) # Override timeout for a specific method client.tenants.create(..., request_options={ @@ -154,9 +154,9 @@ and transports. ```python import httpx -from cloudpdf import CloudpdfApi +from cloudpdf import CloudPDFClient -client = CloudpdfApi( +client = CloudPDFClient( ..., httpx_client=httpx.Client( proxy="http://my.test.proxy.example.com", diff --git a/cloudpdf-generation.json b/cloudpdf-generation.json index feba193..f302e83 100644 --- a/cloudpdf-generation.json +++ b/cloudpdf-generation.json @@ -6,7 +6,7 @@ "repository": "embedpdf/embed-pdf-viewer", "openapi": "cloudpdf/contract/openapi.json", "openapiSha256": "6858ce7912e9063d8fb171ade95fc473db01c5971a3af241a612dda79cc05100", - "gitCommit": "232d5e0240d5673a73c9ea7c7ae9e7b937fdd5b3", + "gitCommit": "a0adb9e77ef16feaef2358d71b247b4f5a98fd23", "gitCommitIsDirty": false }, "fern": { diff --git a/pyproject.toml b/pyproject.toml index 5f4ed5b..704afd8 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -5,9 +5,9 @@ dynamic = ["version"] [tool.poetry] name = "cloudpdf" version = "3.0.0a1" -description = "" +description = "The official Python SDK for the CloudPDF API." readme = "README.md" -authors = [] +authors = ["CloudPDF "] keywords = [] license = "Apache-2.0" classifiers = [ diff --git a/reference.md b/reference.md index bf1c185..a21f890 100644 --- a/reference.md +++ b/reference.md @@ -13,9 +13,9 @@
```python -from cloudpdf import CloudpdfApi +from cloudpdf import CloudPDFClient -client = CloudpdfApi( +client = CloudPDFClient( token="", base_url="https://yourhost.com/path/to/api", ) @@ -62,9 +62,9 @@ client.deployment.license_status()
```python -from cloudpdf import CloudpdfApi +from cloudpdf import CloudPDFClient -client = CloudpdfApi( +client = CloudPDFClient( token="", base_url="https://yourhost.com/path/to/api", ) @@ -128,9 +128,9 @@ client.doc.head(
```python -from cloudpdf import CloudpdfApi +from cloudpdf import CloudPDFClient -client = CloudpdfApi( +client = CloudPDFClient( token="", base_url="https://yourhost.com/path/to/api", ) @@ -203,9 +203,9 @@ client.doc.download(
```python -from cloudpdf import CloudpdfApi +from cloudpdf import CloudPDFClient -client = CloudpdfApi( +client = CloudPDFClient( token="", base_url="https://yourhost.com/path/to/api", ) @@ -292,9 +292,9 @@ Render parameters (viewport, format) pass as flat dotted query keys, e.g. `?view
```python -from cloudpdf import CloudpdfApi +from cloudpdf import CloudPDFClient -client = CloudpdfApi( +client = CloudPDFClient( token="", base_url="https://yourhost.com/path/to/api", ) @@ -376,9 +376,9 @@ client.doc.render(
```python -from cloudpdf import CloudpdfApi +from cloudpdf import CloudPDFClient -client = CloudpdfApi( +client = CloudPDFClient( token="", base_url="https://yourhost.com/path/to/api", ) @@ -461,9 +461,9 @@ client.doc.text(
```python -from cloudpdf import CloudpdfApi +from cloudpdf import CloudPDFClient -client = CloudpdfApi( +client = CloudPDFClient( token="", base_url="https://yourhost.com/path/to/api", ) @@ -525,9 +525,9 @@ client.tenants.list()
```python -from cloudpdf import CloudpdfApi +from cloudpdf import CloudPDFClient -client = CloudpdfApi( +client = CloudPDFClient( token="", base_url="https://yourhost.com/path/to/api", ) @@ -591,9 +591,9 @@ client.tenants.create(
```python -from cloudpdf import CloudpdfApi +from cloudpdf import CloudPDFClient -client = CloudpdfApi( +client = CloudPDFClient( token="", base_url="https://yourhost.com/path/to/api", ) @@ -663,9 +663,9 @@ Destroys the tenant and everything in its namespace — documents, layers, store
```python -from cloudpdf import CloudpdfApi +from cloudpdf import CloudPDFClient -client = CloudpdfApi( +client = CloudPDFClient( token="", base_url="https://yourhost.com/path/to/api", ) @@ -722,9 +722,9 @@ client.tenants.delete(
```python -from cloudpdf import CloudpdfApi +from cloudpdf import CloudPDFClient -client = CloudpdfApi( +client = CloudPDFClient( token="", base_url="https://yourhost.com/path/to/api", ) @@ -804,9 +804,9 @@ client.documents.list(
```python -from cloudpdf import CloudpdfApi +from cloudpdf import CloudPDFClient -client = CloudpdfApi( +client = CloudPDFClient( token="", base_url="https://yourhost.com/path/to/api", ) @@ -871,9 +871,9 @@ client.documents.get(
```python -from cloudpdf import CloudpdfApi +from cloudpdf import CloudPDFClient -client = CloudpdfApi( +client = CloudPDFClient( token="", base_url="https://yourhost.com/path/to/api", ) @@ -938,9 +938,9 @@ client.documents.delete(
```python -from cloudpdf import CloudpdfApi +from cloudpdf import CloudPDFClient -client = CloudpdfApi( +client = CloudPDFClient( token="", base_url="https://yourhost.com/path/to/api", ) @@ -1014,9 +1014,9 @@ client.documents.commit(
```python -from cloudpdf import CloudpdfApi +from cloudpdf import CloudPDFClient -client = CloudpdfApi( +client = CloudPDFClient( token="", base_url="https://yourhost.com/path/to/api", ) @@ -1081,9 +1081,9 @@ client.documents.download(
```python -from cloudpdf import CloudpdfApi +from cloudpdf import CloudPDFClient -client = CloudpdfApi( +client = CloudPDFClient( token="", base_url="https://yourhost.com/path/to/api", ) @@ -1212,9 +1212,9 @@ client.documents.upload_direct(...)
```python -from cloudpdf import CloudpdfApi +from cloudpdf import CloudPDFClient -client = CloudpdfApi( +client = CloudPDFClient( token="", base_url="https://yourhost.com/path/to/api", ) @@ -1343,9 +1343,9 @@ kind "tenant" requires the API token — authority mints only downward. Mounted
```python -from cloudpdf import CloudpdfApi, TokensIssueRequest_Doc +from cloudpdf import CloudPDFClient, TokensIssueRequest_Doc -client = CloudpdfApi( +client = CloudPDFClient( token="", base_url="https://yourhost.com/path/to/api", ) @@ -1431,9 +1431,9 @@ Mounted only when the deployment enables token revocation.
```python -from cloudpdf import CloudpdfApi +from cloudpdf import CloudPDFClient -client = CloudpdfApi( +client = CloudPDFClient( token="", base_url="https://yourhost.com/path/to/api", ) @@ -1515,9 +1515,9 @@ client.tokens.revoke(
```python -from cloudpdf import CloudpdfApi +from cloudpdf import CloudPDFClient -client = CloudpdfApi( +client = CloudPDFClient( token="", base_url="https://yourhost.com/path/to/api", ) @@ -1613,9 +1613,9 @@ Doc JWTs may instead carry collab scopes (annotations:create:self, …) that ref
```python -from cloudpdf import CloudpdfApi +from cloudpdf import CloudPDFClient -client = CloudpdfApi( +client = CloudPDFClient( token="", base_url="https://yourhost.com/path/to/api", ) @@ -1708,9 +1708,9 @@ client.doc.annotations.create(
```python -from cloudpdf import CloudpdfApi +from cloudpdf import CloudPDFClient -client = CloudpdfApi( +client = CloudPDFClient( token="", base_url="https://yourhost.com/path/to/api", ) @@ -1801,9 +1801,9 @@ client.doc.annotations.delete(
```python -from cloudpdf import CloudpdfApi +from cloudpdf import CloudPDFClient -client = CloudpdfApi( +client = CloudPDFClient( token="", base_url="https://yourhost.com/path/to/api", ) @@ -1906,9 +1906,9 @@ client.doc.annotations.update(
```python -from cloudpdf import CloudpdfApi +from cloudpdf import CloudPDFClient -client = CloudpdfApi( +client = CloudPDFClient( token="", base_url="https://yourhost.com/path/to/api", ) @@ -1981,9 +1981,9 @@ client.doc.forms.get(
```python -from cloudpdf import CloudpdfApi +from cloudpdf import CloudPDFClient -client = CloudpdfApi( +client = CloudPDFClient( token="", base_url="https://yourhost.com/path/to/api", ) @@ -2064,9 +2064,9 @@ client.doc.forms.export_data(
```python -from cloudpdf import CloudpdfApi +from cloudpdf import CloudPDFClient -client = CloudpdfApi( +client = CloudPDFClient( token="", base_url="https://yourhost.com/path/to/api", ) @@ -2150,9 +2150,9 @@ client.doc.forms.import_data(
```python -from cloudpdf import CloudpdfApi +from cloudpdf import CloudPDFClient -client = CloudpdfApi( +client = CloudPDFClient( token="", base_url="https://yourhost.com/path/to/api", ) @@ -2234,9 +2234,9 @@ client.doc.forms.reset(
```python -from cloudpdf import CloudpdfApi +from cloudpdf import CloudPDFClient -client = CloudpdfApi( +client = CloudPDFClient( token="", base_url="https://yourhost.com/path/to/api", ) @@ -2330,9 +2330,9 @@ client.doc.forms.set_value(
```python -from cloudpdf import CloudpdfApi +from cloudpdf import CloudPDFClient -client = CloudpdfApi( +client = CloudPDFClient( token="", base_url="https://yourhost.com/path/to/api", ) @@ -2406,9 +2406,9 @@ client.doc.metadata.get(
```python -from cloudpdf import CloudpdfApi +from cloudpdf import CloudPDFClient -client = CloudpdfApi( +client = CloudPDFClient( token="", base_url="https://yourhost.com/path/to/api", ) @@ -2492,9 +2492,9 @@ client.doc.pages.delete(
```python -from cloudpdf import CloudpdfApi +from cloudpdf import CloudPDFClient -client = CloudpdfApi( +client = CloudPDFClient( token="", base_url="https://yourhost.com/path/to/api", ) @@ -2578,9 +2578,9 @@ client.doc.pages.flatten(
```python -from cloudpdf import CloudpdfApi +from cloudpdf import CloudPDFClient -client = CloudpdfApi( +client = CloudPDFClient( token="", base_url="https://yourhost.com/path/to/api", ) @@ -2664,9 +2664,9 @@ client.doc.pages.move(
```python -from cloudpdf import CloudpdfApi +from cloudpdf import CloudPDFClient -client = CloudpdfApi( +client = CloudPDFClient( token="", base_url="https://yourhost.com/path/to/api", ) @@ -2751,9 +2751,9 @@ client.doc.pages.rotate(
```python -from cloudpdf import CloudpdfApi +from cloudpdf import CloudPDFClient -client = CloudpdfApi( +client = CloudPDFClient( token="", base_url="https://yourhost.com/path/to/api", ) diff --git a/src/cloudpdf/__init__.py b/src/cloudpdf/__init__.py index f588fe7..5122219 100644 --- a/src/cloudpdf/__init__.py +++ b/src/cloudpdf/__init__.py @@ -2169,15 +2169,15 @@ from .errors import BadRequestError, ForbiddenError, NotFoundError from . import deployment, doc, documents, tenants, tokens from ._default_clients import DefaultAioHttpClient, DefaultAsyncHttpxClient - from .client import AsyncCloudpdfApi, CloudpdfApi + from .client import AsyncCloudPDFClient, CloudPDFClient from .documents import DocumentsInitRequestDedupMode, ListDocumentsRequestState from .version import __version__ _dynamic_imports: typing.Dict[str, str] = { "AdminErrorPayload": ".types", "AdminErrorPayloadError": ".types", - "AsyncCloudpdfApi": ".client", + "AsyncCloudPDFClient": ".client", "BadRequestError": ".errors", - "CloudpdfApi": ".client", + "CloudPDFClient": ".client", "DefaultAioHttpClient": "._default_clients", "DefaultAsyncHttpxClient": "._default_clients", "DeploymentLicenseStatusResponse": ".types", @@ -4373,9 +4373,9 @@ def __dir__(): __all__ = [ "AdminErrorPayload", "AdminErrorPayloadError", - "AsyncCloudpdfApi", + "AsyncCloudPDFClient", "BadRequestError", - "CloudpdfApi", + "CloudPDFClient", "DefaultAioHttpClient", "DefaultAsyncHttpxClient", "DeploymentLicenseStatusResponse", diff --git a/src/cloudpdf/client.py b/src/cloudpdf/client.py index 5f036cb..36ab6a4 100644 --- a/src/cloudpdf/client.py +++ b/src/cloudpdf/client.py @@ -16,7 +16,7 @@ from .tokens.client import AsyncTokensClient, TokensClient -class CloudpdfApi: +class CloudPDFClient: """ Use this class to access the different functions within the SDK. You can instantiate any number of clients with different configuration that will propagate to these functions. @@ -52,9 +52,9 @@ class CloudpdfApi: Examples -------- - from cloudpdf import CloudpdfApi + from cloudpdf import CloudPDFClient - client = CloudpdfApi( + client = CloudPDFClient( token="YOUR_TOKEN", base_url="https://yourhost.com/path/to/api", ) @@ -156,7 +156,7 @@ def _make_default_async_client( return httpx.AsyncClient(timeout=timeout) -class AsyncCloudpdfApi: +class AsyncCloudPDFClient: """ Use this class to access the different functions within the SDK. You can instantiate any number of clients with different configuration that will propagate to these functions. @@ -195,9 +195,9 @@ class AsyncCloudpdfApi: Examples -------- - from cloudpdf import AsyncCloudpdfApi + from cloudpdf import AsyncCloudPDFClient - client = AsyncCloudpdfApi( + client = AsyncCloudPDFClient( token="YOUR_TOKEN", base_url="https://yourhost.com/path/to/api", ) diff --git a/src/cloudpdf/deployment/client.py b/src/cloudpdf/deployment/client.py index 2e47d6d..b90ca77 100644 --- a/src/cloudpdf/deployment/client.py +++ b/src/cloudpdf/deployment/client.py @@ -39,9 +39,9 @@ def license_status( Examples -------- - from cloudpdf import CloudpdfApi + from cloudpdf import CloudPDFClient - client = CloudpdfApi( + client = CloudPDFClient( token="YOUR_TOKEN", base_url="https://yourhost.com/path/to/api", ) @@ -84,9 +84,9 @@ async def license_status( -------- import asyncio - from cloudpdf import AsyncCloudpdfApi + from cloudpdf import AsyncCloudPDFClient - client = AsyncCloudpdfApi( + client = AsyncCloudPDFClient( token="YOUR_TOKEN", base_url="https://yourhost.com/path/to/api", ) diff --git a/src/cloudpdf/doc/annotations/client.py b/src/cloudpdf/doc/annotations/client.py index 72b585a..b12d1e9 100644 --- a/src/cloudpdf/doc/annotations/client.py +++ b/src/cloudpdf/doc/annotations/client.py @@ -62,9 +62,9 @@ def list( Examples -------- - from cloudpdf import CloudpdfApi + from cloudpdf import CloudPDFClient - client = CloudpdfApi( + client = CloudPDFClient( token="YOUR_TOKEN", base_url="https://yourhost.com/path/to/api", ) @@ -115,9 +115,9 @@ def create( Examples -------- - from cloudpdf import CloudpdfApi + from cloudpdf import CloudPDFClient - client = CloudpdfApi( + client = CloudPDFClient( token="YOUR_TOKEN", base_url="https://yourhost.com/path/to/api", ) @@ -172,9 +172,9 @@ def delete( Examples -------- - from cloudpdf import CloudpdfApi + from cloudpdf import CloudPDFClient - client = CloudpdfApi( + client = CloudPDFClient( token="YOUR_TOKEN", base_url="https://yourhost.com/path/to/api", ) @@ -227,9 +227,9 @@ def update( Examples -------- - from cloudpdf import CloudpdfApi + from cloudpdf import CloudPDFClient - client = CloudpdfApi( + client = CloudPDFClient( token="YOUR_TOKEN", base_url="https://yourhost.com/path/to/api", ) @@ -301,9 +301,9 @@ async def list( -------- import asyncio - from cloudpdf import AsyncCloudpdfApi + from cloudpdf import AsyncCloudPDFClient - client = AsyncCloudpdfApi( + client = AsyncCloudPDFClient( token="YOUR_TOKEN", base_url="https://yourhost.com/path/to/api", ) @@ -362,9 +362,9 @@ async def create( -------- import asyncio - from cloudpdf import AsyncCloudpdfApi + from cloudpdf import AsyncCloudPDFClient - client = AsyncCloudpdfApi( + client = AsyncCloudPDFClient( token="YOUR_TOKEN", base_url="https://yourhost.com/path/to/api", ) @@ -427,9 +427,9 @@ async def delete( -------- import asyncio - from cloudpdf import AsyncCloudpdfApi + from cloudpdf import AsyncCloudPDFClient - client = AsyncCloudpdfApi( + client = AsyncCloudPDFClient( token="YOUR_TOKEN", base_url="https://yourhost.com/path/to/api", ) @@ -490,9 +490,9 @@ async def update( -------- import asyncio - from cloudpdf import AsyncCloudpdfApi + from cloudpdf import AsyncCloudPDFClient - client = AsyncCloudpdfApi( + client = AsyncCloudPDFClient( token="YOUR_TOKEN", base_url="https://yourhost.com/path/to/api", ) diff --git a/src/cloudpdf/doc/client.py b/src/cloudpdf/doc/client.py index 2e9bd25..6110634 100644 --- a/src/cloudpdf/doc/client.py +++ b/src/cloudpdf/doc/client.py @@ -65,9 +65,9 @@ def head( Examples -------- - from cloudpdf import CloudpdfApi + from cloudpdf import CloudPDFClient - client = CloudpdfApi( + client = CloudPDFClient( token="YOUR_TOKEN", base_url="https://yourhost.com/path/to/api", ) @@ -106,9 +106,9 @@ def download( Examples -------- - from cloudpdf import CloudpdfApi + from cloudpdf import CloudPDFClient - client = CloudpdfApi( + client = CloudPDFClient( token="YOUR_TOKEN", base_url="https://yourhost.com/path/to/api", ) @@ -150,9 +150,9 @@ def manifest( Examples -------- - from cloudpdf import CloudpdfApi + from cloudpdf import CloudPDFClient - client = CloudpdfApi( + client = CloudPDFClient( token="YOUR_TOKEN", base_url="https://yourhost.com/path/to/api", ) @@ -199,9 +199,9 @@ def render( Examples -------- - from cloudpdf import CloudpdfApi + from cloudpdf import CloudPDFClient - client = CloudpdfApi( + client = CloudPDFClient( token="YOUR_TOKEN", base_url="https://yourhost.com/path/to/api", ) @@ -247,9 +247,9 @@ def text( Examples -------- - from cloudpdf import CloudpdfApi + from cloudpdf import CloudPDFClient - client = CloudpdfApi( + client = CloudPDFClient( token="YOUR_TOKEN", base_url="https://yourhost.com/path/to/api", ) @@ -353,9 +353,9 @@ async def head( -------- import asyncio - from cloudpdf import AsyncCloudpdfApi + from cloudpdf import AsyncCloudPDFClient - client = AsyncCloudpdfApi( + client = AsyncCloudPDFClient( token="YOUR_TOKEN", base_url="https://yourhost.com/path/to/api", ) @@ -404,9 +404,9 @@ async def download( -------- import asyncio - from cloudpdf import AsyncCloudpdfApi + from cloudpdf import AsyncCloudPDFClient - client = AsyncCloudpdfApi( + client = AsyncCloudPDFClient( token="YOUR_TOKEN", base_url="https://yourhost.com/path/to/api", ) @@ -457,9 +457,9 @@ async def manifest( -------- import asyncio - from cloudpdf import AsyncCloudpdfApi + from cloudpdf import AsyncCloudPDFClient - client = AsyncCloudpdfApi( + client = AsyncCloudPDFClient( token="YOUR_TOKEN", base_url="https://yourhost.com/path/to/api", ) @@ -514,9 +514,9 @@ async def render( -------- import asyncio - from cloudpdf import AsyncCloudpdfApi + from cloudpdf import AsyncCloudPDFClient - client = AsyncCloudpdfApi( + client = AsyncCloudPDFClient( token="YOUR_TOKEN", base_url="https://yourhost.com/path/to/api", ) @@ -571,9 +571,9 @@ async def text( -------- import asyncio - from cloudpdf import AsyncCloudpdfApi + from cloudpdf import AsyncCloudPDFClient - client = AsyncCloudpdfApi( + client = AsyncCloudPDFClient( token="YOUR_TOKEN", base_url="https://yourhost.com/path/to/api", ) diff --git a/src/cloudpdf/doc/forms/client.py b/src/cloudpdf/doc/forms/client.py index 740a6ca..d38501d 100644 --- a/src/cloudpdf/doc/forms/client.py +++ b/src/cloudpdf/doc/forms/client.py @@ -60,9 +60,9 @@ def get( Examples -------- - from cloudpdf import CloudpdfApi + from cloudpdf import CloudPDFClient - client = CloudpdfApi( + client = CloudPDFClient( token="YOUR_TOKEN", base_url="https://yourhost.com/path/to/api", ) @@ -107,9 +107,9 @@ def export_data( Examples -------- - from cloudpdf import CloudpdfApi + from cloudpdf import CloudPDFClient - client = CloudpdfApi( + client = CloudPDFClient( token="YOUR_TOKEN", base_url="https://yourhost.com/path/to/api", ) @@ -154,9 +154,9 @@ def import_data( Examples -------- - from cloudpdf import CloudpdfApi + from cloudpdf import CloudPDFClient - client = CloudpdfApi( + client = CloudPDFClient( token="YOUR_TOKEN", base_url="https://yourhost.com/path/to/api", ) @@ -202,9 +202,9 @@ def reset( Examples -------- - from cloudpdf import CloudpdfApi + from cloudpdf import CloudPDFClient - client = CloudpdfApi( + client = CloudPDFClient( token="YOUR_TOKEN", base_url="https://yourhost.com/path/to/api", ) @@ -253,9 +253,9 @@ def set_value( Examples -------- - from cloudpdf import CloudpdfApi + from cloudpdf import CloudPDFClient - client = CloudpdfApi( + client = CloudPDFClient( token="YOUR_TOKEN", base_url="https://yourhost.com/path/to/api", ) @@ -322,9 +322,9 @@ async def get( -------- import asyncio - from cloudpdf import AsyncCloudpdfApi + from cloudpdf import AsyncCloudPDFClient - client = AsyncCloudpdfApi( + client = AsyncCloudPDFClient( token="YOUR_TOKEN", base_url="https://yourhost.com/path/to/api", ) @@ -377,9 +377,9 @@ async def export_data( -------- import asyncio - from cloudpdf import AsyncCloudpdfApi + from cloudpdf import AsyncCloudPDFClient - client = AsyncCloudpdfApi( + client = AsyncCloudPDFClient( token="YOUR_TOKEN", base_url="https://yourhost.com/path/to/api", ) @@ -433,9 +433,9 @@ async def import_data( -------- import asyncio - from cloudpdf import AsyncCloudpdfApi + from cloudpdf import AsyncCloudPDFClient - client = AsyncCloudpdfApi( + client = AsyncCloudPDFClient( token="YOUR_TOKEN", base_url="https://yourhost.com/path/to/api", ) @@ -489,9 +489,9 @@ async def reset( -------- import asyncio - from cloudpdf import AsyncCloudpdfApi + from cloudpdf import AsyncCloudPDFClient - client = AsyncCloudpdfApi( + client = AsyncCloudPDFClient( token="YOUR_TOKEN", base_url="https://yourhost.com/path/to/api", ) @@ -548,9 +548,9 @@ async def set_value( -------- import asyncio - from cloudpdf import AsyncCloudpdfApi + from cloudpdf import AsyncCloudPDFClient - client = AsyncCloudpdfApi( + client = AsyncCloudPDFClient( token="YOUR_TOKEN", base_url="https://yourhost.com/path/to/api", ) diff --git a/src/cloudpdf/doc/metadata/client.py b/src/cloudpdf/doc/metadata/client.py index 7890916..cb94744 100644 --- a/src/cloudpdf/doc/metadata/client.py +++ b/src/cloudpdf/doc/metadata/client.py @@ -51,9 +51,9 @@ def get( Examples -------- - from cloudpdf import CloudpdfApi + from cloudpdf import CloudPDFClient - client = CloudpdfApi( + client = CloudPDFClient( token="YOUR_TOKEN", base_url="https://yourhost.com/path/to/api", ) @@ -113,9 +113,9 @@ async def get( -------- import asyncio - from cloudpdf import AsyncCloudpdfApi + from cloudpdf import AsyncCloudPDFClient - client = AsyncCloudpdfApi( + client = AsyncCloudPDFClient( token="YOUR_TOKEN", base_url="https://yourhost.com/path/to/api", ) diff --git a/src/cloudpdf/doc/pages/client.py b/src/cloudpdf/doc/pages/client.py index 7bf0c7d..911c01c 100644 --- a/src/cloudpdf/doc/pages/client.py +++ b/src/cloudpdf/doc/pages/client.py @@ -64,9 +64,9 @@ def delete( Examples -------- - from cloudpdf import CloudpdfApi + from cloudpdf import CloudPDFClient - client = CloudpdfApi( + client = CloudPDFClient( token="YOUR_TOKEN", base_url="https://yourhost.com/path/to/api", ) @@ -112,9 +112,9 @@ def flatten( Examples -------- - from cloudpdf import CloudpdfApi + from cloudpdf import CloudPDFClient - client = CloudpdfApi( + client = CloudPDFClient( token="YOUR_TOKEN", base_url="https://yourhost.com/path/to/api", ) @@ -160,9 +160,9 @@ def move( Examples -------- - from cloudpdf import CloudpdfApi + from cloudpdf import CloudPDFClient - client = CloudpdfApi( + client = CloudPDFClient( token="YOUR_TOKEN", base_url="https://yourhost.com/path/to/api", ) @@ -208,9 +208,9 @@ def rotate( Examples -------- - from cloudpdf import CloudpdfApi + from cloudpdf import CloudPDFClient - client = CloudpdfApi( + client = CloudPDFClient( token="YOUR_TOKEN", base_url="https://yourhost.com/path/to/api", ) @@ -274,9 +274,9 @@ async def delete( -------- import asyncio - from cloudpdf import AsyncCloudpdfApi + from cloudpdf import AsyncCloudPDFClient - client = AsyncCloudpdfApi( + client = AsyncCloudPDFClient( token="YOUR_TOKEN", base_url="https://yourhost.com/path/to/api", ) @@ -330,9 +330,9 @@ async def flatten( -------- import asyncio - from cloudpdf import AsyncCloudpdfApi + from cloudpdf import AsyncCloudPDFClient - client = AsyncCloudpdfApi( + client = AsyncCloudPDFClient( token="YOUR_TOKEN", base_url="https://yourhost.com/path/to/api", ) @@ -386,9 +386,9 @@ async def move( -------- import asyncio - from cloudpdf import AsyncCloudpdfApi + from cloudpdf import AsyncCloudPDFClient - client = AsyncCloudpdfApi( + client = AsyncCloudPDFClient( token="YOUR_TOKEN", base_url="https://yourhost.com/path/to/api", ) @@ -442,9 +442,9 @@ async def rotate( -------- import asyncio - from cloudpdf import AsyncCloudpdfApi + from cloudpdf import AsyncCloudPDFClient - client = AsyncCloudpdfApi( + client = AsyncCloudPDFClient( token="YOUR_TOKEN", base_url="https://yourhost.com/path/to/api", ) diff --git a/src/cloudpdf/doc/redactions/client.py b/src/cloudpdf/doc/redactions/client.py index 73313b4..7a3cd75 100644 --- a/src/cloudpdf/doc/redactions/client.py +++ b/src/cloudpdf/doc/redactions/client.py @@ -58,9 +58,9 @@ def apply( Examples -------- - from cloudpdf import CloudpdfApi + from cloudpdf import CloudPDFClient - client = CloudpdfApi( + client = CloudPDFClient( token="YOUR_TOKEN", base_url="https://yourhost.com/path/to/api", ) @@ -124,9 +124,9 @@ async def apply( -------- import asyncio - from cloudpdf import AsyncCloudpdfApi + from cloudpdf import AsyncCloudPDFClient - client = AsyncCloudpdfApi( + client = AsyncCloudPDFClient( token="YOUR_TOKEN", base_url="https://yourhost.com/path/to/api", ) diff --git a/src/cloudpdf/documents/client.py b/src/cloudpdf/documents/client.py index 59fc8f8..21ffc24 100644 --- a/src/cloudpdf/documents/client.py +++ b/src/cloudpdf/documents/client.py @@ -62,9 +62,9 @@ def list( Examples -------- - from cloudpdf import CloudpdfApi + from cloudpdf import CloudPDFClient - client = CloudpdfApi( + client = CloudPDFClient( token="YOUR_TOKEN", base_url="https://yourhost.com/path/to/api", ) @@ -97,9 +97,9 @@ def get( Examples -------- - from cloudpdf import CloudpdfApi + from cloudpdf import CloudPDFClient - client = CloudpdfApi( + client = CloudPDFClient( token="YOUR_TOKEN", base_url="https://yourhost.com/path/to/api", ) @@ -128,9 +128,9 @@ def delete(self, tenant_id: str, id: str, *, request_options: typing.Optional[Re Examples -------- - from cloudpdf import CloudpdfApi + from cloudpdf import CloudPDFClient - client = CloudpdfApi( + client = CloudPDFClient( token="YOUR_TOKEN", base_url="https://yourhost.com/path/to/api", ) @@ -164,9 +164,9 @@ def commit( Examples -------- - from cloudpdf import CloudpdfApi + from cloudpdf import CloudPDFClient - client = CloudpdfApi( + client = CloudPDFClient( token="YOUR_TOKEN", base_url="https://yourhost.com/path/to/api", ) @@ -199,9 +199,9 @@ def download( Examples -------- - from cloudpdf import CloudpdfApi + from cloudpdf import CloudPDFClient - client = CloudpdfApi( + client = CloudPDFClient( token="YOUR_TOKEN", base_url="https://yourhost.com/path/to/api", ) @@ -233,9 +233,9 @@ def thumbnail( Examples -------- - from cloudpdf import CloudpdfApi + from cloudpdf import CloudPDFClient - client = CloudpdfApi( + client = CloudPDFClient( token="YOUR_TOKEN", base_url="https://yourhost.com/path/to/api", ) @@ -317,9 +317,9 @@ def init( Examples -------- - from cloudpdf import CloudpdfApi + from cloudpdf import CloudPDFClient - client = CloudpdfApi( + client = CloudPDFClient( token="YOUR_TOKEN", base_url="https://yourhost.com/path/to/api", ) @@ -390,9 +390,9 @@ async def list( -------- import asyncio - from cloudpdf import AsyncCloudpdfApi + from cloudpdf import AsyncCloudPDFClient - client = AsyncCloudpdfApi( + client = AsyncCloudPDFClient( token="YOUR_TOKEN", base_url="https://yourhost.com/path/to/api", ) @@ -433,9 +433,9 @@ async def get( -------- import asyncio - from cloudpdf import AsyncCloudpdfApi + from cloudpdf import AsyncCloudPDFClient - client = AsyncCloudpdfApi( + client = AsyncCloudPDFClient( token="YOUR_TOKEN", base_url="https://yourhost.com/path/to/api", ) @@ -472,9 +472,9 @@ async def delete(self, tenant_id: str, id: str, *, request_options: typing.Optio -------- import asyncio - from cloudpdf import AsyncCloudpdfApi + from cloudpdf import AsyncCloudPDFClient - client = AsyncCloudpdfApi( + client = AsyncCloudPDFClient( token="YOUR_TOKEN", base_url="https://yourhost.com/path/to/api", ) @@ -516,9 +516,9 @@ async def commit( -------- import asyncio - from cloudpdf import AsyncCloudpdfApi + from cloudpdf import AsyncCloudPDFClient - client = AsyncCloudpdfApi( + client = AsyncCloudPDFClient( token="YOUR_TOKEN", base_url="https://yourhost.com/path/to/api", ) @@ -559,9 +559,9 @@ async def download( -------- import asyncio - from cloudpdf import AsyncCloudpdfApi + from cloudpdf import AsyncCloudPDFClient - client = AsyncCloudpdfApi( + client = AsyncCloudPDFClient( token="YOUR_TOKEN", base_url="https://yourhost.com/path/to/api", ) @@ -602,9 +602,9 @@ async def thumbnail( -------- import asyncio - from cloudpdf import AsyncCloudpdfApi + from cloudpdf import AsyncCloudPDFClient - client = AsyncCloudpdfApi( + client = AsyncCloudPDFClient( token="YOUR_TOKEN", base_url="https://yourhost.com/path/to/api", ) @@ -697,9 +697,9 @@ async def init( -------- import asyncio - from cloudpdf import AsyncCloudpdfApi + from cloudpdf import AsyncCloudPDFClient - client = AsyncCloudpdfApi( + client = AsyncCloudPDFClient( token="YOUR_TOKEN", base_url="https://yourhost.com/path/to/api", ) diff --git a/src/cloudpdf/tenants/client.py b/src/cloudpdf/tenants/client.py index 5d1532c..4b1e769 100644 --- a/src/cloudpdf/tenants/client.py +++ b/src/cloudpdf/tenants/client.py @@ -52,9 +52,9 @@ def list( Examples -------- - from cloudpdf import CloudpdfApi + from cloudpdf import CloudPDFClient - client = CloudpdfApi( + client = CloudPDFClient( token="YOUR_TOKEN", base_url="https://yourhost.com/path/to/api", ) @@ -83,9 +83,9 @@ def create( Examples -------- - from cloudpdf import CloudpdfApi + from cloudpdf import CloudPDFClient - client = CloudpdfApi( + client = CloudPDFClient( token="YOUR_TOKEN", base_url="https://yourhost.com/path/to/api", ) @@ -112,9 +112,9 @@ def get(self, tenant_id: str, *, request_options: typing.Optional[RequestOptions Examples -------- - from cloudpdf import CloudpdfApi + from cloudpdf import CloudPDFClient - client = CloudpdfApi( + client = CloudPDFClient( token="YOUR_TOKEN", base_url="https://yourhost.com/path/to/api", ) @@ -142,9 +142,9 @@ def delete(self, tenant_id: str, *, request_options: typing.Optional[RequestOpti Examples -------- - from cloudpdf import CloudpdfApi + from cloudpdf import CloudPDFClient - client = CloudpdfApi( + client = CloudPDFClient( token="YOUR_TOKEN", base_url="https://yourhost.com/path/to/api", ) @@ -197,9 +197,9 @@ async def list( -------- import asyncio - from cloudpdf import AsyncCloudpdfApi + from cloudpdf import AsyncCloudPDFClient - client = AsyncCloudpdfApi( + client = AsyncCloudPDFClient( token="YOUR_TOKEN", base_url="https://yourhost.com/path/to/api", ) @@ -236,9 +236,9 @@ async def create( -------- import asyncio - from cloudpdf import AsyncCloudpdfApi + from cloudpdf import AsyncCloudPDFClient - client = AsyncCloudpdfApi( + client = AsyncCloudPDFClient( token="YOUR_TOKEN", base_url="https://yourhost.com/path/to/api", ) @@ -275,9 +275,9 @@ async def get( -------- import asyncio - from cloudpdf import AsyncCloudpdfApi + from cloudpdf import AsyncCloudPDFClient - client = AsyncCloudpdfApi( + client = AsyncCloudPDFClient( token="YOUR_TOKEN", base_url="https://yourhost.com/path/to/api", ) @@ -313,9 +313,9 @@ async def delete(self, tenant_id: str, *, request_options: typing.Optional[Reque -------- import asyncio - from cloudpdf import AsyncCloudpdfApi + from cloudpdf import AsyncCloudPDFClient - client = AsyncCloudpdfApi( + client = AsyncCloudPDFClient( token="YOUR_TOKEN", base_url="https://yourhost.com/path/to/api", ) diff --git a/src/cloudpdf/tokens/client.py b/src/cloudpdf/tokens/client.py index 49feee1..fbc025a 100644 --- a/src/cloudpdf/tokens/client.py +++ b/src/cloudpdf/tokens/client.py @@ -49,9 +49,9 @@ def issue( Examples -------- - from cloudpdf import CloudpdfApi, TokensIssueRequest_Doc + from cloudpdf import CloudPDFClient, TokensIssueRequest_Doc - client = CloudpdfApi( + client = CloudPDFClient( token="YOUR_TOKEN", base_url="https://yourhost.com/path/to/api", ) @@ -99,9 +99,9 @@ def revoke( Examples -------- - from cloudpdf import CloudpdfApi + from cloudpdf import CloudPDFClient - client = CloudpdfApi( + client = CloudPDFClient( token="YOUR_TOKEN", base_url="https://yourhost.com/path/to/api", ) @@ -155,9 +155,9 @@ async def issue( -------- import asyncio - from cloudpdf import AsyncCloudpdfApi, TokensIssueRequest_Doc + from cloudpdf import AsyncCloudPDFClient, TokensIssueRequest_Doc - client = AsyncCloudpdfApi( + client = AsyncCloudPDFClient( token="YOUR_TOKEN", base_url="https://yourhost.com/path/to/api", ) @@ -213,9 +213,9 @@ async def revoke( -------- import asyncio - from cloudpdf import AsyncCloudpdfApi + from cloudpdf import AsyncCloudPDFClient - client = AsyncCloudpdfApi( + client = AsyncCloudPDFClient( token="YOUR_TOKEN", base_url="https://yourhost.com/path/to/api", )