Skip to content

Commit 5afc7c8

Browse files
committed
Updated on 2021-11-28 11:33:20. Version: 1.3.2
0 parents  commit 5afc7c8

File tree

178 files changed

+26113
-0
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

178 files changed

+26113
-0
lines changed

.gitignore

Lines changed: 69 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,69 @@
1+
# Byte-compiled / optimized / DLL files
2+
__pycache__/
3+
*.py[cod]
4+
*$py.class
5+
6+
# C extensions
7+
*.so
8+
9+
# Distribution / packaging
10+
.Python
11+
env/
12+
build/
13+
develop-eggs/
14+
dist/
15+
downloads/
16+
eggs/
17+
.eggs/
18+
lib/
19+
lib64/
20+
parts/
21+
sdist/
22+
var/
23+
*.egg-info/
24+
.installed.cfg
25+
*.egg
26+
27+
# PyInstaller
28+
# Usually these files are written by a python script from a template
29+
# before PyInstaller builds the exe, so as to inject date/other infos into it.
30+
*.manifest
31+
*.spec
32+
33+
# Installer logs
34+
pip-log.txt
35+
pip-delete-this-directory.txt
36+
37+
# Unit test / coverage reports
38+
htmlcov/
39+
.tox/
40+
.coverage
41+
.coverage.*
42+
.cache
43+
nosetests.xml
44+
coverage.xml
45+
*,cover
46+
.hypothesis/
47+
venv/
48+
.python-version
49+
50+
# Translations
51+
*.mo
52+
*.pot
53+
54+
# Django stuff:
55+
*.log
56+
57+
# Sphinx documentation
58+
docs/_build/
59+
60+
# PyBuilder
61+
target/
62+
63+
#Ipython Notebook
64+
.ipynb_checkpoints
65+
66+
# Custom
67+
test/venv-2/
68+
test/venv-3/
69+
.pytest_cache

.openapi-generator-ignore

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
# OpenAPI Generator Ignore
2+
# Generated by openapi-generator https://github.com/openapitools/openapi-generator
3+
4+
# Use this file to prevent files from being overwritten by the generator.
5+
# The patterns follow closely to .gitignore or .dockerignore.
6+
7+
# As an example, the C# client generator defines ApiClient.cs.
8+
# You can make changes and tell OpenAPI Generator to ignore just this file by uncommenting the following line:
9+
#ApiClient.cs
10+
11+
# You can match any string of characters against a directory, file or extension with a single asterisk (*):
12+
#foo/*/qux
13+
# The above matches foo/bar/qux and foo/baz/qux, but not foo/bar/baz/qux
14+
15+
# You can recursively match patterns against a directory, file or extension with a double asterisk (**):
16+
#foo/**/qux
17+
# This matches foo/bar/qux, foo/baz/qux, and foo/bar/baz/qux
18+
19+
# You can also negate patterns with an exclamation (!).
20+
# For example, you can ignore all files in a docs folder with the file extension .md:
21+
#docs/*.md
22+
# Then explicitly reverse the ignore rule for a single file:
23+
#!docs/README.md

.openapi-generator/VERSION

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
3.3.0

.travis.yml

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
# ref: https://docs.travis-ci.com/user/languages/python
2+
language: python
3+
python:
4+
- "2.7"
5+
- "3.2"
6+
- "3.3"
7+
- "3.4"
8+
- "3.5"
9+
#- "3.5-dev" # 3.5 development branch
10+
#- "nightly" # points to the latest development branch e.g. 3.6-dev
11+
# command to install dependencies
12+
install: "pip install -r requirements.txt"
13+
# command to run tests
14+
script: nosetests

CHANGELOG.md

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
### 1.3.2 [November 28, 2021]
2+
3+
- Added 'password' parameter to Generate PDF and Combine PDF API endpoints. You can now encrypt each generated PDF with a unique password.
4+
5+
### 1.3.1 [November 19, 2020]
6+
7+
- Added "sort_order" property for Submission Data Requests
8+
9+
### 1.3.0 [September 26, 2020]
10+
11+
- Updated OpenAPI Generator to v3.3.0
12+
13+
### 1.2.1 [September 24, 2020]
14+
15+
- Fixed the "include_data=true" option for the "Get Submission" API endpoint. Added the "data" property to the Submission model so that this is parsed and returned correctly when requested
16+
17+
### 1.2.0 [September 21, 2020]
18+
19+
- Renamed some internal models for template creation API endpoints. (CreateTemplateData / CreateTemplateData1 renamed to CreateHtmlTemplateData and CreateTemplateFromUploadData)
20+
21+
### 1.1.0 [September 12, 2020]
22+
23+
- **BREAKING CHANGE**: Renamed createTemplate operation to createPDFTemplate
24+
- Added createHTMLTemplate operation. (This uses the same API endpoint as createPDFTemplate, but the example shows how to set html, scss, etc. fields)
25+
- Added updateTemplate operation, to update a PDF or HTML template
26+
27+
### 1.0.0 [May 20, 2019]
28+
29+
- Renamed FormAPI to DocSpring. (View the CHANGELOG in the original FormAPI API client for prior releases.)

