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 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

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:

import form_api 

Setuptools

Install via Setuptools.

python setup.py install --user

(or sudo python setup.py install to install the package for all users)

Then import the package:

import form_api

Getting Started

Please follow the installation procedure and then run the following:

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	POST /templates/{template_id}/submissions/batch	Generates multiple PDFs
PDFApi	batch_generate_pdfs	POST /submissions/batches	Generates multiple PDFs
PDFApi	combine_pdfs	POST /combined_submissions?v=2	Merge submission PDFs, template PDFs, or custom files
PDFApi	combine_submissions	POST /combined_submissions	Merge generated PDFs together
PDFApi	create_custom_file_from_upload	POST /custom_files	Create a new custom file from a cached presign upload
PDFApi	create_data_request_token	POST /data_requests/{data_request_id}/tokens	Creates a new data request token for form authentication
PDFApi	create_folder	POST /folders/	Create a folder
PDFApi	create_template	POST /templates	Upload a new PDF template with a file upload
PDFApi	create_template_from_upload	POST /templates?v=2	Create a new PDF template from a cached presign upload
PDFApi	delete_folder	DELETE /folders/{folder_id}	Delete a folder
PDFApi	expire_combined_submission	DELETE /combined_submissions/{combined_submission_id}	Expire a combined submission
PDFApi	expire_submission	DELETE /submissions/{submission_id}	Expire a PDF submission
PDFApi	generate_pdf	POST /templates/{template_id}/submissions	Generates a new PDF
PDFApi	get_combined_submission	GET /combined_submissions/{combined_submission_id}	Check the status of a combined submission (merged PDFs)
PDFApi	get_data_request	GET /data_requests/{data_request_id}	Look up a submission data request
PDFApi	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	GET /submissions/{submission_id}	Check the status of a PDF
PDFApi	get_submission_batch	GET /submissions/batches/{submission_batch_id}	Check the status of a submission batch job
PDFApi	get_template	GET /templates/{template_id}	Get a single template
PDFApi	get_template_schema	GET /templates/{template_id}/schema	Fetch the JSON schema for a template
PDFApi	list_folders	GET /folders/	Get a list of all folders
PDFApi	list_templates	GET /templates	Get a list of all templates
PDFApi	move_folder_to_folder	POST /folders/{folder_id}/move	Move a folder
PDFApi	move_template_to_folder	POST /templates/{template_id}/move	Move Template to folder
PDFApi	rename_folder	POST /folders/{folder_id}/rename	Rename a folder
PDFApi	test_authentication	GET /authentication	Test Authentication
PDFApi	update_data_request	PUT /data_requests/{data_request_id}	Update a submission data request

Documentation For Models

• AuthenticationError
• AuthenticationSuccessResponse
• CombinePdfsData
• CombinedSubmission
• CombinedSubmissionAction
• CombinedSubmissionData
• CreateCombinedSubmissionResponse
• CreateCustomFileData
• CreateCustomFileResponse
• CreateFolderData
• CreateSubmissionBatchResponse
• CreateSubmissionBatchSubmissionsResponse
• CreateSubmissionDataRequestData
• CreateSubmissionDataRequestTokenResponse
• CreateSubmissionDataRequestTokenResponseToken
• CreateSubmissionResponse
• CreateTemplateData
• CustomFile
• Error
• Folder
• FoldersFolder
• InvalidRequest
• MoveFolderData
• MoveTemplateData
• PendingTemplate
• RenameFolderData
• Submission
• SubmissionAction
• SubmissionBatch
• SubmissionBatchData
• SubmissionData
• SubmissionDataBatchRequest
• SubmissionDataRequest
• Template
• Templatesv2Template
• Templatesv2TemplateDocument
• Templatesv2TemplateDocumentMetadata
• UpdateDataRequestResponse
• UpdateSubmissionDataRequestData

Documentation For Authorization

api_token_basic

• Type: HTTP basic authentication

Author