Skip to content

SDK update: python v3.0.0 #30

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
upcFrost wants to merge 1 commit into
base: main
Choose a base branch
from
Open

SDK update: python v3.0.0 #30

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
989 changes: 692 additions & 297 deletions .manifest.json
View file
Open in desktop

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion LICENSE
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
MIT License

Copyright (c) 2025
Copyright (c) 2026

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
Expand Down
207 changes: 124 additions & 83 deletions PyPI_README.md
View file
Open in desktop

Large diffs are not rendered by default.

207 changes: 124 additions & 83 deletions README.md
View file
Open in desktop

Large diffs are not rendered by default.

20 changes: 20 additions & 0 deletions documentation/models/AddEnvelopeAnnotationRequest.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
# AddEnvelopeAnnotationRequest

**Properties**

| Name | Type | Required | Description |
| :----------- | :-------------------------------------------------------------------------------- | :------- | :---------- |
| document_id | str | ❌ | |
| page | float | ❌ | |
| x | float | ❌ | |
| y | float | ❌ | |
| width | float | ❌ | |
| height | float | ❌ | |
| type\_ | str | ❌ | |
| recipient_id | str | ❌ | |
| required | bool | ❌ | |
| signature | [AddEnvelopeAnnotationRequestSignature](AddEnvelopeAnnotationRequestSignature.md) | ❌ | |
| initials | [AddEnvelopeAnnotationRequestInitials](AddEnvelopeAnnotationRequestInitials.md) | ❌ | |
| text | [AddEnvelopeAnnotationRequestText](AddEnvelopeAnnotationRequestText.md) | ❌ | |
| datetime\_ | [AddEnvelopeAnnotationRequestDatetime](AddEnvelopeAnnotationRequestDatetime.md) | ❌ | |
| checkbox | [AddEnvelopeAnnotationRequestCheckbox](AddEnvelopeAnnotationRequestCheckbox.md) | ❌ | |
8 changes: 8 additions & 0 deletions documentation/models/AddEnvelopeAnnotationRequestCheckbox.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
# AddEnvelopeAnnotationRequestCheckbox

**Properties**

| Name | Type | Required | Description |
| :------ | :--- | :------- | :---------- |
| checked | bool | ❌ | |
| style | str | ❌ | |
13 changes: 13 additions & 0 deletions documentation/models/AddEnvelopeAnnotationRequestDatetime.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
# AddEnvelopeAnnotationRequestDatetime

**Properties**

| Name | Type | Required | Description |
| :-------- | :-------------------------------- | :------- | :---------- |
| size | float | ❌ | |
| font | [DatetimeFont1](DatetimeFont1.md) | ❌ | |
| color | str | ❌ | |
| auto_fill | bool | ❌ | |
| timezone | str | ❌ | |
| timestamp | float | ❌ | |
| format | str | ❌ | |
7 changes: 7 additions & 0 deletions documentation/models/AddEnvelopeAnnotationRequestInitials.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
# AddEnvelopeAnnotationRequestInitials

**Properties**

| Name | Type | Required | Description |
| :--- | :--- | :------- | :---------- |
| id\_ | str | ❌ | |
7 changes: 7 additions & 0 deletions documentation/models/AddEnvelopeAnnotationRequestSignature.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
# AddEnvelopeAnnotationRequestSignature

**Properties**

| Name | Type | Required | Description |
| :--- | :--- | :------- | :---------- |
| id\_ | str | ❌ | |
12 changes: 12 additions & 0 deletions documentation/models/AddEnvelopeAnnotationRequestText.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
# AddEnvelopeAnnotationRequestText

**Properties**

| Name | Type | Required | Description |
| :----------------- | :------------------------ | :------- | :---------- |
| size | float | ❌ | |
| color | float | ❌ | |
| value | str | ❌ | |
| tooltip | str | ❌ | |
| dynamic_field_name | str | ❌ | |
| font | [TextFont1](TextFont1.md) | ❌ | |
6 changes: 3 additions & 3 deletions documentation/models/AddEnvelopeDocumentRequest.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,6 @@

**Properties**

| Name | Type | Required | Description |
| :--- | :---- | :------- | :------------------------------ |
| file | bytes | ❌ | File to upload in binary format |
| Name | Type | Required | Description |
| :--- | :---- | :------- | :---------- |
| file | bytes | ❌ | |
6 changes: 3 additions & 3 deletions documentation/models/AddEnvelopeSigningStepsRequest.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,6 @@

**Properties**

| Name | Type | Required | Description |
| :------------ | :---------------- | :------- | :-------------------- |
| signing_steps | List[SigningStep] | ❌ | List of signing steps |
| Name | Type | Required | Description |
| :------------ | :------------------------------------------------------------------------------------------------ | :------- | :---------- |
| signing_steps | List[[AddEnvelopeSigningStepsRequestSigningSteps](AddEnvelopeSigningStepsRequestSigningSteps.md)] | ❌ | |
7 changes: 7 additions & 0 deletions documentation/models/AddEnvelopeSigningStepsRequestSigningSteps.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
# AddEnvelopeSigningStepsRequestSigningSteps

