Skip to content

SDK Updates: v3.1.0 #32

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
postman wants to merge 1 commit into
base: sdk-update-v3.0.0-1777629905337
Choose a base branch
from
Open

SDK Updates: v3.1.0 #32

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
676 changes: 476 additions & 200 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
18 changes: 11 additions & 7 deletions PyPI_README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,13 +1,11 @@
# Signplus Python SDK 1.4.0<a id="signplus-python-sdk-140"></a>
# Signplus Python SDK 3.1.0<a id="signplus-python-sdk-310"></a>

Welcome to the Signplus SDK documentation. This guide will help you get started with integrating and using the Signplus SDK in your project.

[![This SDK was generated by liblab](https://raw.githubusercontent.com/liblaber/liblab-assets/main/assets/built-by-liblab-icon.svg)](https://liblab.com/?utm_source=readme)

## Versions<a id="versions"></a>

- API version: `2.5.0`
- SDK version: `1.4.0`
- SDK version: `3.1.0`

## About the API<a id="about-the-api"></a>

Expand All @@ -26,20 +24,26 @@ Integrate legally-binding electronic signature to your workflow
- [Models](#models)
- [License](#license)

## Setup & Configuration<a id="setup--configuration"></a>
# Setup & Configuration<a id="setup--configuration"></a>

### Supported Language Versions<a id="supported-language-versions"></a>
## Supported Language Versions<a id="supported-language-versions"></a>

This SDK is compatible with the following versions: `Python >= 3.7`

### Installation<a id="installation"></a>
## Installation<a id="installation"></a>

To get started with the SDK, we recommend installing using `pip`:

```bash
pip install signplus-python
```

If you are using Python 3, you can use `pip3` instead:

```bash
pip3 install signplus-python
```

## Authentication<a id="authentication"></a>

### Access Token Authentication<a id="access-token-authentication"></a>
Expand Down
18 changes: 11 additions & 7 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,13 +1,11 @@
# Signplus Python SDK 1.4.0
# Signplus Python SDK 3.1.0

Welcome to the Signplus SDK documentation. This guide will help you get started with integrating and using the Signplus SDK in your project.

[![This SDK was generated by liblab](https://raw.githubusercontent.com/liblaber/liblab-assets/main/assets/built-by-liblab-icon.svg)](https://liblab.com/?utm_source=readme)

## Versions

- API version: `2.5.0`
- SDK version: `1.4.0`
- SDK version: `3.1.0`

## About the API

Expand All @@ -27,20 +25,26 @@ Integrate legally-binding electronic signature to your workflow
- [Models](#models)
- [License](#license)

## Setup & Configuration
# Setup & Configuration

### Supported Language Versions
## Supported Language Versions

This SDK is compatible with the following versions: `Python >= 3.7`

### Installation
## Installation

To get started with the SDK, we recommend installing using `pip`:

```bash
pip install signplus-python
```

If you are using Python 3, you can use `pip3` instead:

```bash
pip3 install signplus-python
```

## Authentication

### Access Token Authentication
Expand Down
32 changes: 16 additions & 16 deletions documentation/models/AddAnnotationRequest.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,19 +2,19 @@

**Properties**

| Name | Type | Required | Description |
| :----------- | :------------------ | :------- | :---------------------------------------------------------------------------------------------- |
| document_id | str | ✅ | ID of the document |
| page | int | ✅ | Page number where the annotation is placed |
| x | float | ✅ | X coordinate of the annotation (in % of the page width from 0 to 100) from the top left corner |
| y | float | ✅ | Y coordinate of the annotation (in % of the page height from 0 to 100) from the top left corner |
| width | float | ✅ | Width of the annotation (in % of the page width from 0 to 100) |
| height | float | ✅ | Height of the annotation (in % of the page height from 0 to 100) |
| type\_ | AnnotationType | ✅ | Type of the annotation |
| recipient_id | str | ❌ | ID of the recipient |
| required | bool | ❌ | |
| signature | AnnotationSignature | ❌ | Signature annotation (null if annotation is not a signature) |
| initials | AnnotationInitials | ❌ | Initials annotation (null if annotation is not initials) |
| text | AnnotationText | ❌ | Text annotation (null if annotation is not a text) |
| datetime\_ | AnnotationDateTime | ❌ | Date annotation (null if annotation is not a date) |
| checkbox | AnnotationCheckbox | ❌ | Checkbox annotation (null if annotation is not a checkbox) |
| Name | Type | Required | Description |
| :----------- | :-------------------------------------------- | :------- | :---------------------------------------------------------------------------------------------- |
| document_id | str | ✅ | ID of the document |
| page | int | ✅ | Page number where the annotation is placed |
| x | float | ✅ | X coordinate of the annotation (in % of the page width from 0 to 100) from the top left corner |
| y | float | ✅ | Y coordinate of the annotation (in % of the page height from 0 to 100) from the top left corner |
| width | float | ✅ | Width of the annotation (in % of the page width from 0 to 100) |
| height | float | ✅ | Height of the annotation (in % of the page height from 0 to 100) |
| type\_ | [AnnotationType](AnnotationType.md) | ✅ | Type of the annotation |
| recipient_id | str | ❌ | ID of the recipient |
| required | bool | ❌ | |
| signature | [AnnotationSignature](AnnotationSignature.md) | ❌ | Signature annotation (null if annotation is not a signature) |
| initials | [AnnotationInitials](AnnotationInitials.md) | ❌ | Initials annotation (null if annotation is not initials) |
| text | [AnnotationText](AnnotationText.md) | ❌ | Text annotation (null if annotation is not a text) |
| datetime\_ | [AnnotationDateTime](AnnotationDateTime.md) | ❌ | Date annotation (null if annotation is not a date) |
| checkbox | [AnnotationCheckbox](AnnotationCheckbox.md) | ❌ | Checkbox annotation (null if annotation is not a checkbox) |
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[[SigningStep](SigningStep.md)] | ❌ | List of signing steps |
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[[TemplateSigningStep](TemplateSigningStep.md)] | ✅ | List of signing steps |
34 changes: 17 additions & 17 deletions documentation/models/Annotation.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,20 +2,20 @@

**Properties**

| Name | Type | Required | Description |
| :----------- | :------------------ | :------- | :---------------------------------------------------------------------------------------------- |
| id\_ | str | ❌ | Unique identifier of the annotation |
| recipient_id | str | ❌ | ID of the recipient |
| document_id | str | ❌ | ID of the document |
| page | int | ❌ | Page number where the annotation is placed |
| x | float | ❌ | X coordinate of the annotation (in % of the page width from 0 to 100) from the top left corner |
| y | float | ❌ | Y coordinate of the annotation (in % of the page height from 0 to 100) from the top left corner |
| width | float | ❌ | Width of the annotation (in % of the page width from 0 to 100) |
| height | float | ❌ | Height of the annotation (in % of the page height from 0 to 100) |
| required | bool | ❌ | Whether the annotation is required |
| type\_ | AnnotationType | ❌ | Type of the annotation |
| signature | AnnotationSignature | ❌ | Signature annotation (null if annotation is not a signature) |
| initials | AnnotationInitials | ❌ | Initials annotation (null if annotation is not initials) |
| text | AnnotationText | ❌ | Text annotation (null if annotation is not a text) |
| datetime\_ | AnnotationDateTime | ❌ | Date annotation (null if annotation is not a date) |
| checkbox | AnnotationCheckbox | ❌ | Checkbox annotation (null if annotation is not a checkbox) |
| Name | Type | Required | Description |
| :----------- | :-------------------------------------------- | :------- | :---------------------------------------------------------------------------------------------- |
| id\_ | str | ❌ | Unique identifier of the annotation |
| recipient_id | str | ❌ | ID of the recipient |
| document_id | str | ❌ | ID of the document |
| page | int | ❌ | Page number where the annotation is placed |
| x | float | ❌ | X coordinate of the annotation (in % of the page width from 0 to 100) from the top left corner |
| y | float | ❌ | Y coordinate of the annotation (in % of the page height from 0 to 100) from the top left corner |
| width | float | ❌ | Width of the annotation (in % of the page width from 0 to 100) |
| height | float | ❌ | Height of the annotation (in % of the page height from 0 to 100) |
| required | bool | ❌ | Whether the annotation is required |
| type\_ | [AnnotationType](AnnotationType.md) | ❌ | Type of the annotation |
| signature | [AnnotationSignature](AnnotationSignature.md) | ❌ | Signature annotation (null if annotation is not a signature) |
| initials | [AnnotationInitials](AnnotationInitials.md) | ❌ | Initials annotation (null if annotation is not initials) |
| text | [AnnotationText](AnnotationText.md) | ❌ | Text annotation (null if annotation is not a text) |
| datetime\_ | [AnnotationDateTime](AnnotationDateTime.md) | ❌ | Date annotation (null if annotation is not a date) |
| checkbox | [AnnotationCheckbox](AnnotationCheckbox.md) | ❌ | Checkbox annotation (null if annotation is not a checkbox) |
8 changes: 4 additions & 4 deletions documentation/models/AnnotationCheckbox.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ Checkbox annotation (null if annotation is not a checkbox)

**Properties**

| Name | Type | Required | Description |
| :------ | :---------------------- | :------- | :------------------------------ |
| checked | bool | ❌ | Whether the checkbox is checked |
| style | AnnotationCheckboxStyle | ❌ | Style of the checkbox |
| Name | Type | Required | Description |
| :------ | :---------------------------------------------------- | :------- | :------------------------------ |
| checked | bool | ❌ | Whether the checkbox is checked |
| style | [AnnotationCheckboxStyle](AnnotationCheckboxStyle.md) | ❌ | Style of the checkbox |
Loading