https://github.com/docspring/formapi-python
Python client for FormAPI
https://github.com/docspring/formapi-python
Last synced: 6 days ago
JSON representation
Python client for FormAPI
- Host: GitHub
- URL: https://github.com/docspring/formapi-python
- Owner: DocSpring
- License: mit
- Created: 2017-10-07T15:24:23.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2019-10-09T17:51:38.000Z (over 6 years ago)
- Last Synced: 2025-01-07T07:14:24.470Z (over 1 year ago)
- Language: Python
- Homepage: https://pypi.org/project/form-api/
- Size: 145 KB
- Stars: 1
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# form-api
FormAPI is a service that helps you fill out and sign PDF templates.
This Python package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
- API version: v1
- Package version: 1.12.0
- Build package: io.formapi.codegen.FormApiPythonClientCodegen
## Requirements.
Python 2.7 and 3.4+
## Installation & Usage
### pip install
If the python package is hosted on Github, you can install directly from Github
```sh
pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git
```
(you may need to run `pip` with root permission: `sudo pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git`)
Then import the package:
```python
import form_api
```
### Setuptools
Install via [Setuptools](http://pypi.python.org/pypi/setuptools).
```sh
python setup.py install --user
```
(or `sudo python setup.py install` to install the package for all users)
Then import the package:
```python
import form_api
```
## Getting Started
Please follow the [installation procedure](#installation--usage) and then run the following:
```python
from __future__ import print_function
import time
import form_api
from form_api.rest import ApiException
from pprint import pprint
# Configure HTTP basic authorization: api_token_basic
configuration = form_api.Configuration()
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'
# create an instance of the API class
api_instance = form_api.PDFApi(form_api.ApiClient(configuration))
template_id = 'tpl_000000000000000001' # str |
request_body = NULL # list[object] |
try:
# Generates multiple PDFs
api_response = api_instance.batch_generate_pdf_v1(template_id, request_body)
pprint(api_response)
except ApiException as e:
print("Exception when calling PDFApi->batch_generate_pdf_v1: %s\n" % e)
```
## Documentation for API Endpoints
All URIs are relative to *https://api.formapi.io/api/v1*
Class | Method | HTTP request | Description
------------ | ------------- | ------------- | -------------
*PDFApi* | [**batch_generate_pdf_v1**](docs/PDFApi.md#batch_generate_pdf_v1) | **POST** /templates/{template_id}/submissions/batch | Generates multiple PDFs
*PDFApi* | [**batch_generate_pdfs**](docs/PDFApi.md#batch_generate_pdfs) | **POST** /submissions/batches | Generates multiple PDFs
*PDFApi* | [**combine_pdfs**](docs/PDFApi.md#combine_pdfs) | **POST** /combined_submissions?v=2 | Merge submission PDFs, template PDFs, or custom files
*PDFApi* | [**combine_submissions**](docs/PDFApi.md#combine_submissions) | **POST** /combined_submissions | Merge generated PDFs together
*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
*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
*PDFApi* | [**create_folder**](docs/PDFApi.md#create_folder) | **POST** /folders/ | Create a folder
*PDFApi* | [**create_template**](docs/PDFApi.md#create_template) | **POST** /templates | Upload a new PDF template with a file upload
*PDFApi* | [**create_template_from_upload**](docs/PDFApi.md#create_template_from_upload) | **POST** /templates?v=2 | Create a new PDF template from a cached presign upload
*PDFApi* | [**delete_folder**](docs/PDFApi.md#delete_folder) | **DELETE** /folders/{folder_id} | Delete a folder
*PDFApi* | [**expire_combined_submission**](docs/PDFApi.md#expire_combined_submission) | **DELETE** /combined_submissions/{combined_submission_id} | Expire a combined submission
*PDFApi* | [**expire_submission**](docs/PDFApi.md#expire_submission) | **DELETE** /submissions/{submission_id} | Expire a PDF submission
*PDFApi* | [**generate_pdf**](docs/PDFApi.md#generate_pdf) | **POST** /templates/{template_id}/submissions | Generates a new PDF
*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)
*PDFApi* | [**get_data_request**](docs/PDFApi.md#get_data_request) | **GET** /data_requests/{data_request_id} | Look up a submission data request
*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
*PDFApi* | [**get_submission**](docs/PDFApi.md#get_submission) | **GET** /submissions/{submission_id} | Check the status of a PDF
*PDFApi* | [**get_submission_batch**](docs/PDFApi.md#get_submission_batch) | **GET** /submissions/batches/{submission_batch_id} | Check the status of a submission batch job
*PDFApi* | [**get_template**](docs/PDFApi.md#get_template) | **GET** /templates/{template_id} | Get a single template
*PDFApi* | [**get_template_schema**](docs/PDFApi.md#get_template_schema) | **GET** /templates/{template_id}/schema | Fetch the JSON schema for a template
*PDFApi* | [**list_folders**](docs/PDFApi.md#list_folders) | **GET** /folders/ | Get a list of all folders
*PDFApi* | [**list_templates**](docs/PDFApi.md#list_templates) | **GET** /templates | Get a list of all templates
*PDFApi* | [**move_folder_to_folder**](docs/PDFApi.md#move_folder_to_folder) | **POST** /folders/{folder_id}/move | Move a folder
*PDFApi* | [**move_template_to_folder**](docs/PDFApi.md#move_template_to_folder) | **POST** /templates/{template_id}/move | Move Template to folder
*PDFApi* | [**rename_folder**](docs/PDFApi.md#rename_folder) | **POST** /folders/{folder_id}/rename | Rename a folder
*PDFApi* | [**test_authentication**](docs/PDFApi.md#test_authentication) | **GET** /authentication | Test Authentication
*PDFApi* | [**update_data_request**](docs/PDFApi.md#update_data_request) | **PUT** /data_requests/{data_request_id} | Update a submission data request
## Documentation For Models
- [AuthenticationError](docs/AuthenticationError.md)
- [AuthenticationSuccessResponse](docs/AuthenticationSuccessResponse.md)
- [CombinePdfsData](docs/CombinePdfsData.md)
- [CombinedSubmission](docs/CombinedSubmission.md)
- [CombinedSubmissionAction](docs/CombinedSubmissionAction.md)
- [CombinedSubmissionData](docs/CombinedSubmissionData.md)
- [CreateCombinedSubmissionResponse](docs/CreateCombinedSubmissionResponse.md)
- [CreateCustomFileData](docs/CreateCustomFileData.md)
- [CreateCustomFileResponse](docs/CreateCustomFileResponse.md)
- [CreateFolderData](docs/CreateFolderData.md)
- [CreateSubmissionBatchResponse](docs/CreateSubmissionBatchResponse.md)
- [CreateSubmissionBatchSubmissionsResponse](docs/CreateSubmissionBatchSubmissionsResponse.md)
- [CreateSubmissionDataRequestData](docs/CreateSubmissionDataRequestData.md)
- [CreateSubmissionDataRequestTokenResponse](docs/CreateSubmissionDataRequestTokenResponse.md)
- [CreateSubmissionDataRequestTokenResponseToken](docs/CreateSubmissionDataRequestTokenResponseToken.md)
- [CreateSubmissionResponse](docs/CreateSubmissionResponse.md)
- [CreateTemplateData](docs/CreateTemplateData.md)
- [CustomFile](docs/CustomFile.md)
- [Error](docs/Error.md)
- [Folder](docs/Folder.md)
- [FoldersFolder](docs/FoldersFolder.md)
- [InvalidRequest](docs/InvalidRequest.md)
- [MoveFolderData](docs/MoveFolderData.md)
- [MoveTemplateData](docs/MoveTemplateData.md)
- [PendingTemplate](docs/PendingTemplate.md)
- [RenameFolderData](docs/RenameFolderData.md)
- [Submission](docs/Submission.md)
- [SubmissionAction](docs/SubmissionAction.md)
- [SubmissionBatch](docs/SubmissionBatch.md)
- [SubmissionBatchData](docs/SubmissionBatchData.md)
- [SubmissionData](docs/SubmissionData.md)
- [SubmissionDataBatchRequest](docs/SubmissionDataBatchRequest.md)
- [SubmissionDataRequest](docs/SubmissionDataRequest.md)
- [Template](docs/Template.md)
- [Templatesv2Template](docs/Templatesv2Template.md)
- [Templatesv2TemplateDocument](docs/Templatesv2TemplateDocument.md)
- [Templatesv2TemplateDocumentMetadata](docs/Templatesv2TemplateDocumentMetadata.md)
- [UpdateDataRequestResponse](docs/UpdateDataRequestResponse.md)
- [UpdateSubmissionDataRequestData](docs/UpdateSubmissionDataRequestData.md)
## Documentation For Authorization
## api_token_basic
- **Type**: HTTP basic authentication
## Author