Skip to content
Open
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
  •  
  •  
  •  
1 change: 1 addition & 0 deletions .devcontainer/setup.sh
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@ curl -fsSL https://raw.githubusercontent.com/speakeasy-api/speakeasy/main/instal
rmdir samples || true
mkdir samples


python -m pip install --upgrade pip
pip install -e .

Expand Down
748 changes: 389 additions & 359 deletions .speakeasy/gen.lock

Large diffs are not rendered by default.

7 changes: 6 additions & 1 deletion .speakeasy/gen.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -19,8 +19,12 @@ generation:
auth:
oAuth2ClientCredentialsEnabled: false
oAuth2PasswordEnabled: false
tests:
generateTests: true
generateNewTests: false
skipResponseBodyAssertions: false
python:
version: 0.2.0
version: 0.2.1
additionalDependencies:
dev: {}
main: {}
Expand Down Expand Up @@ -51,6 +55,7 @@ python:
methodArguments: infer-optional-args
moduleName: ""
outputModelSuffix: output
packageManager: poetry
packageName: documenso_sdk
pytestFilterWarnings: []
pytestTimeout: 0
Expand Down
14 changes: 7 additions & 7 deletions .speakeasy/workflow.lock
Original file line number Diff line number Diff line change
@@ -1,20 +1,20 @@
speakeasyVersion: 1.557.0
speakeasyVersion: 1.606.5
sources:
documenso-OAS:
sourceNamespace: documenso-v-2-beta-api
sourceRevisionDigest: sha256:f6430b0cc0c2d5b7a14e59359376c04f78458dd953a630f4a58093e86b4b56f7
sourceBlobDigest: sha256:b5ace18675a2927ed909e9e7210586bfd0bad91e1efebe408005432746a1511c
sourceRevisionDigest: sha256:edad9cc20eb56ca39753b7a96c8c75f876e716df520da392bd8aab9dac31f0f9
sourceBlobDigest: sha256:03b086614aed59a736a1a84f96e719f587b3fe7c599647320f711b19c6e7a586
tags:
- latest
- speakeasy-sdk-regen-1748563993
- speakeasy-sdk-regen-1751415201
targets:
documenso:
source: documenso-OAS
sourceNamespace: documenso-v-2-beta-api
sourceRevisionDigest: sha256:f6430b0cc0c2d5b7a14e59359376c04f78458dd953a630f4a58093e86b4b56f7
sourceBlobDigest: sha256:b5ace18675a2927ed909e9e7210586bfd0bad91e1efebe408005432746a1511c
sourceRevisionDigest: sha256:edad9cc20eb56ca39753b7a96c8c75f876e716df520da392bd8aab9dac31f0f9
sourceBlobDigest: sha256:03b086614aed59a736a1a84f96e719f587b3fe7c599647320f711b19c6e7a586
codeSamplesNamespace: documenso-oas-python-code-samples
codeSamplesRevisionDigest: sha256:6d7df31290db2a621eb8ff80158fba13b9b8a4e653625f0a83320d00cb14494e
codeSamplesRevisionDigest: sha256:db0a037286d8310ff53552a5aae4c5f7b9cd7a833eac6b4a19c3fd9c4cb4de26
workflow:
workflowVersion: 1.0.0
speakeasyVersion: latest
Expand Down
199 changes: 157 additions & 42 deletions README-PYPI.md

Large diffs are not rendered by default.

199 changes: 157 additions & 42 deletions README.md

Large diffs are not rendered by default.

12 changes: 11 additions & 1 deletion RELEASES.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,4 +16,14 @@ Based on:
### Generated
- [python v0.2.0] .
### Releases
- [PyPI v0.2.0] https://pypi.org/project/documenso_sdk/0.2.0 - .
- [PyPI v0.2.0] https://pypi.org/project/documenso_sdk/0.2.0 - .

## 2025-08-26 00:12:34
### Changes
Based on:
- OpenAPI Doc
- Speakeasy CLI 1.606.5 (2.687.1) https://github.com/speakeasy-api/speakeasy
### Generated
- [python v0.2.1] .
### Releases
- [PyPI v0.2.1] https://pypi.org/project/documenso_sdk/0.2.1 - .
8 changes: 3 additions & 5 deletions USAGE.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
<!-- Start SDK Example Usage [usage] -->
```python
# Synchronous Example
import documenso_sdk
from documenso_sdk import Documenso
import os

Expand All @@ -10,19 +9,18 @@ with Documenso(
api_key=os.getenv("DOCUMENSO_API_KEY", ""),
) as documenso:

res = documenso.documents.find(order_by_direction=documenso_sdk.OrderByDirection.DESC)
res = documenso.documents.update(document_id=9701.92)

# Handle response
print(res)
```

</br>

