https://github.com/docspring/formapi-javascript
JavaScript API Client for https://formapi.io - https://www.npmjs.com/package/formapi
https://github.com/docspring/formapi-javascript
Last synced: 7 days ago
JSON representation
JavaScript API Client for https://formapi.io - https://www.npmjs.com/package/formapi
- Host: GitHub
- URL: https://github.com/docspring/formapi-javascript
- Owner: DocSpring
- License: mit
- Created: 2018-11-02T09:55:58.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2023-01-23T23:23:57.000Z (over 3 years ago)
- Last Synced: 2026-04-29T06:07:47.190Z (about 2 months ago)
- Language: JavaScript
- Size: 134 KB
- Stars: 3
- Watchers: 1
- Forks: 0
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# formapi
FormAPI - JavaScript client for formapi
FormAPI is a service that helps you fill out and sign PDF templates.
This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
- API version: v1
- Package version: 2.14.0
- Build package: io.formapi.codegen.FormApiJavascriptClientCodegen
## Installation
### For [Node.js](https://nodejs.org/)
#### npm
To publish the library as a [npm](https://www.npmjs.com/),
please follow the procedure in ["Publishing npm packages"](https://docs.npmjs.com/getting-started/publishing-npm-packages).
Then install it via:
```shell
npm install formapi --save
```
##### Local development
To use the library locally without publishing to a remote npm registry, first install the dependencies by changing
into the directory containing `package.json` (and this README). Let's call this `JAVASCRIPT_CLIENT_DIR`. Then run:
```shell
npm install
```
Next, [link](https://docs.npmjs.com/cli/link) it globally in npm with the following, also from `JAVASCRIPT_CLIENT_DIR`:
```shell
npm link
```
Finally, switch to the directory you want to use your formapi from, and run:
```shell
npm link /path/to/
```
You should now be able to `require('formapi')` in javascript files from the directory you ran the last
command above from.
#### git
#
If the library is hosted at a git repository, e.g.
https://github.com/GIT_USER_ID/GIT_REPO_ID
then install it via:
```shell
npm install GIT_USER_ID/GIT_REPO_ID --save
```
### For browser
The library also works in the browser environment via npm and [browserify](http://browserify.org/). After following
the above steps with Node.js and installing browserify with `npm install -g browserify`,
perform the following (assuming *main.js* is your entry file, that's to say your javascript file where you actually
use this library):
```shell
browserify main.js > bundle.js
```
Then include *bundle.js* in the HTML pages.
### Webpack Configuration
Using Webpack you may encounter the following error: "Module not found: Error:
Cannot resolve module", most certainly you should disable AMD loader. Add/merge
the following section to your webpack config:
```javascript
module: {
rules: [
{
parser: {
amd: false
}
}
]
}
```
## Getting Started
Please follow the [installation](#installation) instruction and execute the following JS code:
```javascript
var FormAPI = require('formapi');
var defaultClient = FormAPI.ApiClient.instance;
// Configure HTTP basic authorization: api_token_basic
var api_token_basic = defaultClient.authentications['api_token_basic'];
api_token_basic.username = 'YOUR USERNAME'
api_token_basic.password = 'YOUR PASSWORD'
var api = new FormAPI.PDFApi()
var templateId = tpl_000000000000000001; // {String}
var requestBody = [null]; // {[Object]}
var callback = function(error, data, response) {
if (error) {
console.error(error);
} else {
console.log('API called successfully. Returned data: ' + data);
}
};
api.batchGeneratePdfV1(templateId, requestBody, callback);
```
## Documentation for API Endpoints
All URIs are relative to *https://api.formapi.io/api/v1*
Class | Method | HTTP request | Description
------------ | ------------- | ------------- | -------------
*FormAPI.PDFApi* | [**batchGeneratePdfV1**](docs/PDFApi.md#batchGeneratePdfV1) | **POST** /templates/{template_id}/submissions/batch | Generates multiple PDFs
*FormAPI.PDFApi* | [**batchGeneratePdfs**](docs/PDFApi.md#batchGeneratePdfs) | **POST** /submissions/batches | Generates multiple PDFs
*FormAPI.PDFApi* | [**combinePdfs**](docs/PDFApi.md#combinePdfs) | **POST** /combined_submissions?v=2 | Merge submission PDFs, template PDFs, or custom files
*FormAPI.PDFApi* | [**combineSubmissions**](docs/PDFApi.md#combineSubmissions) | **POST** /combined_submissions | Merge generated PDFs together
*FormAPI.PDFApi* | [**createCustomFileFromUpload**](docs/PDFApi.md#createCustomFileFromUpload) | **POST** /custom_files | Create a new custom file from a cached presign upload
*FormAPI.PDFApi* | [**createDataRequestToken**](docs/PDFApi.md#createDataRequestToken) | **POST** /data_requests/{data_request_id}/tokens | Creates a new data request token for form authentication
*FormAPI.PDFApi* | [**createFolder**](docs/PDFApi.md#createFolder) | **POST** /folders/ | Create a folder
*FormAPI.PDFApi* | [**createTemplate**](docs/PDFApi.md#createTemplate) | **POST** /templates | Upload a new PDF template with a file upload
*FormAPI.PDFApi* | [**createTemplateFromUpload**](docs/PDFApi.md#createTemplateFromUpload) | **POST** /templates?v=2 | Create a new PDF template from a cached presign upload
*FormAPI.PDFApi* | [**deleteFolder**](docs/PDFApi.md#deleteFolder) | **DELETE** /folders/{folder_id} | Delete a folder
*FormAPI.PDFApi* | [**expireCombinedSubmission**](docs/PDFApi.md#expireCombinedSubmission) | **DELETE** /combined_submissions/{combined_submission_id} | Expire a combined submission
*FormAPI.PDFApi* | [**expireSubmission**](docs/PDFApi.md#expireSubmission) | **DELETE** /submissions/{submission_id} | Expire a PDF submission
*FormAPI.PDFApi* | [**generatePDF**](docs/PDFApi.md#generatePDF) | **POST** /templates/{template_id}/submissions | Generates a new PDF
*FormAPI.PDFApi* | [**getCombinedSubmission**](docs/PDFApi.md#getCombinedSubmission) | **GET** /combined_submissions/{combined_submission_id} | Check the status of a combined submission (merged PDFs)
*FormAPI.PDFApi* | [**getDataRequest**](docs/PDFApi.md#getDataRequest) | **GET** /data_requests/{data_request_id} | Look up a submission data request
*FormAPI.PDFApi* | [**getPresignUrl**](docs/PDFApi.md#getPresignUrl) | **GET** /uploads/presign | Get a presigned URL so that you can upload a file to our AWS S3 bucket
*FormAPI.PDFApi* | [**getSubmission**](docs/PDFApi.md#getSubmission) | **GET** /submissions/{submission_id} | Check the status of a PDF
*FormAPI.PDFApi* | [**getSubmissionBatch**](docs/PDFApi.md#getSubmissionBatch) | **GET** /submissions/batches/{submission_batch_id} | Check the status of a submission batch job
*FormAPI.PDFApi* | [**getTemplate**](docs/PDFApi.md#getTemplate) | **GET** /templates/{template_id} | Get a single template
*FormAPI.PDFApi* | [**getTemplateSchema**](docs/PDFApi.md#getTemplateSchema) | **GET** /templates/{template_id}/schema | Fetch the JSON schema for a template
*FormAPI.PDFApi* | [**listFolders**](docs/PDFApi.md#listFolders) | **GET** /folders/ | Get a list of all folders
*FormAPI.PDFApi* | [**listTemplates**](docs/PDFApi.md#listTemplates) | **GET** /templates | Get a list of all templates
*FormAPI.PDFApi* | [**moveFolderToFolder**](docs/PDFApi.md#moveFolderToFolder) | **POST** /folders/{folder_id}/move | Move a folder
*FormAPI.PDFApi* | [**moveTemplateToFolder**](docs/PDFApi.md#moveTemplateToFolder) | **POST** /templates/{template_id}/move | Move Template to folder
*FormAPI.PDFApi* | [**renameFolder**](docs/PDFApi.md#renameFolder) | **POST** /folders/{folder_id}/rename | Rename a folder
*FormAPI.PDFApi* | [**testAuthentication**](docs/PDFApi.md#testAuthentication) | **GET** /authentication | Test Authentication
*FormAPI.PDFApi* | [**updateDataRequest**](docs/PDFApi.md#updateDataRequest) | **PUT** /data_requests/{data_request_id} | Update a submission data request
## Documentation for Models
- [FormAPI.AuthenticationError](docs/AuthenticationError.md)
- [FormAPI.AuthenticationSuccessResponse](docs/AuthenticationSuccessResponse.md)
- [FormAPI.CombinePdfsData](docs/CombinePdfsData.md)
- [FormAPI.CombinedSubmission](docs/CombinedSubmission.md)
- [FormAPI.CombinedSubmissionAction](docs/CombinedSubmissionAction.md)
- [FormAPI.CombinedSubmissionData](docs/CombinedSubmissionData.md)
- [FormAPI.CreateCombinedSubmissionResponse](docs/CreateCombinedSubmissionResponse.md)
- [FormAPI.CreateCustomFileData](docs/CreateCustomFileData.md)
- [FormAPI.CreateCustomFileResponse](docs/CreateCustomFileResponse.md)
- [FormAPI.CreateFolderData](docs/CreateFolderData.md)
- [FormAPI.CreateSubmissionBatchResponse](docs/CreateSubmissionBatchResponse.md)
- [FormAPI.CreateSubmissionBatchSubmissionsResponse](docs/CreateSubmissionBatchSubmissionsResponse.md)
- [FormAPI.CreateSubmissionDataRequestData](docs/CreateSubmissionDataRequestData.md)
- [FormAPI.CreateSubmissionDataRequestTokenResponse](docs/CreateSubmissionDataRequestTokenResponse.md)
- [FormAPI.CreateSubmissionDataRequestTokenResponseToken](docs/CreateSubmissionDataRequestTokenResponseToken.md)
- [FormAPI.CreateSubmissionResponse](docs/CreateSubmissionResponse.md)
- [FormAPI.CreateTemplateData](docs/CreateTemplateData.md)
- [FormAPI.CustomFile](docs/CustomFile.md)
- [FormAPI.Error](docs/Error.md)
- [FormAPI.Folder](docs/Folder.md)
- [FormAPI.FoldersFolder](docs/FoldersFolder.md)
- [FormAPI.InvalidRequest](docs/InvalidRequest.md)
- [FormAPI.MoveFolderData](docs/MoveFolderData.md)
- [FormAPI.MoveTemplateData](docs/MoveTemplateData.md)
- [FormAPI.PendingTemplate](docs/PendingTemplate.md)
- [FormAPI.RenameFolderData](docs/RenameFolderData.md)
- [FormAPI.Submission](docs/Submission.md)
- [FormAPI.SubmissionAction](docs/SubmissionAction.md)
- [FormAPI.SubmissionBatch](docs/SubmissionBatch.md)
- [FormAPI.SubmissionBatchData](docs/SubmissionBatchData.md)
- [FormAPI.SubmissionData](docs/SubmissionData.md)
- [FormAPI.SubmissionDataBatchRequest](docs/SubmissionDataBatchRequest.md)
- [FormAPI.SubmissionDataRequest](docs/SubmissionDataRequest.md)
- [FormAPI.Template](docs/Template.md)
- [FormAPI.Templatesv2Template](docs/Templatesv2Template.md)
- [FormAPI.Templatesv2TemplateDocument](docs/Templatesv2TemplateDocument.md)
- [FormAPI.Templatesv2TemplateDocumentMetadata](docs/Templatesv2TemplateDocumentMetadata.md)
- [FormAPI.UpdateDataRequestResponse](docs/UpdateDataRequestResponse.md)
- [FormAPI.UpdateSubmissionDataRequestData](docs/UpdateSubmissionDataRequestData.md)
## Documentation for Authorization
### api_token_basic
- **Type**: HTTP basic authentication