LICENSE

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
Copyright © 2018-2020 DocSpring, Inc.
2+
3+
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
4+
5+
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
6+
7+
THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

README.md

Lines changed: 182 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,182 @@
1+
# docspring
2+
DocSpring is a service that helps you fill out and sign PDF templates.
3+
4+
This Python package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
5+
6+
- API version: v1
7+
- Package version: 1.3.2
8+
- Build package: com.docspring.codegen.DocSpringPythonClientCodegen
9+
10+
## Requirements.
11+
12+
Python 2.7 and 3.4+
13+
14+
## Installation & Usage
15+
### pip install
16+
17+
If the python package is hosted on Github, you can install directly from Github
18+
19+
```sh
20+
pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git
21+
```
22+
(you may need to run `pip` with root permission: `sudo pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git`)
23+
24+
Then import the package:
25+
```python
26+
import docspring
27+
```
28+
29+
### Setuptools
30+
31+
Install via [Setuptools](http://pypi.python.org/pypi/setuptools).
32+
33+
```sh
34+
python setup.py install --user
35+
```
36+
(or `sudo python setup.py install` to install the package for all users)
37+
38+
Then import the package:
39+
```python
40+
import docspring
41+
```
42+
43+
## Getting Started
44+
45+
Please follow the [installation procedure](#installation--usage) and then run the following:
46+
47+
```python
48+
from __future__ import print_function
49+
import time
50+
import docspring
51+
from docspring.rest import ApiException
52+
from pprint import pprint
53+
54+
# Configure HTTP basic authorization: api_token_basic
55+
configuration = docspring.Configuration()
56+
configuration.username = 'YOUR_USERNAME'
57+
configuration.password = 'YOUR_PASSWORD'
58+
59+
# create an instance of the API class
60+
api_instance = docspring.PDFApi(docspring.ApiClient(configuration))
61+
template_id = 'tpl_000000000000000002' # str |
62+
add_fields_data = docspring.AddFieldsData() # AddFieldsData |
63+
64+
try:
65+
# Add new fields to a Template
66+
api_response = api_instance.add_fields_to_template(template_id, add_fields_data)
67+
pprint(api_response)
68+
except ApiException as e:
69+
print("Exception when calling PDFApi->add_fields_to_template: %s\n" % e)
70+
71+
```
72+
73+
## Documentation for API Endpoints
74+
75+
All URIs are relative to *https://api.docspring.com/api/v1*
76+
77+
Class | Method | HTTP request | Description
78+
------------ | ------------- | ------------- | -------------
79+
*PDFApi* | [**add_fields_to_template**](docs/PDFApi.md#add_fields_to_template) | **PUT** /templates/{template_id}/add_fields | Add new fields to a Template
80+
*PDFApi* | [**batch_generate_pdf_v1**](docs/PDFApi.md#batch_generate_pdf_v1) | **POST** /templates/{template_id}/submissions/batch | Generates multiple PDFs
81+
*PDFApi* | [**batch_generate_pdfs**](docs/PDFApi.md#batch_generate_pdfs) | **POST** /submissions/batches | Generates multiple PDFs
82+
*PDFApi* | [**combine_pdfs**](docs/PDFApi.md#combine_pdfs) | **POST** /combined_submissions?v=2 | Merge submission PDFs, template PDFs, or custom files
83+
*PDFApi* | [**combine_submissions**](docs/PDFApi.md#combine_submissions) | **POST** /combined_submissions | Merge generated PDFs together
84+
*PDFApi* | [**copy_template**](docs/PDFApi.md#copy_template) | **POST** /templates/{template_id}/copy | Copy a Template
85+
*PDFApi* | [**create_custom_file_from_upload**](docs/PDFApi.md#create_custom_file_from_upload) | **POST** /custom_files | Create a new custom file from a cached presign upload
86+
*PDFApi* | [**create_data_request_token**](docs/PDFApi.md#create_data_request_token) | **POST** /data_requests/{data_request_id}/tokens | Creates a new data request token for form authentication
87+
*PDFApi* | [**create_folder**](docs/PDFApi.md#create_folder) | **POST** /folders/ | Create a folder
88+
*PDFApi* | [**create_html_template**](docs/PDFApi.md#create_html_template) | **POST** /templates?desc=html | Create a new HTML template
89+
*PDFApi* | [**create_pdf_template**](docs/PDFApi.md#create_pdf_template) | **POST** /templates | Create a new PDF template with a form POST file upload
90+
*PDFApi* | [**create_pdf_template_from_upload**](docs/PDFApi.md#create_pdf_template_from_upload) | **POST** /templates?desc=cached_upload | Create a new PDF template from a cached presign upload
91+
*PDFApi* | [**delete_folder**](docs/PDFApi.md#delete_folder) | **DELETE** /folders/{folder_id} | Delete a folder
92+
*PDFApi* | [**expire_combined_submission**](docs/PDFApi.md#expire_combined_submission) | **DELETE** /combined_submissions/{combined_submission_id} | Expire a combined submission
93+
*PDFApi* | [**expire_submission**](docs/PDFApi.md#expire_submission) | **DELETE** /submissions/{submission_id} | Expire a PDF submission
94+
*PDFApi* | [**generate_pdf**](docs/PDFApi.md#generate_pdf) | **POST** /templates/{template_id}/submissions | Generates a new PDF
95+
*PDFApi* | [**get_combined_submission**](docs/PDFApi.md#get_combined_submission) | **GET** /combined_submissions/{combined_submission_id} | Check the status of a combined submission (merged PDFs)
96+
*PDFApi* | [**get_data_request**](docs/PDFApi.md#get_data_request) | **GET** /data_requests/{data_request_id} | Look up a submission data request
97+
*PDFApi* | [**get_full_template**](docs/PDFApi.md#get_full_template) | **GET** /templates/{template_id}?full=true | Fetch the full template attributes
98+
*PDFApi* | [**get_presign_url**](docs/PDFApi.md#get_presign_url) | **GET** /uploads/presign | Get a presigned URL so that you can upload a file to our AWS S3 bucket
99+
*PDFApi* | [**get_submission**](docs/PDFApi.md#get_submission) | **GET** /submissions/{submission_id} | Check the status of a PDF
100+
*PDFApi* | [**get_submission_batch**](docs/PDFApi.md#get_submission_batch) | **GET** /submissions/batches/{submission_batch_id} | Check the status of a submission batch job
101+
*PDFApi* | [**get_template**](docs/PDFApi.md#get_template) | **GET** /templates/{template_id} | Check the status of an uploaded template
102+
*PDFApi* | [**get_template_schema**](docs/PDFApi.md#get_template_schema) | **GET** /templates/{template_id}/schema | Fetch the JSON schema for a template
103+
*PDFApi* | [**list_folders**](docs/PDFApi.md#list_folders) | **GET** /folders/ | Get a list of all folders
104+
*PDFApi* | [**list_submissions**](docs/PDFApi.md#list_submissions) | **GET** /submissions | List all submissions
105+
*PDFApi* | [**list_submissions_0**](docs/PDFApi.md#list_submissions_0) | **GET** /templates/{template_id}/submissions | List all submissions for a given template
106+
*PDFApi* | [**list_templates**](docs/PDFApi.md#list_templates) | **GET** /templates | Get a list of all templates
107+
*PDFApi* | [**move_folder_to_folder**](docs/PDFApi.md#move_folder_to_folder) | **POST** /folders/{folder_id}/move | Move a folder
108+
*PDFApi* | [**move_template_to_folder**](docs/PDFApi.md#move_template_to_folder) | **POST** /templates/{template_id}/move | Move Template to folder
109+
*PDFApi* | [**rename_folder**](docs/PDFApi.md#rename_folder) | **POST** /folders/{folder_id}/rename | Rename a folder
110+
*PDFApi* | [**test_authentication**](docs/PDFApi.md#test_authentication) | **GET** /authentication | Test Authentication
111+
*PDFApi* | [**update_data_request**](docs/PDFApi.md#update_data_request) | **PUT** /data_requests/{data_request_id} | Update a submission data request
112+
*PDFApi* | [**update_template**](docs/PDFApi.md#update_template) | **PUT** /templates/{template_id} | Update a Template
113+
114+
115+
## Documentation For Models
116+
117+
- [AddFieldsData](docs/AddFieldsData.md)
118+
- [AddFieldsTemplateResponse](docs/AddFieldsTemplateResponse.md)
119+
- [AuthenticationError](docs/AuthenticationError.md)
120+
- [AuthenticationSuccessResponse](docs/AuthenticationSuccessResponse.md)
121+
- [CombinePdfsData](docs/CombinePdfsData.md)
122+
- [CombinedSubmission](docs/CombinedSubmission.md)
123+
- [CombinedSubmissionAction](docs/CombinedSubmissionAction.md)
124+
- [CombinedSubmissionData](docs/CombinedSubmissionData.md)
125+
- [CopyTemplateData](docs/CopyTemplateData.md)
126+
- [CreateCombinedSubmissionResponse](docs/CreateCombinedSubmissionResponse.md)
127+
- [CreateCustomFileData](docs/CreateCustomFileData.md)
128+
- [CreateCustomFileResponse](docs/CreateCustomFileResponse.md)
129+
- [CreateFolderData](docs/CreateFolderData.md)
130+
- [CreateHtmlTemplateData](docs/CreateHtmlTemplateData.md)
131+
- [CreateSubmissionBatchResponse](docs/CreateSubmissionBatchResponse.md)
132+
- [CreateSubmissionBatchSubmissionsResponse](docs/CreateSubmissionBatchSubmissionsResponse.md)
133+
- [CreateSubmissionDataRequestData](docs/CreateSubmissionDataRequestData.md)
134+
- [CreateSubmissionDataRequestTokenResponse](docs/CreateSubmissionDataRequestTokenResponse.md)
135+
- [CreateSubmissionDataRequestTokenResponseToken](docs/CreateSubmissionDataRequestTokenResponseToken.md)
136+
- [CreateSubmissionResponse](docs/CreateSubmissionResponse.md)
137+
- [CreateTemplateFromUploadData](docs/CreateTemplateFromUploadData.md)
138+
- [CustomFile](docs/CustomFile.md)
139+
- [Error](docs/Error.md)
140+
- [Folder](docs/Folder.md)
141+
- [FoldersFolder](docs/FoldersFolder.md)
142+
- [HtmlTemplateData](docs/HtmlTemplateData.md)
143+
- [InvalidRequest](docs/InvalidRequest.md)
144+
- [ListSubmissionsResponse](docs/ListSubmissionsResponse.md)
145+
- [MoveFolderData](docs/MoveFolderData.md)
146+
- [MoveTemplateData](docs/MoveTemplateData.md)
147+
- [PendingTemplate](docs/PendingTemplate.md)
148+
- [RenameFolderData](docs/RenameFolderData.md)
149+
- [Submission](docs/Submission.md)
150+
- [SubmissionAction](docs/SubmissionAction.md)
151+
- [SubmissionBatch](docs/SubmissionBatch.md)
152+
- [SubmissionBatchData](docs/SubmissionBatchData.md)
153+
- [SubmissionData](docs/SubmissionData.md)
154+
- [SubmissionDataBatchRequest](docs/SubmissionDataBatchRequest.md)
155+
- [SubmissionDataRequest](docs/SubmissionDataRequest.md)
156+
- [Template](docs/Template.md)
157+
- [Template1](docs/Template1.md)
158+
- [Template1Defaults](docs/Template1Defaults.md)
159+
- [TemplateData](docs/TemplateData.md)
160+
- [TemplatestemplateIdaddFieldsFields](docs/TemplatestemplateIdaddFieldsFields.md)
161+
- [UpdateDataRequestResponse](docs/UpdateDataRequestResponse.md)
162+
- [UpdateSubmissionDataRequestData](docs/UpdateSubmissionDataRequestData.md)
163+
- [UpdateTemplateData](docs/UpdateTemplateData.md)
164+
- [UpdateTemplateResponse](docs/UpdateTemplateResponse.md)
165+
- [UploadTemplateData](docs/UploadTemplateData.md)
166+
- [UploadTemplateDataDocument](docs/UploadTemplateDataDocument.md)
167+
- [UploadTemplateDataDocumentMetadata](docs/UploadTemplateDataDocumentMetadata.md)
168+
169+
170+
## Documentation For Authorization
171+
172+
173+
## api_token_basic
174+
175+
- **Type**: HTTP basic authentication
176+
177+
178+
## Author
179+
180+
181+
182+

docs/AddFieldsData.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
# AddFieldsData
2+
3+
## Properties
4+
Name | Type | Description | Notes
5+
------------ | ------------- | ------------- | -------------
6+
**fields** | [**list[TemplatestemplateIdaddFieldsFields]**](TemplatestemplateIdaddFieldsFields.md) | |
7+
8+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
9+
10+

docs/AddFieldsTemplateResponse.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
# AddFieldsTemplateResponse
2+
3+
## Properties
4+
Name | Type | Description | Notes
5+
------------ | ------------- | ------------- | -------------
6+
**new_field_ids** | **list[int]** | | [optional]
7+
**errors** | **list[str]** | | [optional]
8+
**status** | **str** | | [optional]
9+
10+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
11+
12+

docs/AuthenticationError.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
# AuthenticationError
2+
3+
## Properties
4+
Name | Type | Description | Notes
5+
------------ | ------------- | ------------- | -------------
6+
**status** | **str** | | [optional]
7+
**error** | **str** | |
8+
9+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
10+
11+

0 commit comments

Comments
 (0)