{"id":19383926,"url":"https://github.com/docspring/formapi-javascript","last_synced_at":"2026-06-11T01:31:07.685Z","repository":{"id":66068876,"uuid":"155847029","full_name":"DocSpring/formapi-javascript","owner":"DocSpring","description":"JavaScript API Client for https://formapi.io - https://www.npmjs.com/package/formapi","archived":false,"fork":false,"pushed_at":"2023-01-23T23:23:57.000Z","size":137,"stargazers_count":3,"open_issues_count":2,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2026-04-29T06:07:47.190Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"JavaScript","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":"2018-11-02T09:55:58.000Z","updated_at":"2022-07-20T07:39:21.000Z","dependencies_parsed_at":null,"dependency_job_id":"60ad6c8d-5ad2-4318-828e-94b32bad60d8","html_url":"https://github.com/DocSpring/formapi-javascript","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/DocSpring/formapi-javascript","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/DocSpring%2Fformapi-javascript","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/DocSpring%2Fformapi-javascript/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/DocSpring%2Fformapi-javascript/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/DocSpring%2Fformapi-javascript/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/DocSpring","download_url":"https://codeload.github.com/DocSpring/formapi-javascript/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/DocSpring%2Fformapi-javascript/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":34178819,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-05-26T15:22:16.424Z","status":"online","status_checked_at":"2026-06-10T02:00:07.152Z","response_time":89,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"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:25.324Z","updated_at":"2026-06-11T01:31:07.670Z","avatar_url":"https://github.com/DocSpring.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# formapi\n\nFormAPI - JavaScript client for formapi\nFormAPI is a service that helps you fill out and sign PDF templates.\nThis SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:\n\n- API version: v1\n- Package version: 2.14.0\n- Build package: io.formapi.codegen.FormApiJavascriptClientCodegen\n\n## Installation\n\n### For [Node.js](https://nodejs.org/)\n\n#### npm\n\nTo publish the library as a [npm](https://www.npmjs.com/),\nplease follow the procedure in [\"Publishing npm packages\"](https://docs.npmjs.com/getting-started/publishing-npm-packages).\n\nThen install it via:\n\n```shell\nnpm install formapi --save\n```\n\n##### Local development\n\nTo use the library locally without publishing to a remote npm registry, first install the dependencies by changing \ninto the directory containing `package.json` (and this README). Let's call this `JAVASCRIPT_CLIENT_DIR`. Then run:\n\n```shell\nnpm install\n```\n\nNext, [link](https://docs.npmjs.com/cli/link) it globally in npm with the following, also from `JAVASCRIPT_CLIENT_DIR`:\n\n```shell\nnpm link\n```\n\nFinally, switch to the directory you want to use your formapi from, and run:\n\n```shell\nnpm link /path/to/\u003cJAVASCRIPT_CLIENT_DIR\u003e\n```\n\nYou should now be able to `require('formapi')` in javascript files from the directory you ran the last \ncommand above from.\n\n#### git\n#\nIf the library is hosted at a git repository, e.g.\nhttps://github.com/GIT_USER_ID/GIT_REPO_ID\nthen install it via:\n\n```shell\n    npm install GIT_USER_ID/GIT_REPO_ID --save\n```\n\n### For browser\n\nThe library also works in the browser environment via npm and [browserify](http://browserify.org/). After following\nthe above steps with Node.js and installing browserify with `npm install -g browserify`,\nperform the following (assuming *main.js* is your entry file, that's to say your javascript file where you actually \nuse this library):\n\n```shell\nbrowserify main.js \u003e bundle.js\n```\n\nThen include *bundle.js* in the HTML pages.\n\n### Webpack Configuration\n\nUsing Webpack you may encounter the following error: \"Module not found: Error:\nCannot resolve module\", most certainly you should disable AMD loader. Add/merge\nthe following section to your webpack config:\n\n```javascript\nmodule: {\n  rules: [\n    {\n      parser: {\n        amd: false\n      }\n    }\n  ]\n}\n```\n\n## Getting Started\n\nPlease follow the [installation](#installation) instruction and execute the following JS code:\n\n```javascript\nvar FormAPI = require('formapi');\n\nvar defaultClient = FormAPI.ApiClient.instance;\n\n// Configure HTTP basic authorization: api_token_basic\nvar api_token_basic = defaultClient.authentications['api_token_basic'];\napi_token_basic.username = 'YOUR USERNAME'\napi_token_basic.password = 'YOUR PASSWORD'\n\nvar api = new FormAPI.PDFApi()\nvar templateId = tpl_000000000000000001; // {String} \nvar requestBody = [null]; // {[Object]} \n\nvar callback = function(error, data, response) {\n  if (error) {\n    console.error(error);\n  } else {\n    console.log('API called successfully. Returned data: ' + data);\n  }\n};\napi.batchGeneratePdfV1(templateId, requestBody, callback);\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*FormAPI.PDFApi* | [**batchGeneratePdfV1**](docs/PDFApi.md#batchGeneratePdfV1) | **POST** /templates/{template_id}/submissions/batch | Generates multiple PDFs\n*FormAPI.PDFApi* | [**batchGeneratePdfs**](docs/PDFApi.md#batchGeneratePdfs) | **POST** /submissions/batches | Generates multiple PDFs\n*FormAPI.PDFApi* | [**combinePdfs**](docs/PDFApi.md#combinePdfs) | **POST** /combined_submissions?v\u0026#x3D;2 | Merge submission PDFs, template PDFs, or custom files\n*FormAPI.PDFApi* | [**combineSubmissions**](docs/PDFApi.md#combineSubmissions) | **POST** /combined_submissions | Merge generated PDFs together\n*FormAPI.PDFApi* | [**createCustomFileFromUpload**](docs/PDFApi.md#createCustomFileFromUpload) | **POST** /custom_files | Create a new custom file from a cached presign upload\n*FormAPI.PDFApi* | [**createDataRequestToken**](docs/PDFApi.md#createDataRequestToken) | **POST** /data_requests/{data_request_id}/tokens | Creates a new data request token for form authentication\n*FormAPI.PDFApi* | [**createFolder**](docs/PDFApi.md#createFolder) | **POST** /folders/ | Create a folder\n*FormAPI.PDFApi* | [**createTemplate**](docs/PDFApi.md#createTemplate) | **POST** /templates | Upload a new PDF template with a file upload\n*FormAPI.PDFApi* | [**createTemplateFromUpload**](docs/PDFApi.md#createTemplateFromUpload) | **POST** /templates?v\u0026#x3D;2 | Create a new PDF template from a cached presign upload\n*FormAPI.PDFApi* | [**deleteFolder**](docs/PDFApi.md#deleteFolder) | **DELETE** /folders/{folder_id} | Delete a folder\n*FormAPI.PDFApi* | [**expireCombinedSubmission**](docs/PDFApi.md#expireCombinedSubmission) | **DELETE** /combined_submissions/{combined_submission_id} | Expire a combined submission\n*FormAPI.PDFApi* | [**expireSubmission**](docs/PDFApi.md#expireSubmission) | **DELETE** /submissions/{submission_id} | Expire a PDF submission\n*FormAPI.PDFApi* | [**generatePDF**](docs/PDFApi.md#generatePDF) | **POST** /templates/{template_id}/submissions | Generates a new PDF\n*FormAPI.PDFApi* | [**getCombinedSubmission**](docs/PDFApi.md#getCombinedSubmission) | **GET** /combined_submissions/{combined_submission_id} | Check the status of a combined submission (merged PDFs)\n*FormAPI.PDFApi* | [**getDataRequest**](docs/PDFApi.md#getDataRequest) | **GET** /data_requests/{data_request_id} | Look up a submission data request\n*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\n*FormAPI.PDFApi* | [**getSubmission**](docs/PDFApi.md#getSubmission) | **GET** /submissions/{submission_id} | Check the status of a PDF\n*FormAPI.PDFApi* | [**getSubmissionBatch**](docs/PDFApi.md#getSubmissionBatch) | **GET** /submissions/batches/{submission_batch_id} | Check the status of a submission batch job\n*FormAPI.PDFApi* | [**getTemplate**](docs/PDFApi.md#getTemplate) | **GET** /templates/{template_id} | Get a single template\n*FormAPI.PDFApi* | [**getTemplateSchema**](docs/PDFApi.md#getTemplateSchema) | **GET** /templates/{template_id}/schema | Fetch the JSON schema for a template\n*FormAPI.PDFApi* | [**listFolders**](docs/PDFApi.md#listFolders) | **GET** /folders/ | Get a list of all folders\n*FormAPI.PDFApi* | [**listTemplates**](docs/PDFApi.md#listTemplates) | **GET** /templates | Get a list of all templates\n*FormAPI.PDFApi* | [**moveFolderToFolder**](docs/PDFApi.md#moveFolderToFolder) | **POST** /folders/{folder_id}/move | Move a folder\n*FormAPI.PDFApi* | [**moveTemplateToFolder**](docs/PDFApi.md#moveTemplateToFolder) | **POST** /templates/{template_id}/move | Move Template to folder\n*FormAPI.PDFApi* | [**renameFolder**](docs/PDFApi.md#renameFolder) | **POST** /folders/{folder_id}/rename | Rename a folder\n*FormAPI.PDFApi* | [**testAuthentication**](docs/PDFApi.md#testAuthentication) | **GET** /authentication | Test Authentication\n*FormAPI.PDFApi* | [**updateDataRequest**](docs/PDFApi.md#updateDataRequest) | **PUT** /data_requests/{data_request_id} | Update a submission data request\n\n\n## Documentation for Models\n\n - [FormAPI.AuthenticationError](docs/AuthenticationError.md)\n - [FormAPI.AuthenticationSuccessResponse](docs/AuthenticationSuccessResponse.md)\n - [FormAPI.CombinePdfsData](docs/CombinePdfsData.md)\n - [FormAPI.CombinedSubmission](docs/CombinedSubmission.md)\n - [FormAPI.CombinedSubmissionAction](docs/CombinedSubmissionAction.md)\n - [FormAPI.CombinedSubmissionData](docs/CombinedSubmissionData.md)\n - [FormAPI.CreateCombinedSubmissionResponse](docs/CreateCombinedSubmissionResponse.md)\n - [FormAPI.CreateCustomFileData](docs/CreateCustomFileData.md)\n - [FormAPI.CreateCustomFileResponse](docs/CreateCustomFileResponse.md)\n - [FormAPI.CreateFolderData](docs/CreateFolderData.md)\n - [FormAPI.CreateSubmissionBatchResponse](docs/CreateSubmissionBatchResponse.md)\n - [FormAPI.CreateSubmissionBatchSubmissionsResponse](docs/CreateSubmissionBatchSubmissionsResponse.md)\n - [FormAPI.CreateSubmissionDataRequestData](docs/CreateSubmissionDataRequestData.md)\n - [FormAPI.CreateSubmissionDataRequestTokenResponse](docs/CreateSubmissionDataRequestTokenResponse.md)\n - [FormAPI.CreateSubmissionDataRequestTokenResponseToken](docs/CreateSubmissionDataRequestTokenResponseToken.md)\n - [FormAPI.CreateSubmissionResponse](docs/CreateSubmissionResponse.md)\n - [FormAPI.CreateTemplateData](docs/CreateTemplateData.md)\n - [FormAPI.CustomFile](docs/CustomFile.md)\n - [FormAPI.Error](docs/Error.md)\n - [FormAPI.Folder](docs/Folder.md)\n - [FormAPI.FoldersFolder](docs/FoldersFolder.md)\n - [FormAPI.InvalidRequest](docs/InvalidRequest.md)\n - [FormAPI.MoveFolderData](docs/MoveFolderData.md)\n - [FormAPI.MoveTemplateData](docs/MoveTemplateData.md)\n - [FormAPI.PendingTemplate](docs/PendingTemplate.md)\n - [FormAPI.RenameFolderData](docs/RenameFolderData.md)\n - [FormAPI.Submission](docs/Submission.md)\n - [FormAPI.SubmissionAction](docs/SubmissionAction.md)\n - [FormAPI.SubmissionBatch](docs/SubmissionBatch.md)\n - [FormAPI.SubmissionBatchData](docs/SubmissionBatchData.md)\n - [FormAPI.SubmissionData](docs/SubmissionData.md)\n - [FormAPI.SubmissionDataBatchRequest](docs/SubmissionDataBatchRequest.md)\n - [FormAPI.SubmissionDataRequest](docs/SubmissionDataRequest.md)\n - [FormAPI.Template](docs/Template.md)\n - [FormAPI.Templatesv2Template](docs/Templatesv2Template.md)\n - [FormAPI.Templatesv2TemplateDocument](docs/Templatesv2TemplateDocument.md)\n - [FormAPI.Templatesv2TemplateDocumentMetadata](docs/Templatesv2TemplateDocumentMetadata.md)\n - [FormAPI.UpdateDataRequestResponse](docs/UpdateDataRequestResponse.md)\n - [FormAPI.UpdateSubmissionDataRequestData](docs/UpdateSubmissionDataRequestData.md)\n\n\n## Documentation for Authorization\n\n\n### api_token_basic\n\n- **Type**: HTTP basic authentication\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdocspring%2Fformapi-javascript","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fdocspring%2Fformapi-javascript","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdocspring%2Fformapi-javascript/lists"}