**Properties**

| Name | Type | Required | Description |
| :--------- | :---------------------------------------------------------- | :------- | :---------- |
| recipients | List[[SigningStepsRecipients1](SigningStepsRecipients1.md)] | ❌ | |
20 changes: 20 additions & 0 deletions documentation/models/AddTemplateAnnotationRequest.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
# AddTemplateAnnotationRequest

**Properties**

| Name | Type | Required | Description |
| :----------- | :-------------------------------------------------------------------------------- | :------- | :---------- |
| document_id | str | ❌ | |
| page | float | ❌ | |
| x | float | ❌ | |
| y | float | ❌ | |
| width | float | ❌ | |
| height | float | ❌ | |
| type\_ | str | ❌ | |
| recipient_id | str | ❌ | |
| required | bool | ❌ | |
| signature | [AddTemplateAnnotationRequestSignature](AddTemplateAnnotationRequestSignature.md) | ❌ | |
| initials | [AddTemplateAnnotationRequestInitials](AddTemplateAnnotationRequestInitials.md) | ❌ | |
| text | [AddTemplateAnnotationRequestText](AddTemplateAnnotationRequestText.md) | ❌ | |
| datetime\_ | [AddTemplateAnnotationRequestDatetime](AddTemplateAnnotationRequestDatetime.md) | ❌ | |
| checkbox | [AddTemplateAnnotationRequestCheckbox](AddTemplateAnnotationRequestCheckbox.md) | ❌ | |
8 changes: 8 additions & 0 deletions documentation/models/AddTemplateAnnotationRequestCheckbox.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
# AddTemplateAnnotationRequestCheckbox

**Properties**

| Name | Type | Required | Description |
| :------ | :--- | :------- | :---------- |
| checked | bool | ❌ | |
| style | str | ❌ | |
13 changes: 13 additions & 0 deletions documentation/models/AddTemplateAnnotationRequestDatetime.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
# AddTemplateAnnotationRequestDatetime

**Properties**

| Name | Type | Required | Description |
| :-------- | :-------------------------------- | :------- | :---------- |
| size | float | ❌ | |
| font | [DatetimeFont2](DatetimeFont2.md) | ❌ | |
| color | str | ❌ | |
| auto_fill | bool | ❌ | |
| timezone | str | ❌ | |
| timestamp | float | ❌ | |
| format | str | ❌ | |
7 changes: 7 additions & 0 deletions documentation/models/AddTemplateAnnotationRequestInitials.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
# AddTemplateAnnotationRequestInitials

**Properties**

| Name | Type | Required | Description |
| :--- | :--- | :------- | :---------- |
| id\_ | str | ❌ | |
7 changes: 7 additions & 0 deletions documentation/models/AddTemplateAnnotationRequestSignature.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
# AddTemplateAnnotationRequestSignature

**Properties**

| Name | Type | Required | Description |
| :--- | :--- | :------- | :---------- |
| id\_ | str | ❌ | |
12 changes: 12 additions & 0 deletions documentation/models/AddTemplateAnnotationRequestText.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
# AddTemplateAnnotationRequestText

**Properties**

| Name | Type | Required | Description |
| :----------------- | :------------------------ | :------- | :---------- |
| size | float | ❌ | |
| color | float | ❌ | |
| value | str | ❌ | |
| tooltip | str | ❌ | |
| dynamic_field_name | str | ❌ | |
| font | [TextFont2](TextFont2.md) | ❌ | |
6 changes: 3 additions & 3 deletions documentation/models/AddTemplateDocumentRequest.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,6 @@

**Properties**

| Name | Type | Required | Description |
| :--- | :---- | :------- | :------------------------------ |
| file | bytes | ✅ | File to upload in binary format |
| Name | Type | Required | Description |
| :--- | :---- | :------- | :---------- |
| file | bytes | ❌ | |
6 changes: 3 additions & 3 deletions documentation/models/AddTemplateSigningStepsRequest.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,6 @@

**Properties**

| Name | Type | Required | Description |
| :------------ | :------------------------ | :------- | :-------------------- |
| signing_steps | List[TemplateSigningStep] | ✅ | List of signing steps |
| Name | Type | Required | Description |
| :------------ | :------------------------------------------------------------------------------------------------ | :------- | :---------- |
| signing_steps | List[[AddTemplateSigningStepsRequestSigningSteps](AddTemplateSigningStepsRequestSigningSteps.md)] | ❌ | |
7 changes: 7 additions & 0 deletions documentation/models/AddTemplateSigningStepsRequestSigningSteps.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
# AddTemplateSigningStepsRequestSigningSteps

**Properties**

| Name | Type | Required | Description |
| :--------- | :---------------------------------------------------------- | :------- | :---------- |
| recipients | List[[SigningStepsRecipients2](SigningStepsRecipients2.md)] | ❌ | |
10 changes: 5 additions & 5 deletions documentation/models/CreateEnvelopeFromTemplateRequest.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,8 @@

