docspring 1.4.0 → 2.0.0

package/README.md

@@ -1,12 +1,13 @@
 # docspring
 
 DocSpring - JavaScript client for docspring
-DocSpring is a service that helps you fill out and sign PDF templates.
+DocSpring provides an API 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: 1.4.0
-- Build package: com.docspring.codegen.DocSpringJavascriptClientCodegen
+- Package version: 2.0.0
+- Generator version: 7.11.0
+- Build package: org.openapitools.codegen.languages.JavascriptClientCodegen
 
 ## Installation
 
@@ -14,8 +15,7 @@ This SDK is automatically generated by the [OpenAPI Generator](https://openapi-g
 
 #### 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).
+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:
 
@@ -23,10 +23,15 @@ Then install it via:
 npm install docspring --save
 ```
 
+Finally, you need to build the module:
+
+```shell
+npm run build
+```
+
 ##### 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:
+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
@@ -38,19 +43,21 @@ Next, [link](https://docs.npmjs.com/cli/link) it globally in npm with the follow
 npm link
 ```
 
-Finally, switch to the directory you want to use your docspring from, and run:
+To use the link you just defined in your project, switch to the directory you want to use your docspring from, and run:
 
 ```shell
 npm link /path/to/<JAVASCRIPT_CLIENT_DIR>
 ```
 
-You should now be able to `require('docspring')` in javascript files from the directory you ran the last 
-command above from.
+Finally, you need to build the module:
+
+```shell
+npm run build
+```
 
 #### git
-#
-If the library is hosted at a git repository, e.g.
-https://github.com/GIT_USER_ID/GIT_REPO_ID
+
+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
@@ -61,8 +68,7 @@ then install it via:
 
 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):
+perform the following (assuming *main.js* is your entry file):
 
 ```shell
 browserify main.js > bundle.js
@@ -96,16 +102,14 @@ Please follow the [installation](#installation) instruction and execute the foll
 var DocSpring = require('docspring');
 
 var defaultClient = DocSpring.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 DocSpring.PDFApi()
-var templateId = tpl_000000000000000002; // {String} 
-var addFieldsData = new DocSpring.AddFieldsData(); // {AddFieldsData} 
-
+var templateId = "tpl_1234567890abcdef02"; // {String} 
+var data = new DocSpring.AddFieldsData(); // {AddFieldsData} 
 var callback = function(error, data, response) {
   if (error) {
     console.error(error);
@@ -113,32 +117,35 @@ var callback = function(error, data, response) {
     console.log('API called successfully. Returned data: ' + data);
   }
 };
-api.addFieldsToTemplate(templateId, addFieldsData, callback);
+api.addFieldsToTemplate(templateId, data, callback);
 
 ```
 
 ## Documentation for API Endpoints
 
