{"id":19383904,"url":"https://github.com/docspring/docspring-javascript","last_synced_at":"2026-03-10T02:33:37.634Z","repository":{"id":43045297,"uuid":"220522856","full_name":"DocSpring/docspring-javascript","owner":"DocSpring","description":"JavaScript API Client for DocSpring","archived":false,"fork":false,"pushed_at":"2025-09-24T00:56:52.000Z","size":517,"stargazers_count":2,"open_issues_count":2,"forks_count":1,"subscribers_count":2,"default_branch":"main","last_synced_at":"2026-03-01T00:53:30.288Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"https://www.npmjs.com/package/docspring","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,"zenodo":null}},"created_at":"2019-11-08T18:11:30.000Z","updated_at":"2025-09-24T00:56:56.000Z","dependencies_parsed_at":"2024-11-10T09:28:28.267Z","dependency_job_id":"4a5adb00-baf0-4838-b3c5-b5079ec87113","html_url":"https://github.com/DocSpring/docspring-javascript","commit_stats":null,"previous_names":[],"tags_count":10,"template":false,"template_full_name":null,"purl":"pkg:github/DocSpring/docspring-javascript","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/DocSpring%2Fdocspring-javascript","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/DocSpring%2Fdocspring-javascript/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/DocSpring%2Fdocspring-javascript/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/DocSpring%2Fdocspring-javascript/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/DocSpring","download_url":"https://codeload.github.com/DocSpring/docspring-javascript/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/DocSpring%2Fdocspring-javascript/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":30322645,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-03-10T01:36:58.598Z","status":"online","status_checked_at":"2026-03-10T02:00:06.579Z","response_time":106,"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:19.931Z","updated_at":"2026-03-10T02:33:37.620Z","avatar_url":"https://github.com/DocSpring.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# docspring\n\nDocSpring - JavaScript client for docspring\nDocSpring provides an API 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.1.0\n- Generator version: 7.11.0\n- Build package: org.openapitools.codegen.languages.JavascriptClientCodegen\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/), please 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 docspring --save\n```\n\nFinally, you need to build the module:\n\n```shell\nnpm run build\n```\n\n##### Local development\n\nTo 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:\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\nTo use the link you just defined in your project, switch to the directory you want to use your docspring from, and run:\n\n```shell\nnpm link /path/to/\u003cJAVASCRIPT_CLIENT_DIR\u003e\n```\n\nFinally, you need to build the module:\n\n```shell\nnpm run build\n```\n\n#### git\n\nIf the library is hosted at a git repository, e.g.https://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):\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 DocSpring = require('docspring');\n\nvar defaultClient = DocSpring.ApiClient.instance;\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 DocSpring.PDFApi()\nvar templateId = \"tpl_1234567890abcdef02\"; // {String} \nvar data = new DocSpring.AddFieldsData(); // {AddFieldsData} \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.addFieldsToTemplate(templateId, data, callback);\n\n```\n\n## Documentation for API Endpoints\n\nAll URIs are relative to *https://sync.api.docspring.com/api/v1*\n\nClass | Method | HTTP request | Description\n------------ | ------------- | ------------- | -------------\n*DocSpring.PDFApi* | [**addFieldsToTemplate**](docs/PDFApi.md#addFieldsToTemplate) | **PUT** /templates/{template_id}/add_fields | Add new fields to a Template\n*DocSpring.PDFApi* | [**batchGeneratePdfs**](docs/PDFApi.md#batchGeneratePdfs) | **POST** /submissions/batches | Generates multiple PDFs\n*DocSpring.PDFApi* | [**combinePdfs**](docs/PDFApi.md#combinePdfs) | **POST** /combined_submissions?v\u0026#x3D;2 | Merge submission PDFs, template PDFs, or custom files\n*DocSpring.PDFApi* | [**combineSubmissions**](docs/PDFApi.md#combineSubmissions) | **POST** /combined_submissions | Merge generated PDFs together\n*DocSpring.PDFApi* | [**copyTemplate**](docs/PDFApi.md#copyTemplate) | **POST** /templates/{template_id}/copy | Copy a Template\n*DocSpring.PDFApi* | [**createCustomFileFromUpload**](docs/PDFApi.md#createCustomFileFromUpload) | **POST** /custom_files | Create a new custom file from a cached presign upload\n*DocSpring.PDFApi* | [**createDataRequestEvent**](docs/PDFApi.md#createDataRequestEvent) | **POST** /data_requests/{data_request_id}/events | Creates a new event for emailing a signee a request for signature\n*DocSpring.PDFApi* | [**createDataRequestToken**](docs/PDFApi.md#createDataRequestToken) | **POST** /data_requests/{data_request_id}/tokens | Creates a new data request token for form authentication\n*DocSpring.PDFApi* | [**createFolder**](docs/PDFApi.md#createFolder) | **POST** /folders/ | Create a folder\n*DocSpring.PDFApi* | [**createHTMLTemplate**](docs/PDFApi.md#createHTMLTemplate) | **POST** /templates?endpoint_description\u0026#x3D;html | Create a new HTML template\n*DocSpring.PDFApi* | [**createPDFTemplate**](docs/PDFApi.md#createPDFTemplate) | **POST** /templates | Create a new PDF template with a form POST file upload\n*DocSpring.PDFApi* | [**createPDFTemplateFromUpload**](docs/PDFApi.md#createPDFTemplateFromUpload) | **POST** /templates?endpoint_description\u0026#x3D;cached_upload | Create a new PDF template from a cached presign upload\n*DocSpring.PDFApi* | [**deleteFolder**](docs/PDFApi.md#deleteFolder) | **DELETE** /folders/{folder_id} | Delete a folder\n*DocSpring.PDFApi* | [**deleteTemplate**](docs/PDFApi.md#deleteTemplate) | **DELETE** /templates/{template_id} | Delete a template\n*DocSpring.PDFApi* | [**expireCombinedSubmission**](docs/PDFApi.md#expireCombinedSubmission) | **DELETE** /combined_submissions/{combined_submission_id} | Expire a combined submission\n*DocSpring.PDFApi* | [**expireSubmission**](docs/PDFApi.md#expireSubmission) | **DELETE** /submissions/{submission_id} | Expire a PDF submission\n*DocSpring.PDFApi* | [**generatePdf**](docs/PDFApi.md#generatePdf) | **POST** /templates/{template_id}/submissions | Generates a new PDF\n*DocSpring.PDFApi* | [**generatePdfForHtmlTemplate**](docs/PDFApi.md#generatePdfForHtmlTemplate) | **POST** /templates/{template_id}/submissions?endpoint_description\u0026#x3D;html_templates | Generates a new PDF for an HTML template\n*DocSpring.PDFApi* | [**generatePreview**](docs/PDFApi.md#generatePreview) | **POST** /submissions/{submission_id}/generate_preview | Generated a preview PDF for partially completed data requests\n*DocSpring.PDFApi* | [**getCombinedSubmission**](docs/PDFApi.md#getCombinedSubmission) | **GET** /combined_submissions/{combined_submission_id} | Check the status of a combined submission (merged PDFs)\n*DocSpring.PDFApi* | [**getDataRequest**](docs/PDFApi.md#getDataRequest) | **GET** /data_requests/{data_request_id} | Look up a submission data request\n*DocSpring.PDFApi* | [**getFullTemplate**](docs/PDFApi.md#getFullTemplate) | **GET** /templates/{template_id}?full\u0026#x3D;true | Fetch the full attributes for a PDF template\n*DocSpring.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*DocSpring.PDFApi* | [**getSubmission**](docs/PDFApi.md#getSubmission) | **GET** /submissions/{submission_id} | Check the status of a PDF\n*DocSpring.PDFApi* | [**getSubmissionBatch**](docs/PDFApi.md#getSubmissionBatch) | **GET** /submissions/batches/{submission_batch_id} | Check the status of a submission batch job\n*DocSpring.PDFApi* | [**getTemplate**](docs/PDFApi.md#getTemplate) | **GET** /templates/{template_id} | Check the status of an uploaded template\n*DocSpring.PDFApi* | [**getTemplateSchema**](docs/PDFApi.md#getTemplateSchema) | **GET** /templates/{template_id}/schema | Fetch the JSON schema for a template\n*DocSpring.PDFApi* | [**listCombinedSubmissions**](docs/PDFApi.md#listCombinedSubmissions) | **GET** /combined_submissions | Get a list of all combined submissions\n*DocSpring.PDFApi* | [**listFolders**](docs/PDFApi.md#listFolders) | **GET** /folders/ | Get a list of all folders\n*DocSpring.PDFApi* | [**listSubmissions**](docs/PDFApi.md#listSubmissions) | **GET** /submissions | List all submissions\n*DocSpring.PDFApi* | [**listTemplateSubmissions**](docs/PDFApi.md#listTemplateSubmissions) | **GET** /templates/{template_id}/submissions | List all submissions for a given template\n*DocSpring.PDFApi* | [**listTemplates**](docs/PDFApi.md#listTemplates) | **GET** /templates | Get a list of all templates\n*DocSpring.PDFApi* | [**moveFolderToFolder**](docs/PDFApi.md#moveFolderToFolder) | **POST** /folders/{folder_id}/move | Move a folder\n*DocSpring.PDFApi* | [**moveTemplateToFolder**](docs/PDFApi.md#moveTemplateToFolder) | **POST** /templates/{template_id}/move | Move Template to folder\n*DocSpring.PDFApi* | [**publishTemplateVersion**](docs/PDFApi.md#publishTemplateVersion) | **POST** /templates/{template_id}/publish_version | Publish a template version\n*DocSpring.PDFApi* | [**renameFolder**](docs/PDFApi.md#renameFolder) | **POST** /folders/{folder_id}/rename | Rename a folder\n*DocSpring.PDFApi* | [**restoreTemplateVersion**](docs/PDFApi.md#restoreTemplateVersion) | **POST** /templates/{template_id}/restore_version | Restore a template version\n*DocSpring.PDFApi* | [**testAuthentication**](docs/PDFApi.md#testAuthentication) | **GET** /authentication | Test Authentication\n*DocSpring.PDFApi* | [**updateDataRequest**](docs/PDFApi.md#updateDataRequest) | **PUT** /data_requests/{data_request_id} | Update a submission data request\n*DocSpring.PDFApi* | [**updateTemplate**](docs/PDFApi.md#updateTemplate) | **PUT** /templates/{template_id} | Update a Template\n\n\n## Documentation for Models\n\n - [DocSpring.AddFieldsData](docs/AddFieldsData.md)\n - [DocSpring.BatchGeneratePdfs201Response](docs/BatchGeneratePdfs201Response.md)\n - [DocSpring.CombinePdfsData](docs/CombinePdfsData.md)\n - [DocSpring.CombinedSubmission](docs/CombinedSubmission.md)\n - [DocSpring.CombinedSubmissionAction](docs/CombinedSubmissionAction.md)\n - [DocSpring.CombinedSubmissionData](docs/CombinedSubmissionData.md)\n - [DocSpring.CopyTemplateOptions](docs/CopyTemplateOptions.md)\n - [DocSpring.CreateCombinedSubmissionResponse](docs/CreateCombinedSubmissionResponse.md)\n - [DocSpring.CreateCustomFileData](docs/CreateCustomFileData.md)\n - [DocSpring.CreateCustomFileResponse](docs/CreateCustomFileResponse.md)\n - [DocSpring.CreateFolderData](docs/CreateFolderData.md)\n - [DocSpring.CreateHtmlSubmissionData](docs/CreateHtmlSubmissionData.md)\n - [DocSpring.CreateHtmlTemplate](docs/CreateHtmlTemplate.md)\n - [DocSpring.CreatePdfSubmissionData](docs/CreatePdfSubmissionData.md)\n - [DocSpring.CreatePdfTemplate](docs/CreatePdfTemplate.md)\n - [DocSpring.CreateSubmissionDataRequestData](docs/CreateSubmissionDataRequestData.md)\n - [DocSpring.CreateSubmissionDataRequestEventRequest](docs/CreateSubmissionDataRequestEventRequest.md)\n - [DocSpring.CreateSubmissionDataRequestEventResponse](docs/CreateSubmissionDataRequestEventResponse.md)\n - [DocSpring.CreateSubmissionDataRequestResponse](docs/CreateSubmissionDataRequestResponse.md)\n - [DocSpring.CreateSubmissionDataRequestTokenResponse](docs/CreateSubmissionDataRequestTokenResponse.md)\n - [DocSpring.CreateSubmissionResponse](docs/CreateSubmissionResponse.md)\n - [DocSpring.CustomFile](docs/CustomFile.md)\n - [DocSpring.ErrorResponse](docs/ErrorResponse.md)\n - [DocSpring.Folder](docs/Folder.md)\n - [DocSpring.JsonSchema](docs/JsonSchema.md)\n - [DocSpring.ListSubmissionsResponse](docs/ListSubmissionsResponse.md)\n - [DocSpring.MoveFolderData](docs/MoveFolderData.md)\n - [DocSpring.MoveTemplateData](docs/MoveTemplateData.md)\n - [DocSpring.MultipleErrorsResponse](docs/MultipleErrorsResponse.md)\n - [DocSpring.PublishVersionData](docs/PublishVersionData.md)\n - [DocSpring.RenameFolderData](docs/RenameFolderData.md)\n - [DocSpring.RestoreVersionData](docs/RestoreVersionData.md)\n - [DocSpring.Submission](docs/Submission.md)\n - [DocSpring.SubmissionAction](docs/SubmissionAction.md)\n - [DocSpring.SubmissionBatch](docs/SubmissionBatch.md)\n - [DocSpring.SubmissionBatchData](docs/SubmissionBatchData.md)\n - [DocSpring.SubmissionBatchWithSubmissions](docs/SubmissionBatchWithSubmissions.md)\n - [DocSpring.SubmissionDataRequest](docs/SubmissionDataRequest.md)\n - [DocSpring.SubmissionDataRequestEvent](docs/SubmissionDataRequestEvent.md)\n - [DocSpring.SubmissionDataRequestShow](docs/SubmissionDataRequestShow.md)\n - [DocSpring.SubmissionDataRequestToken](docs/SubmissionDataRequestToken.md)\n - [DocSpring.SubmissionPreview](docs/SubmissionPreview.md)\n - [DocSpring.SuccessErrorResponse](docs/SuccessErrorResponse.md)\n - [DocSpring.SuccessMultipleErrorsResponse](docs/SuccessMultipleErrorsResponse.md)\n - [DocSpring.Template](docs/Template.md)\n - [DocSpring.TemplateAddFieldsResponse](docs/TemplateAddFieldsResponse.md)\n - [DocSpring.TemplateDeleteResponse](docs/TemplateDeleteResponse.md)\n - [DocSpring.TemplatePreview](docs/TemplatePreview.md)\n - [DocSpring.TemplatePublishVersionResponse](docs/TemplatePublishVersionResponse.md)\n - [DocSpring.UpdateHtmlTemplate](docs/UpdateHtmlTemplate.md)\n - [DocSpring.UpdateSubmissionDataRequestData](docs/UpdateSubmissionDataRequestData.md)\n - [DocSpring.UploadPresignResponse](docs/UploadPresignResponse.md)\n\n\n## Documentation for Authorization\n\n\nAuthentication schemes defined for the API:\n### api_token_basic\n\n- **Type**: HTTP basic authentication\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdocspring%2Fdocspring-javascript","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fdocspring%2Fdocspring-javascript","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdocspring%2Fdocspring-javascript/lists"}