**Properties**

| Name | Type | Required | Description |
| :------ | :--- | :------- | :---------------------------------------------- |
| name | str | ✅ | Name of the envelope |
| comment | str | ❌ | Comment for the envelope |
| sandbox | bool | ❌ | Whether the envelope is created in sandbox mode |
| Name | Type | Required | Description |
| :------ | :--- | :------- | :---------- |
| name | str | ❌ | |
| comment | str | ❌ | |
| sandbox | bool | ❌ | |
14 changes: 7 additions & 7 deletions documentation/models/CreateEnvelopeRequest.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,10 @@

**Properties**

| Name | Type | Required | Description |
| :------------- | :-------------------- | :------- | :---------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| name | str | ✅ | Name of the envelope |
| legality_level | EnvelopeLegalityLevel | ✅ | Legal level of the envelope (SES is Simple Electronic Signature, QES_EIDAS is Qualified Electronic Signature, QES_ZERTES is Qualified Electronic Signature with Zertes) |
| expires_at | int | ❌ | Unix timestamp of the expiration date |
| comment | str | ❌ | Comment for the envelope |
| sandbox | bool | ❌ | Whether the envelope is created in sandbox mode |
| Name | Type | Required | Description |
| :------------- | :---- | :------- | :---------- |
| name | str | ❌ | |
| legality_level | str | ❌ | |
| expires_at | float | ❌ | |
| comment | str | ❌ | |
| sandbox | bool | ❌ | |
2 changes: 1 addition & 1 deletion documentation/models/CreateTemplateRequest.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,4 +4,4 @@

| Name | Type | Required | Description |
| :--- | :--- | :------- | :---------- |
| name | str | ✅ | |
| name | str | ❌ | |
8 changes: 4 additions & 4 deletions documentation/models/CreateWebhookRequest.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

**Properties**

| Name | Type | Required | Description |
| :----- | :----------- | :------- | :------------------------ |
| event | WebhookEvent | ✅ | Event of the webhook |
| target | str | ✅ | URL of the webhook target |
| Name | Type | Required | Description |
| :----- | :--- | :------- | :---------- |
| event | str | ❌ | |
| target | str | ❌ | |
9 changes: 9 additions & 0 deletions documentation/models/DatetimeFont1.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
# DatetimeFont_1

**Properties**

| Name | Type | Required | Description |
| :----- | :--- | :------- | :---------- |
| family | str | ❌ | |
| italic | bool | ❌ | |
| bold | bool | ❌ | |
9 changes: 9 additions & 0 deletions documentation/models/DatetimeFont2.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
# DatetimeFont_2

**Properties**

| Name | Type | Required | Description |
| :----- | :--- | :------- | :---------- |
| family | str | ❌ | |
| italic | bool | ❌ | |
| bold | bool | ❌ | |
8 changes: 8 additions & 0 deletions documentation/models/DynamicFields.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
# DynamicFields

**Properties**

| Name | Type | Required | Description |
| :---- | :--- | :------- | :---------- |
| name | str | ❌ | |
| value | str | ❌ | |
38 changes: 19 additions & 19 deletions documentation/models/ListEnvelopesRequest.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,22 +2,22 @@

**Properties**

| Name | Type | Required | Description |
| :--------------- | :------------------- | :------- | :------------------------------------------------ |
| name | str | ❌ | Name of the envelope |
| tags | List[str] | ❌ | List of tags |
| comment | str | ❌ | Comment of the envelope |
| ids | List[str] | ❌ | List of envelope IDs |
| statuses | List[EnvelopeStatus] | ❌ | List of envelope statuses |
| folder_ids | List[str] | ❌ | List of folder IDs |
| only_root_folder | bool | ❌ | Whether to only list envelopes in the root folder |
| date_from | int | ❌ | Unix timestamp of the start date |
| date_to | int | ❌ | Unix timestamp of the end date |
| uid | str | ❌ | Unique identifier of the user |
| first | int | ❌ | |
| last | int | ❌ | |
| after | str | ❌ | |
| before | str | ❌ | |
| order_field | EnvelopeOrderField | ❌ | Field to order envelopes by |
| ascending | bool | ❌ | Whether to order envelopes in ascending order |
| include_trash | bool | ❌ | Whether to include envelopes in the trash |
| Name | Type | Required | Description |
| :--------------- | :-------- | :------- | :---------- |
| name | str | ❌ | |
| tags | List[str] | ❌ | |
| comment | str | ❌ | |
| ids | List[str] | ❌ | |
| statuses | List[str] | ❌ | |
| folder_ids | List[str] | ❌ | |
| only_root_folder | bool | ❌ | |
| date_from | float | ❌ | |
| date_to | float | ❌ | |
| uid | str | ❌ | |
| first | float | ❌ | |
| last | float | ❌ | |
| after | str | ❌ | |
| before | str | ❌ | |
| order_field | str | ❌ | |
| ascending | bool | ❌ | |
| include_trash | bool | ❌ | |
Loading