-All URIs are relative to *https://api.docspring.com/api/v1*
+All URIs are relative to *https://sync.api.docspring.com/api/v1*
 
 Class | Method | HTTP request | Description
 ------------ | ------------- | ------------- | -------------
 *DocSpring.PDFApi* | [**addFieldsToTemplate**](docs/PDFApi.md#addFieldsToTemplate) | **PUT** /templates/{template_id}/add_fields | Add new fields to a Template
-*DocSpring.PDFApi* | [**batchGeneratePdfV1**](docs/PDFApi.md#batchGeneratePdfV1) | **POST** /templates/{template_id}/submissions/batch | Generates multiple PDFs
 *DocSpring.PDFApi* | [**batchGeneratePdfs**](docs/PDFApi.md#batchGeneratePdfs) | **POST** /submissions/batches | Generates multiple PDFs
 *DocSpring.PDFApi* | [**combinePdfs**](docs/PDFApi.md#combinePdfs) | **POST** /combined_submissions?v&#x3D;2 | Merge submission PDFs, template PDFs, or custom files
 *DocSpring.PDFApi* | [**combineSubmissions**](docs/PDFApi.md#combineSubmissions) | **POST** /combined_submissions | Merge generated PDFs together
 *DocSpring.PDFApi* | [**copyTemplate**](docs/PDFApi.md#copyTemplate) | **POST** /templates/{template_id}/copy | Copy a Template
 *DocSpring.PDFApi* | [**createCustomFileFromUpload**](docs/PDFApi.md#createCustomFileFromUpload) | **POST** /custom_files | Create a new custom file from a cached presign upload
+*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
 *DocSpring.PDFApi* | [**createDataRequestToken**](docs/PDFApi.md#createDataRequestToken) | **POST** /data_requests/{data_request_id}/tokens | Creates a new data request token for form authentication
 *DocSpring.PDFApi* | [**createFolder**](docs/PDFApi.md#createFolder) | **POST** /folders/ | Create a folder
-*DocSpring.PDFApi* | [**createHTMLTemplate**](docs/PDFApi.md#createHTMLTemplate) | **POST** /templates?desc&#x3D;html | Create a new HTML template
+*DocSpring.PDFApi* | [**createHTMLTemplate**](docs/PDFApi.md#createHTMLTemplate) | **POST** /templates?endpoint_description&#x3D;html | Create a new HTML template
 *DocSpring.PDFApi* | [**createPDFTemplate**](docs/PDFApi.md#createPDFTemplate) | **POST** /templates | Create a new PDF template with a form POST file upload
-*DocSpring.PDFApi* | [**createPDFTemplateFromUpload**](docs/PDFApi.md#createPDFTemplateFromUpload) | **POST** /templates?desc&#x3D;cached_upload | Create a new PDF template from a cached presign upload
+*DocSpring.PDFApi* | [**createPDFTemplateFromUpload**](docs/PDFApi.md#createPDFTemplateFromUpload) | **POST** /templates?endpoint_description&#x3D;cached_upload | Create a new PDF template from a cached presign upload
 *DocSpring.PDFApi* | [**deleteFolder**](docs/PDFApi.md#deleteFolder) | **DELETE** /folders/{folder_id} | Delete a folder
+*DocSpring.PDFApi* | [**deleteTemplate**](docs/PDFApi.md#deleteTemplate) | **DELETE** /templates/{template_id} | Delete a template
 *DocSpring.PDFApi* | [**expireCombinedSubmission**](docs/PDFApi.md#expireCombinedSubmission) | **DELETE** /combined_submissions/{combined_submission_id} | Expire a combined submission
 *DocSpring.PDFApi* | [**expireSubmission**](docs/PDFApi.md#expireSubmission) | **DELETE** /submissions/{submission_id} | Expire a PDF submission
-*DocSpring.PDFApi* | [**generatePDF**](docs/PDFApi.md#generatePDF) | **POST** /templates/{template_id}/submissions | Generates a new PDF
+*DocSpring.PDFApi* | [**generatePdf**](docs/PDFApi.md#generatePdf) | **POST** /templates/{template_id}/submissions | Generates a new PDF
+*DocSpring.PDFApi* | [**generatePdfForHtmlTemplate**](docs/PDFApi.md#generatePdfForHtmlTemplate) | **POST** /templates/{template_id}/submissions?endpoint_description&#x3D;html_templates | Generates a new PDF for an HTML template
+*DocSpring.PDFApi* | [**generatePreview**](docs/PDFApi.md#generatePreview) | **POST** /submissions/{submission_id}/generate_preview | Generated a preview PDF for partially completed data requests
 *DocSpring.PDFApi* | [**getCombinedSubmission**](docs/PDFApi.md#getCombinedSubmission) | **GET** /combined_submissions/{combined_submission_id} | Check the status of a combined submission (merged PDFs)
 *DocSpring.PDFApi* | [**getDataRequest**](docs/PDFApi.md#getDataRequest) | **GET** /data_requests/{data_request_id} | Look up a submission data request
 *DocSpring.PDFApi* | [**getFullTemplate**](docs/PDFApi.md#getFullTemplate) | **GET** /templates/{template_id}?full&#x3D;true | Fetch the full template attributes
@@ -147,9 +154,10 @@ Class | Method | HTTP request | Description
 *DocSpring.PDFApi* | [**getSubmissionBatch**](docs/PDFApi.md#getSubmissionBatch) | **GET** /submissions/batches/{submission_batch_id} | Check the status of a submission batch job
 *DocSpring.PDFApi* | [**getTemplate**](docs/PDFApi.md#getTemplate) | **GET** /templates/{template_id} | Check the status of an uploaded template
 *DocSpring.PDFApi* | [**getTemplateSchema**](docs/PDFApi.md#getTemplateSchema) | **GET** /templates/{template_id}/schema | Fetch the JSON schema for a template
+*DocSpring.PDFApi* | [**listCombinedSubmissions**](docs/PDFApi.md#listCombinedSubmissions) | **GET** /combined_submissions | Get a list of all combined submissions
 *DocSpring.PDFApi* | [**listFolders**](docs/PDFApi.md#listFolders) | **GET** /folders/ | Get a list of all folders
 *DocSpring.PDFApi* | [**listSubmissions**](docs/PDFApi.md#listSubmissions) | **GET** /submissions | List all submissions
-*DocSpring.PDFApi* | [**listSubmissions_0**](docs/PDFApi.md#listSubmissions_0) | **GET** /templates/{template_id}/submissions | List all submissions for a given template
+*DocSpring.PDFApi* | [**listTemplateSubmissions**](docs/PDFApi.md#listTemplateSubmissions) | **GET** /templates/{template_id}/submissions | List all submissions for a given template
 *DocSpring.PDFApi* | [**listTemplates**](docs/PDFApi.md#listTemplates) | **GET** /templates | Get a list of all templates
 *DocSpring.PDFApi* | [**moveFolderToFolder**](docs/PDFApi.md#moveFolderToFolder) | **POST** /folders/{folder_id}/move | Move a folder
 *DocSpring.PDFApi* | [**moveTemplateToFolder**](docs/PDFApi.md#moveTemplateToFolder) | **POST** /templates/{template_id}/move | Move Template to folder
@@ -162,61 +170,59 @@ Class | Method | HTTP request | Description
 ## Documentation for Models
 
  - [DocSpring.AddFieldsData](docs/AddFieldsData.md)
- - [DocSpring.AddFieldsTemplateResponse](docs/AddFieldsTemplateResponse.md)
- - [DocSpring.AuthenticationError](docs/AuthenticationError.md)
- - [DocSpring.AuthenticationSuccessResponse](docs/AuthenticationSuccessResponse.md)
+ - [DocSpring.BatchGeneratePdfs201Response](docs/BatchGeneratePdfs201Response.md)
  - [DocSpring.CombinePdfsData](docs/CombinePdfsData.md)
  - [DocSpring.CombinedSubmission](docs/CombinedSubmission.md)
  - [DocSpring.CombinedSubmissionAction](docs/CombinedSubmissionAction.md)
  - [DocSpring.CombinedSubmissionData](docs/CombinedSubmissionData.md)
- - [DocSpring.CopyTemplateData](docs/CopyTemplateData.md)
+ - [DocSpring.CopyTemplateOptions](docs/CopyTemplateOptions.md)
  - [DocSpring.CreateCombinedSubmissionResponse](docs/CreateCombinedSubmissionResponse.md)
  - [DocSpring.CreateCustomFileData](docs/CreateCustomFileData.md)
  - [DocSpring.CreateCustomFileResponse](docs/CreateCustomFileResponse.md)
  - [DocSpring.CreateFolderData](docs/CreateFolderData.md)
- - [DocSpring.CreateHtmlTemplateData](docs/CreateHtmlTemplateData.md)
- - [DocSpring.CreateSubmissionBatchResponse](docs/CreateSubmissionBatchResponse.md)
- - [DocSpring.CreateSubmissionBatchSubmissionsResponse](docs/CreateSubmissionBatchSubmissionsResponse.md)
+ - [DocSpring.CreateHtmlSubmissionData](docs/CreateHtmlSubmissionData.md)
+ - [DocSpring.CreateHtmlTemplate](docs/CreateHtmlTemplate.md)
+ - [DocSpring.CreatePdfSubmissionData](docs/CreatePdfSubmissionData.md)
+ - [DocSpring.CreatePdfTemplate](docs/CreatePdfTemplate.md)
  - [DocSpring.CreateSubmissionDataRequestData](docs/CreateSubmissionDataRequestData.md)
+ - [DocSpring.CreateSubmissionDataRequestEventRequest](docs/CreateSubmissionDataRequestEventRequest.md)
+ - [DocSpring.CreateSubmissionDataRequestEventResponse](docs/CreateSubmissionDataRequestEventResponse.md)
+ - [DocSpring.CreateSubmissionDataRequestResponse](docs/CreateSubmissionDataRequestResponse.md)
  - [DocSpring.CreateSubmissionDataRequestTokenResponse](docs/CreateSubmissionDataRequestTokenResponse.md)
- - [DocSpring.CreateSubmissionDataRequestTokenResponseToken](docs/CreateSubmissionDataRequestTokenResponseToken.md)
  - [DocSpring.CreateSubmissionResponse](docs/CreateSubmissionResponse.md)
- - [DocSpring.CreateTemplateFromUploadData](docs/CreateTemplateFromUploadData.md)
  - [DocSpring.CustomFile](docs/CustomFile.md)
- - [DocSpring.Error](docs/Error.md)
+ - [DocSpring.ErrorResponse](docs/ErrorResponse.md)
  - [DocSpring.Folder](docs/Folder.md)
- - [DocSpring.FoldersFolder](docs/FoldersFolder.md)
- - [DocSpring.FullTemplate](docs/FullTemplate.md)
- - [DocSpring.FullTemplateDefaults](docs/FullTemplateDefaults.md)
- - [DocSpring.HtmlTemplateData](docs/HtmlTemplateData.md)
- - [DocSpring.InvalidRequest](docs/InvalidRequest.md)
+ - [DocSpring.JsonSchema](docs/JsonSchema.md)
  - [DocSpring.ListSubmissionsResponse](docs/ListSubmissionsResponse.md)
  - [DocSpring.MoveFolderData](docs/MoveFolderData.md)
  - [DocSpring.MoveTemplateData](docs/MoveTemplateData.md)
- - [DocSpring.PendingTemplate](docs/PendingTemplate.md)
+ - [DocSpring.MultipleErrorsResponse](docs/MultipleErrorsResponse.md)
  - [DocSpring.RenameFolderData](docs/RenameFolderData.md)
  - [DocSpring.Submission](docs/Submission.md)
  - [DocSpring.SubmissionAction](docs/SubmissionAction.md)
  - [DocSpring.SubmissionBatch](docs/SubmissionBatch.md)
  - [DocSpring.SubmissionBatchData](docs/SubmissionBatchData.md)
- - [DocSpring.SubmissionData](docs/SubmissionData.md)
- - [DocSpring.SubmissionDataBatchRequest](docs/SubmissionDataBatchRequest.md)
+ - [DocSpring.SubmissionBatchWithSubmissions](docs/SubmissionBatchWithSubmissions.md)
  - [DocSpring.SubmissionDataRequest](docs/SubmissionDataRequest.md)
+ - [DocSpring.SubmissionDataRequestEvent](docs/SubmissionDataRequestEvent.md)
+ - [DocSpring.SubmissionDataRequestShow](docs/SubmissionDataRequestShow.md)
+ - [DocSpring.SubmissionDataRequestToken](docs/SubmissionDataRequestToken.md)
+ - [DocSpring.SubmissionPreview](docs/SubmissionPreview.md)
+ - [DocSpring.SuccessErrorResponse](docs/SuccessErrorResponse.md)
+ - [DocSpring.SuccessMultipleErrorsResponse](docs/SuccessMultipleErrorsResponse.md)
  - [DocSpring.Template](docs/Template.md)
- - [DocSpring.TemplateData](docs/TemplateData.md)
- - [DocSpring.TemplatestemplateIdaddFieldsFields](docs/TemplatestemplateIdaddFieldsFields.md)
- - [DocSpring.UpdateDataRequestResponse](docs/UpdateDataRequestResponse.md)
+ - [DocSpring.TemplateAddFieldsResponse](docs/TemplateAddFieldsResponse.md)
+ - [DocSpring.TemplatePreview](docs/TemplatePreview.md)
+ - [DocSpring.UpdateHtmlTemplate](docs/UpdateHtmlTemplate.md)
  - [DocSpring.UpdateSubmissionDataRequestData](docs/UpdateSubmissionDataRequestData.md)
- - [DocSpring.UpdateTemplateData](docs/UpdateTemplateData.md)
- - [DocSpring.UpdateTemplateResponse](docs/UpdateTemplateResponse.md)
- - [DocSpring.UploadTemplateData](docs/UploadTemplateData.md)
- - [DocSpring.UploadTemplateDataDocument](docs/UploadTemplateDataDocument.md)
- - [DocSpring.UploadTemplateDataDocumentMetadata](docs/UploadTemplateDataDocumentMetadata.md)
+ - [DocSpring.UploadPresignResponse](docs/UploadPresignResponse.md)
 
 
 ## Documentation for Authorization
 
 
+Authentication schemes defined for the API:
 ### api_token_basic
 
 - **Type**: HTTP basic authentication