{"id":19383923,"url":"https://github.com/docspring/formapi-python","last_synced_at":"2026-06-11T22:31:12.446Z","repository":{"id":66068870,"uuid":"106108214","full_name":"DocSpring/formapi-python","owner":"DocSpring","description":"Python client for FormAPI","archived":false,"fork":false,"pushed_at":"2019-10-09T17:51:38.000Z","size":148,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":3,"default_branch":"master","last_synced_at":"2025-01-07T07:14:24.470Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"https://pypi.org/project/form-api/","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/DocSpring.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2017-10-07T15:24:23.000Z","updated_at":"2022-11-02T13:10:57.000Z","dependencies_parsed_at":null,"dependency_job_id":"3c5a01a0-2ca9-4611-89be-62ab8177731e","html_url":"https://github.com/DocSpring/formapi-python","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/DocSpring%2Fformapi-python","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/DocSpring%2Fformapi-python/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/DocSpring%2Fformapi-python/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/DocSpring%2Fformapi-python/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/DocSpring","download_url":"https://codeload.github.com/DocSpring/formapi-python/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":240521037,"owners_count":19814694,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-11-10T09:28:24.831Z","updated_at":"2026-06-11T22:31:12.439Z","avatar_url":"https://github.com/DocSpring.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# form-api\nFormAPI is a service that helps you fill out and sign PDF templates.\n\nThis Python package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:\n\n- API version: v1\n- Package version: 1.12.0\n- Build package: io.formapi.codegen.FormApiPythonClientCodegen\n\n## Requirements.\n\nPython 2.7 and 3.4+\n\n## Installation \u0026 Usage\n### pip install\n\nIf the python package is hosted on Github, you can install directly from Github\n\n```sh\npip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git\n```\n(you may need to run `pip` with root permission: `sudo pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git`)\n\nThen import the package:\n```python\nimport form_api \n```\n\n### Setuptools\n\nInstall via [Setuptools](http://pypi.python.org/pypi/setuptools).\n\n```sh\npython setup.py install --user\n```\n(or `sudo python setup.py install` to install the package for all users)\n\nThen import the package:\n```python\nimport form_api\n```\n\n## Getting Started\n\nPlease follow the [installation procedure](#installation--usage) and then run the following:\n\n```python\nfrom __future__ import print_function\nimport time\nimport form_api\nfrom form_api.rest import ApiException\nfrom pprint import pprint\n\n# Configure HTTP basic authorization: api_token_basic\nconfiguration = form_api.Configuration()\nconfiguration.username = 'YOUR_USERNAME'\nconfiguration.password = 'YOUR_PASSWORD'\n\n# create an instance of the API class\napi_instance = form_api.PDFApi(form_api.ApiClient(configuration))\ntemplate_id = 'tpl_000000000000000001' # str | \nrequest_body = NULL # list[object] | \n\ntry:\n    # Generates multiple PDFs\n    api_response = api_instance.batch_generate_pdf_v1(template_id, request_body)\n    pprint(api_response)\nexcept ApiException as e:\n    print(\"Exception when calling PDFApi-\u003ebatch_generate_pdf_v1: %s\\n\" % e)\n\n```\n\n## Documentation for API Endpoints\n\nAll URIs are relative to *https://api.formapi.io/api/v1*\n\nClass | Method | HTTP request | Description\n------------ | ------------- | ------------- | -------------\n*PDFApi* | [**batch_generate_pdf_v1**](docs/PDFApi.md#batch_generate_pdf_v1) | **POST** /templates/{template_id}/submissions/batch | Generates multiple PDFs\n*PDFApi* | [**batch_generate_pdfs**](docs/PDFApi.md#batch_generate_pdfs) | **POST** /submissions/batches | Generates multiple PDFs\n*PDFApi* | [**combine_pdfs**](docs/PDFApi.md#combine_pdfs) | **POST** /combined_submissions?v\u0026#x3D;2 | Merge submission PDFs, template PDFs, or custom files\n*PDFApi* | [**combine_submissions**](docs/PDFApi.md#combine_submissions) | **POST** /combined_submissions | Merge generated PDFs together\n*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\n*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\n*PDFApi* | [**create_folder**](docs/PDFApi.md#create_folder) | **POST** /folders/ | Create a folder\n*PDFApi* | [**create_template**](docs/PDFApi.md#create_template) | **POST** /templates | Upload a new PDF template with a file upload\n*PDFApi* | [**create_template_from_upload**](docs/PDFApi.md#create_template_from_upload) | **POST** /templates?v\u0026#x3D;2 | Create a new PDF template from a cached presign upload\n*PDFApi* | [**delete_folder**](docs/PDFApi.md#delete_folder) | **DELETE** /folders/{folder_id} | Delete a folder\n*PDFApi* | [**expire_combined_submission**](docs/PDFApi.md#expire_combined_submission) | **DELETE** /combined_submissions/{combined_submission_id} | Expire a combined submission\n*PDFApi* | [**expire_submission**](docs/PDFApi.md#expire_submission) | **DELETE** /submissions/{submission_id} | Expire a PDF submission\n*PDFApi* | [**generate_pdf**](docs/PDFApi.md#generate_pdf) | **POST** /templates/{template_id}/submissions | Generates a new PDF\n*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)\n*PDFApi* | [**get_data_request**](docs/PDFApi.md#get_data_request) | **GET** /data_requests/{data_request_id} | Look up a submission data request\n*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\n*PDFApi* | [**get_submission**](docs/PDFApi.md#get_submission) | **GET** /submissions/{submission_id} | Check the status of a PDF\n*PDFApi* | [**get_submission_batch**](docs/PDFApi.md#get_submission_batch) | **GET** /submissions/batches/{submission_batch_id} | Check the status of a submission batch job\n*PDFApi* | [**get_template**](docs/PDFApi.md#get_template) | **GET** /templates/{template_id} | Get a single template\n*PDFApi* | [**get_template_schema**](docs/PDFApi.md#get_template_schema) | **GET** /templates/{template_id}/schema | Fetch the JSON schema for a template\n*PDFApi* | [**list_folders**](docs/PDFApi.md#list_folders) | **GET** /folders/ | Get a list of all folders\n*PDFApi* | [**list_templates**](docs/PDFApi.md#list_templates) | **GET** /templates | Get a list of all templates\n*PDFApi* | [**move_folder_to_folder**](docs/PDFApi.md#move_folder_to_folder) | **POST** /folders/{folder_id}/move | Move a folder\n*PDFApi* | [**move_template_to_folder**](docs/PDFApi.md#move_template_to_folder) | **POST** /templates/{template_id}/move | Move Template to folder\n*PDFApi* | [**rename_folder**](docs/PDFApi.md#rename_folder) | **POST** /folders/{folder_id}/rename | Rename a folder\n*PDFApi* | [**test_authentication**](docs/PDFApi.md#test_authentication) | **GET** /authentication | Test Authentication\n*PDFApi* | [**update_data_request**](docs/PDFApi.md#update_data_request) | **PUT** /data_requests/{data_request_id} | Update a submission data request\n\n\n## Documentation For Models\n\n - [AuthenticationError](docs/AuthenticationError.md)\n - [AuthenticationSuccessResponse](docs/AuthenticationSuccessResponse.md)\n - [CombinePdfsData](docs/CombinePdfsData.md)\n - [CombinedSubmission](docs/CombinedSubmission.md)\n - [CombinedSubmissionAction](docs/CombinedSubmissionAction.md)\n - [CombinedSubmissionData](docs/CombinedSubmissionData.md)\n - [CreateCombinedSubmissionResponse](docs/CreateCombinedSubmissionResponse.md)\n - [CreateCustomFileData](docs/CreateCustomFileData.md)\n - [CreateCustomFileResponse](docs/CreateCustomFileResponse.md)\n - [CreateFolderData](docs/CreateFolderData.md)\n - [CreateSubmissionBatchResponse](docs/CreateSubmissionBatchResponse.md)\n - [CreateSubmissionBatchSubmissionsResponse](docs/CreateSubmissionBatchSubmissionsResponse.md)\n - [CreateSubmissionDataRequestData](docs/CreateSubmissionDataRequestData.md)\n - [CreateSubmissionDataRequestTokenResponse](docs/CreateSubmissionDataRequestTokenResponse.md)\n - [CreateSubmissionDataRequestTokenResponseToken](docs/CreateSubmissionDataRequestTokenResponseToken.md)\n - [CreateSubmissionResponse](docs/CreateSubmissionResponse.md)\n - [CreateTemplateData](docs/CreateTemplateData.md)\n - [CustomFile](docs/CustomFile.md)\n - [Error](docs/Error.md)\n - [Folder](docs/Folder.md)\n - [FoldersFolder](docs/FoldersFolder.md)\n - [InvalidRequest](docs/InvalidRequest.md)\n - [MoveFolderData](docs/MoveFolderData.md)\n - [MoveTemplateData](docs/MoveTemplateData.md)\n - [PendingTemplate](docs/PendingTemplate.md)\n - [RenameFolderData](docs/RenameFolderData.md)\n - [Submission](docs/Submission.md)\n - [SubmissionAction](docs/SubmissionAction.md)\n - [SubmissionBatch](docs/SubmissionBatch.md)\n - [SubmissionBatchData](docs/SubmissionBatchData.md)\n - [SubmissionData](docs/SubmissionData.md)\n - [SubmissionDataBatchRequest](docs/SubmissionDataBatchRequest.md)\n - [SubmissionDataRequest](docs/SubmissionDataRequest.md)\n - [Template](docs/Template.md)\n - [Templatesv2Template](docs/Templatesv2Template.md)\n - [Templatesv2TemplateDocument](docs/Templatesv2TemplateDocument.md)\n - [Templatesv2TemplateDocumentMetadata](docs/Templatesv2TemplateDocumentMetadata.md)\n - [UpdateDataRequestResponse](docs/UpdateDataRequestResponse.md)\n - [UpdateSubmissionDataRequestData](docs/UpdateSubmissionDataRequestData.md)\n\n\n## Documentation For Authorization\n\n\n## api_token_basic\n\n- **Type**: HTTP basic authentication\n\n\n## Author\n\n\n\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdocspring%2Fformapi-python","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fdocspring%2Fformapi-python","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdocspring%2Fformapi-python/lists"}