The same SDK client can also be used to make asychronous requests by importing asyncio.
The same SDK client can also be used to make asynchronous requests by importing asyncio.
```python
# Asynchronous Example
import asyncio
import documenso_sdk
from documenso_sdk import Documenso
import os

Expand All @@ -32,7 +30,7 @@ async def main():
api_key=os.getenv("DOCUMENSO_API_KEY", ""),
) as documenso:

res = await documenso.documents.find_async(order_by_direction=documenso_sdk.OrderByDirection.DESC)
res = await documenso.documents.update_async(document_id=9701.92)

# Handle response
print(res)
Expand Down
4 changes: 3 additions & 1 deletion docs/models/document.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,9 +19,11 @@
| `updated_at` | *str* | :heavy_check_mark: | N/A |
| `completed_at` | *Nullable[str]* | :heavy_check_mark: | N/A |
| `deleted_at` | *Nullable[str]* | :heavy_check_mark: | N/A |
| `team_id` | *Nullable[float]* | :heavy_check_mark: | N/A |
| `team_id` | *float* | :heavy_check_mark: | N/A |
| `template_id` | *Nullable[float]* | :heavy_check_mark: | N/A |
| `folder_id` | *Nullable[str]* | :heavy_check_mark: | N/A |
| `document_data` | [models.DocumentCreateDocumentTemporaryDocumentData](../models/documentcreatedocumenttemporarydocumentdata.md) | :heavy_check_mark: | N/A |
| `document_meta` | [Nullable[models.DocumentCreateDocumentTemporaryDocumentMeta]](../models/documentcreatedocumenttemporarydocumentmeta.md) | :heavy_check_mark: | N/A |
| `folder` | [Nullable[models.DocumentCreateDocumentTemporaryFolder]](../models/documentcreatedocumenttemporaryfolder.md) | :heavy_check_mark: | N/A |
| `recipients` | List[[models.DocumentRecipient](../models/documentrecipient.md)] | :heavy_check_mark: | N/A |
| `fields` | List[[models.DocumentField](../models/documentfield.md)] | :heavy_check_mark: | N/A |
1 change: 1 addition & 0 deletions docs/models/documentactionauth.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,4 +10,5 @@ The type of authentication required for the recipient to sign the document.
| `ACCOUNT` | ACCOUNT |
| `PASSKEY` | PASSKEY |
| `TWO_FACTOR_AUTH` | TWO_FACTOR_AUTH |
| `PASSWORD` | PASSWORD |
| `EXPLICIT_NONE` | EXPLICIT_NONE |
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# ActionAuthAccount
# DocumentCreateDocumentTemporaryActionAuthRequest

The type of authentication required for the recipient to sign the document.

Expand All @@ -10,4 +10,5 @@ The type of authentication required for the recipient to sign the document.
| `ACCOUNT` | ACCOUNT |
| `PASSKEY` | PASSKEY |
| `TWO_FACTOR_AUTH` | TWO_FACTOR_AUTH |
| `PASSWORD` | PASSWORD |
| `EXPLICIT_NONE` | EXPLICIT_NONE |
8 changes: 4 additions & 4 deletions docs/models/documentcreatedocumenttemporaryauthoptions.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@

## Fields

| Field | Type | Required | Description |
| ----------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------- |
| `global_access_auth` | [Nullable[models.DocumentGlobalAccessAuth]](../models/documentglobalaccessauth.md) | :heavy_check_mark: | The type of authentication required for the recipient to access the document. |
| `global_action_auth` | [Nullable[models.DocumentGlobalActionAuth]](../models/documentglobalactionauth.md) | :heavy_check_mark: | The type of authentication required for the recipient to sign the document. This field is restricted to Enterprise plan users only. |
| Field | Type | Required | Description |
| ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ |
| `global_access_auth` | List[[models.DocumentGlobalAccessAuth](../models/documentglobalaccessauth.md)] | :heavy_check_mark: | N/A |
| `global_action_auth` | List[[models.DocumentGlobalActionAuth](../models/documentglobalactionauth.md)] | :heavy_check_mark: | N/A |
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# DistributionMethodAccount
# DocumentCreateDocumentTemporaryDistributionMethodRequest

The distribution method to use when sending the document to the recipients.

Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# EmailSettingsAccount
# DocumentCreateDocumentTemporaryEmailSettingsRequest


## Fields
Expand Down
14 changes: 14 additions & 0 deletions docs/models/documentcreatedocumenttemporaryfieldcheckbox.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
# DocumentCreateDocumentTemporaryFieldCheckbox


## Fields

| Field | Type | Required | Description |
| ---------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------- |
| `type` | [models.DocumentCreateDocumentTemporaryRecipientTypeCheckbox1](../models/documentcreatedocumenttemporaryrecipienttypecheckbox1.md) | :heavy_check_mark: | N/A |
| `field_meta` | [Optional[models.DocumentCreateDocumentTemporaryRecipientFieldMetaCheckbox]](../models/documentcreatedocumenttemporaryrecipientfieldmetacheckbox.md) | :heavy_minus_sign: | N/A |
| `page_number` | *float* | :heavy_check_mark: | The page number the field will be on. |
| `page_x` | *float* | :heavy_check_mark: | The X coordinate of where the field will be placed. |
| `page_y` | *float* | :heavy_check_mark: | The Y coordinate of where the field will be placed. |
| `width` | *float* | :heavy_check_mark: | The width of the field. |
| `height` | *float* | :heavy_check_mark: | The height of the field. |
Loading