docspring 1.5.0 → 2.1.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (224) hide show
  1. package/README.md +63 -53
  2. package/dist/ApiClient.js +701 -0
  3. package/dist/api/PDFApi.js +1598 -0
  4. package/dist/index.js +384 -0
  5. package/dist/model/AddFieldsData.js +112 -0
  6. package/dist/model/BatchGeneratePdfs201Response.js +184 -0
  7. package/dist/model/CombinePdfsData.js +156 -0
  8. package/dist/model/CombinedSubmission.js +323 -0
  9. package/dist/model/CombinedSubmissionAction.js +252 -0
  10. package/dist/model/CombinedSubmissionData.js +148 -0
  11. package/dist/model/CopyTemplateOptions.js +124 -0
  12. package/dist/model/CreateCombinedSubmissionResponse.js +158 -0
  13. package/dist/model/CreateCustomFileData.js +112 -0
  14. package/dist/model/CreateCustomFileResponse.js +158 -0
  15. package/dist/model/CreateFolderData.js +108 -0
  16. package/dist/model/CreateHtmlSubmissionData.js +173 -0
  17. package/dist/model/CreateHtmlTemplate.js +108 -0
  18. package/dist/model/CreatePdfSubmissionData.js +202 -0
  19. package/dist/model/CreatePdfTemplate.js +108 -0
  20. package/dist/model/CreateSubmissionDataRequestData.js +210 -0
  21. package/dist/model/CreateSubmissionDataRequestEventRequest.js +215 -0
  22. package/dist/model/CreateSubmissionDataRequestEventResponse.js +158 -0
  23. package/dist/model/CreateSubmissionDataRequestResponse.js +158 -0
  24. package/dist/model/CreateSubmissionDataRequestTokenResponse.js +158 -0
  25. package/dist/model/CreateSubmissionResponse.js +158 -0
  26. package/dist/model/CustomFile.js +126 -0
  27. package/dist/model/ErrorResponse.js +139 -0
  28. package/dist/model/Folder.js +154 -0
  29. package/dist/model/JsonSchema.js +173 -0
  30. package/dist/model/ListSubmissionsResponse.js +154 -0
  31. package/dist/model/MoveFolderData.js +89 -0
  32. package/dist/model/MoveTemplateData.js +112 -0
  33. package/dist/model/MultipleErrorsResponse.js +139 -0
  34. package/dist/model/PublishVersionData.js +124 -0
  35. package/dist/model/RenameFolderData.js +112 -0
  36. package/dist/model/RestoreVersionData.js +112 -0
  37. package/dist/model/Submission.js +583 -0
  38. package/dist/model/SubmissionAction.js +252 -0
  39. package/dist/model/SubmissionBatch.js +213 -0
  40. package/dist/model/SubmissionBatchData.js +128 -0
  41. package/dist/model/SubmissionBatchWithSubmissions.js +243 -0
  42. package/dist/model/SubmissionDataRequest.js +475 -0
  43. package/dist/model/SubmissionDataRequestEvent.js +287 -0
  44. package/dist/model/SubmissionDataRequestShow.js +489 -0
  45. package/dist/model/SubmissionDataRequestToken.js +154 -0
  46. package/dist/model/SubmissionPreview.js +517 -0
  47. package/dist/model/SuccessErrorResponse.js +142 -0
  48. package/dist/model/SuccessMultipleErrorsResponse.js +142 -0
  49. package/dist/model/Template.js +833 -0
  50. package/dist/model/TemplateAddFieldsResponse.js +154 -0
  51. package/dist/model/TemplateDeleteResponse.js +166 -0
  52. package/dist/model/TemplatePreview.js +695 -0
  53. package/dist/model/TemplatePublishVersionResponse.js +152 -0
  54. package/dist/model/UpdateHtmlTemplate.js +108 -0
  55. package/dist/model/UpdateSubmissionDataRequestData.js +160 -0
  56. package/dist/model/UploadPresignResponse.js +157 -0
  57. package/package.json +33 -8
  58. package/.openapi-generator/VERSION +0 -1
  59. package/.openapi-generator-ignore +0 -23
  60. package/.travis.yml +0 -7
  61. package/CHANGELOG.md +0 -37
  62. package/docs/AddFieldsData.md +0 -8
  63. package/docs/AddFieldsTemplateResponse.md +0 -21
  64. package/docs/AuthenticationError.md +0 -18
  65. package/docs/AuthenticationSuccessResponse.md +0 -17
  66. package/docs/CombinePdfsData.md +0 -13
  67. package/docs/CombinedSubmission.md +0 -33
  68. package/docs/CombinedSubmissionAction.md +0 -54
  69. package/docs/CombinedSubmissionData.md +0 -12
  70. package/docs/CopyTemplateData.md +0 -9
  71. package/docs/CreateCombinedSubmissionResponse.md +0 -21
  72. package/docs/CreateCustomFileData.md +0 -8
  73. package/docs/CreateCustomFileResponse.md +0 -21
  74. package/docs/CreateFolderData.md +0 -8
  75. package/docs/CreateHtmlTemplateData.md +0 -8
  76. package/docs/CreateSubmissionBatchResponse.md +0 -23
  77. package/docs/CreateSubmissionBatchSubmissionsResponse.md +0 -23
  78. package/docs/CreateSubmissionDataRequestData.md +0 -60
  79. package/docs/CreateSubmissionDataRequestTokenResponse.md +0 -21
  80. package/docs/CreateSubmissionDataRequestTokenResponseToken.md +0 -11
  81. package/docs/CreateSubmissionResponse.md +0 -21
  82. package/docs/CreateTemplateFromUploadData.md +0 -8
  83. package/docs/CustomFile.md +0 -9
  84. package/docs/Error.md +0 -18
  85. package/docs/Folder.md +0 -11
  86. package/docs/FoldersFolder.md +0 -9
  87. package/docs/FullTemplate.md +0 -59
  88. package/docs/FullTemplateDefaults.md +0 -10
  89. package/docs/HtmlTemplateData.md +0 -48
  90. package/docs/InvalidRequest.md +0 -18
  91. package/docs/ListSubmissionsResponse.md +0 -10
  92. package/docs/MoveFolderData.md +0 -8
  93. package/docs/MoveTemplateData.md +0 -8
  94. package/docs/PDFApi.md +0 -1800
  95. package/docs/PendingTemplate.md +0 -37
  96. package/docs/RenameFolderData.md +0 -8
  97. package/docs/Submission.md +0 -55
  98. package/docs/SubmissionAction.md +0 -54
  99. package/docs/SubmissionBatch.md +0 -29
  100. package/docs/SubmissionBatchData.md +0 -11
  101. package/docs/SubmissionData.md +0 -16
  102. package/docs/SubmissionDataBatchRequest.md +0 -13
  103. package/docs/SubmissionDataRequest.md +0 -79
  104. package/docs/Template.md +0 -40
  105. package/docs/TemplateData.md +0 -36
  106. package/docs/TemplatestemplateIdaddFieldsFields.md +0 -286
  107. package/docs/UpdateDataRequestResponse.md +0 -21
  108. package/docs/UpdateSubmissionDataRequestData.md +0 -60
  109. package/docs/UpdateTemplateData.md +0 -8
  110. package/docs/UpdateTemplateResponse.md +0 -20
  111. package/docs/UploadTemplateData.md +0 -49
  112. package/docs/UploadTemplateDataDocument.md +0 -19
  113. package/docs/UploadTemplateDataDocumentMetadata.md +0 -19
  114. package/git_push.sh +0 -52
  115. package/mocha.opts +0 -1
  116. package/src/ApiClient.js +0 -605
  117. package/src/api/Client.js +0 -408
  118. package/src/api/PDFApi.js +0 -1815
  119. package/src/index.js +0 -334
  120. package/src/model/AddFieldsData.js +0 -82
  121. package/src/model/AddFieldsTemplateResponse.js +0 -114
  122. package/src/model/AuthenticationError.js +0 -102
  123. package/src/model/AuthenticationSuccessResponse.js +0 -93
  124. package/src/model/CombinePdfsData.js +0 -122
  125. package/src/model/CombinedSubmission.js +0 -199
  126. package/src/model/CombinedSubmissionAction.js +0 -198
  127. package/src/model/CombinedSubmissionData.js +0 -114
  128. package/src/model/CopyTemplateData.js +0 -90
  129. package/src/model/CreateCombinedSubmissionResponse.js +0 -114
  130. package/src/model/CreateCustomFileData.js +0 -82
  131. package/src/model/CreateCustomFileResponse.js +0 -114
  132. package/src/model/CreateFolderData.js +0 -82
  133. package/src/model/CreateHtmlTemplateData.js +0 -82
  134. package/src/model/CreateSubmissionBatchResponse.js +0 -130
  135. package/src/model/CreateSubmissionBatchSubmissionsResponse.js +0 -119
  136. package/src/model/CreateSubmissionDataRequestData.js +0 -256
  137. package/src/model/CreateSubmissionDataRequestTokenResponse.js +0 -114
  138. package/src/model/CreateSubmissionDataRequestTokenResponseToken.js +0 -105
  139. package/src/model/CreateSubmissionResponse.js +0 -114
  140. package/src/model/CreateTemplateFromUploadData.js +0 -82
  141. package/src/model/CustomFile.js +0 -89
  142. package/src/model/Error.js +0 -103
  143. package/src/model/Folder.js +0 -105
  144. package/src/model/FoldersFolder.js +0 -89
  145. package/src/model/FullTemplate.js +0 -407
  146. package/src/model/FullTemplateDefaults.js +0 -97
  147. package/src/model/HtmlTemplateData.js +0 -248
  148. package/src/model/InvalidRequest.js +0 -103
  149. package/src/model/ListSubmissionsResponse.js +0 -97
  150. package/src/model/MoveFolderData.js +0 -81
  151. package/src/model/MoveTemplateData.js +0 -82
  152. package/src/model/PendingTemplate.js +0 -231
  153. package/src/model/RenameFolderData.js +0 -82
  154. package/src/model/Submission.js +0 -291
  155. package/src/model/SubmissionAction.js +0 -198
  156. package/src/model/SubmissionBatch.js +0 -167
  157. package/src/model/SubmissionBatchData.js +0 -106
  158. package/src/model/SubmissionData.js +0 -146
  159. package/src/model/SubmissionDataBatchRequest.js +0 -121
  160. package/src/model/SubmissionDataRequest.js +0 -345
  161. package/src/model/Template.js +0 -255
  162. package/src/model/TemplateData.js +0 -223
  163. package/src/model/TemplatestemplateIdaddFieldsFields.js +0 -1128
  164. package/src/model/UpdateDataRequestResponse.js +0 -114
  165. package/src/model/UpdateSubmissionDataRequestData.js +0 -256
  166. package/src/model/UpdateTemplateData.js +0 -82
  167. package/src/model/UpdateTemplateResponse.js +0 -106
  168. package/src/model/UploadTemplateData.js +0 -256
  169. package/src/model/UploadTemplateDataDocument.js +0 -109
  170. package/src/model/UploadTemplateDataDocumentMetadata.js +0 -109
  171. package/test/api/ClientIntegration.spec.js +0 -281
  172. package/test/api/PDFApi.spec.js.original +0 -415
  173. package/test/api/PDFApiIntegration.spec.js +0 -305
  174. package/test/model/AddFieldsData.spec.js +0 -67
  175. package/test/model/AddFieldsTemplateResponse.spec.js +0 -79
  176. package/test/model/AuthenticationError.spec.js +0 -73
  177. package/test/model/AuthenticationSuccessResponse.spec.js +0 -67
  178. package/test/model/CombinePdfsData.spec.js +0 -97
  179. package/test/model/CombinedSubmission.spec.js +0 -139
  180. package/test/model/CombinedSubmissionAction.spec.js +0 -97
  181. package/test/model/CombinedSubmissionData.spec.js +0 -91
  182. package/test/model/CopyTemplateData.spec.js +0 -73
  183. package/test/model/CreateCombinedSubmissionResponse.spec.js +0 -79
  184. package/test/model/CreateCustomFileData.spec.js +0 -67
  185. package/test/model/CreateCustomFileResponse.spec.js +0 -79
  186. package/test/model/CreateFolderData.spec.js +0 -67
  187. package/test/model/CreateHtmlTemplateData.spec.js +0 -67
  188. package/test/model/CreateSubmissionBatchResponse.spec.js +0 -91
  189. package/test/model/CreateSubmissionBatchSubmissionsResponse.spec.js +0 -79
  190. package/test/model/CreateSubmissionDataRequestData.spec.js +0 -139
  191. package/test/model/CreateSubmissionDataRequestTokenResponse.spec.js +0 -79
  192. package/test/model/CreateSubmissionDataRequestTokenResponseToken.spec.js +0 -85
  193. package/test/model/CreateSubmissionResponse.spec.js +0 -79
  194. package/test/model/CreateTemplateFromUploadData.spec.js +0 -67
  195. package/test/model/CustomFile.spec.js +0 -73
  196. package/test/model/Error.spec.js +0 -73
  197. package/test/model/Folder.spec.js +0 -85
  198. package/test/model/FoldersFolder.spec.js +0 -73
  199. package/test/model/FullTemplate.spec.js +0 -295
  200. package/test/model/FullTemplateDefaults.spec.js +0 -79
  201. package/test/model/HtmlTemplateData.spec.js +0 -163
  202. package/test/model/InvalidRequest.spec.js +0 -73
  203. package/test/model/ListSubmissionsResponse.spec.js +0 -79
  204. package/test/model/MoveFolderData.spec.js +0 -67
  205. package/test/model/MoveTemplateData.spec.js +0 -67
  206. package/test/model/PendingTemplate.spec.js +0 -163
  207. package/test/model/RenameFolderData.spec.js +0 -67
  208. package/test/model/Submission.spec.js +0 -175
  209. package/test/model/SubmissionAction.spec.js +0 -97
  210. package/test/model/SubmissionBatch.spec.js +0 -115
  211. package/test/model/SubmissionBatchData.spec.js +0 -85
  212. package/test/model/SubmissionData.spec.js +0 -115
  213. package/test/model/SubmissionDataBatchRequest.spec.js +0 -97
  214. package/test/model/SubmissionDataRequest.spec.js +0 -187
  215. package/test/model/Template.spec.js +0 -181
  216. package/test/model/TemplateData.spec.js +0 -157
  217. package/test/model/TemplatestemplateIdaddFieldsFields.spec.js +0 -577
  218. package/test/model/UpdateDataRequestResponse.spec.js +0 -79
  219. package/test/model/UpdateSubmissionDataRequestData.spec.js +0 -139
  220. package/test/model/UpdateTemplateData.spec.js +0 -67
  221. package/test/model/UpdateTemplateResponse.spec.js +0 -73
  222. package/test/model/UploadTemplateData.spec.js +0 -169
  223. package/test/model/UploadTemplateDataDocument.spec.js +0 -79
  224. package/test/model/UploadTemplateDataDocumentMetadata.spec.js +0 -79
package/docs/PDFApi.md DELETED
@@ -1,1800 +0,0 @@
1
- # DocSpring.PDFApi
2
-
3
- All URIs are relative to *https://api.docspring.com/api/v1*
4
-
5
- Method | HTTP request | Description
6
- ------------- | ------------- | -------------
7
- [**addFieldsToTemplate**](PDFApi.md#addFieldsToTemplate) | **PUT** /templates/{template_id}/add_fields | Add new fields to a Template
8
- [**batchGeneratePdfV1**](PDFApi.md#batchGeneratePdfV1) | **POST** /templates/{template_id}/submissions/batch | Generates multiple PDFs
9
- [**batchGeneratePdfs**](PDFApi.md#batchGeneratePdfs) | **POST** /submissions/batches | Generates multiple PDFs
10
- [**combinePdfs**](PDFApi.md#combinePdfs) | **POST** /combined_submissions?v=2 | Merge submission PDFs, template PDFs, or custom files
11
- [**combineSubmissions**](PDFApi.md#combineSubmissions) | **POST** /combined_submissions | Merge generated PDFs together
12
- [**copyTemplate**](PDFApi.md#copyTemplate) | **POST** /templates/{template_id}/copy | Copy a Template
13
- [**createCustomFileFromUpload**](PDFApi.md#createCustomFileFromUpload) | **POST** /custom_files | Create a new custom file from a cached presign upload
14
- [**createDataRequestToken**](PDFApi.md#createDataRequestToken) | **POST** /data_requests/{data_request_id}/tokens | Creates a new data request token for form authentication
15
- [**createFolder**](PDFApi.md#createFolder) | **POST** /folders/ | Create a folder
16
- [**createHTMLTemplate**](PDFApi.md#createHTMLTemplate) | **POST** /templates?desc=html | Create a new HTML template
17
- [**createPDFTemplate**](PDFApi.md#createPDFTemplate) | **POST** /templates | Create a new PDF template with a form POST file upload
18
- [**createPDFTemplateFromUpload**](PDFApi.md#createPDFTemplateFromUpload) | **POST** /templates?desc=cached_upload | Create a new PDF template from a cached presign upload
19
- [**deleteFolder**](PDFApi.md#deleteFolder) | **DELETE** /folders/{folder_id} | Delete a folder
20
- [**deleteTemplate**](PDFApi.md#deleteTemplate) | **DELETE** /templates/{template_id} | Delete a template
21
- [**expireCombinedSubmission**](PDFApi.md#expireCombinedSubmission) | **DELETE** /combined_submissions/{combined_submission_id} | Expire a combined submission
22
- [**expireSubmission**](PDFApi.md#expireSubmission) | **DELETE** /submissions/{submission_id} | Expire a PDF submission
23
- [**generatePDF**](PDFApi.md#generatePDF) | **POST** /templates/{template_id}/submissions | Generates a new PDF
24
- [**getCombinedSubmission**](PDFApi.md#getCombinedSubmission) | **GET** /combined_submissions/{combined_submission_id} | Check the status of a combined submission (merged PDFs)
25
- [**getDataRequest**](PDFApi.md#getDataRequest) | **GET** /data_requests/{data_request_id} | Look up a submission data request
26
- [**getFullTemplate**](PDFApi.md#getFullTemplate) | **GET** /templates/{template_id}?full=true | Fetch the full template attributes
27
- [**getPresignUrl**](PDFApi.md#getPresignUrl) | **GET** /uploads/presign | Get a presigned URL so that you can upload a file to our AWS S3 bucket
28
- [**getSubmission**](PDFApi.md#getSubmission) | **GET** /submissions/{submission_id} | Check the status of a PDF
29
- [**getSubmissionBatch**](PDFApi.md#getSubmissionBatch) | **GET** /submissions/batches/{submission_batch_id} | Check the status of a submission batch job
30
- [**getTemplate**](PDFApi.md#getTemplate) | **GET** /templates/{template_id} | Check the status of an uploaded template
31
- [**getTemplateSchema**](PDFApi.md#getTemplateSchema) | **GET** /templates/{template_id}/schema | Fetch the JSON schema for a template
32
- [**listCombinedSubmissions**](PDFApi.md#listCombinedSubmissions) | **GET** /combined_submissions | Get a list of all combined submissions
33
- [**listFolders**](PDFApi.md#listFolders) | **GET** /folders/ | Get a list of all folders
34
- [**listSubmissions**](PDFApi.md#listSubmissions) | **GET** /submissions | List all submissions
35
- [**listSubmissions_0**](PDFApi.md#listSubmissions_0) | **GET** /templates/{template_id}/submissions | List all submissions for a given template
36
- [**listTemplates**](PDFApi.md#listTemplates) | **GET** /templates | Get a list of all templates
37
- [**moveFolderToFolder**](PDFApi.md#moveFolderToFolder) | **POST** /folders/{folder_id}/move | Move a folder
38
- [**moveTemplateToFolder**](PDFApi.md#moveTemplateToFolder) | **POST** /templates/{template_id}/move | Move Template to folder
39
- [**renameFolder**](PDFApi.md#renameFolder) | **POST** /folders/{folder_id}/rename | Rename a folder
40
- [**testAuthentication**](PDFApi.md#testAuthentication) | **GET** /authentication | Test Authentication
41
- [**updateDataRequest**](PDFApi.md#updateDataRequest) | **PUT** /data_requests/{data_request_id} | Update a submission data request
42
- [**updateTemplate**](PDFApi.md#updateTemplate) | **PUT** /templates/{template_id} | Update a Template
43
-
44
-
45
- <a name="addFieldsToTemplate"></a>
46
- # **addFieldsToTemplate**
47
- > AddFieldsTemplateResponse addFieldsToTemplate(templateId, addFieldsData)
48
-
49
- Add new fields to a Template
50
-
51
- ### Example
52
- ```javascript
53
- var DocSpring = require('docspring');
54
- var defaultClient = DocSpring.ApiClient.instance;
55
-
56
- // Configure HTTP basic authorization: api_token_basic
57
- var api_token_basic = defaultClient.authentications['api_token_basic'];
58
- api_token_basic.username = 'YOUR USERNAME';
59
- api_token_basic.password = 'YOUR PASSWORD';
60
-
61
- var apiInstance = new DocSpring.PDFApi();
62
- var templateId = tpl_000000000000000002; // String |
63
- var addFieldsData = new DocSpring.AddFieldsData(); // AddFieldsData |
64
- var callback = function(error, data, response) {
65
- if (error) {
66
- console.error(error);
67
- } else {
68
- console.log('API called successfully. Returned data: ' + data);
69
- }
70
- };
71
- apiInstance.addFieldsToTemplate(templateId, addFieldsData, callback);
72
- ```
73
-
74
- ### Parameters
75
-
76
- Name | Type | Description | Notes
77
- ------------- | ------------- | ------------- | -------------
78
- **templateId** | **String**| |
79
- **addFieldsData** | [**AddFieldsData**](AddFieldsData.md)| |
80
-
81
- ### Return type
82
-
83
- [**AddFieldsTemplateResponse**](AddFieldsTemplateResponse.md)
84
-
85
- ### Authorization
86
-
87
- [api_token_basic](../README.md#api_token_basic)
88
-
89
- ### HTTP request headers
90
-
91
- - **Content-Type**: application/json
92
- - **Accept**: application/json
93
-
94
- <a name="batchGeneratePdfV1"></a>
95
- # **batchGeneratePdfV1**
96
- > [CreateSubmissionResponse] batchGeneratePdfV1(templateId, requestBody)
97
-
98
- Generates multiple PDFs
99
-
100
- ### Example
101
- ```javascript
102
- var DocSpring = require('docspring');
103
- var defaultClient = DocSpring.ApiClient.instance;
104
-
105
- // Configure HTTP basic authorization: api_token_basic
106
- var api_token_basic = defaultClient.authentications['api_token_basic'];
107
- api_token_basic.username = 'YOUR USERNAME';
108
- api_token_basic.password = 'YOUR PASSWORD';
109
-
110
- var apiInstance = new DocSpring.PDFApi();
111
- var templateId = tpl_000000000000000001; // String |
112
- var requestBody = [null]; // [Object] |
113
- var callback = function(error, data, response) {
114
- if (error) {
115
- console.error(error);
116
- } else {
117
- console.log('API called successfully. Returned data: ' + data);
118
- }
119
- };
120
- apiInstance.batchGeneratePdfV1(templateId, requestBody, callback);
121
- ```
122
-
123
- ### Parameters
124
-
125
- Name | Type | Description | Notes
126
- ------------- | ------------- | ------------- | -------------
127
- **templateId** | **String**| |
128
- **requestBody** | [**[Object]**](Array.md)| |
129
-
130
- ### Return type
131
-
132
- [**[CreateSubmissionResponse]**](CreateSubmissionResponse.md)
133
-
134
- ### Authorization
135
-
136
- [api_token_basic](../README.md#api_token_basic)
137
-
138
- ### HTTP request headers
139
-
140
- - **Content-Type**: application/json
141
- - **Accept**: application/json
142
-
143
- <a name="batchGeneratePdfs"></a>
144
- # **batchGeneratePdfs**
145
- > CreateSubmissionBatchResponse batchGeneratePdfs(submissionBatchData)
146
-
147
- Generates multiple PDFs
148
-
149
- ### Example
150
- ```javascript
151
- var DocSpring = require('docspring');
152
- var defaultClient = DocSpring.ApiClient.instance;
153
-
154
- // Configure HTTP basic authorization: api_token_basic
155
- var api_token_basic = defaultClient.authentications['api_token_basic'];
156
- api_token_basic.username = 'YOUR USERNAME';
157
- api_token_basic.password = 'YOUR PASSWORD';
158
-
159
- var apiInstance = new DocSpring.PDFApi();
160
- var submissionBatchData = new DocSpring.SubmissionBatchData(); // SubmissionBatchData |
161
- var callback = function(error, data, response) {
162
- if (error) {
163
- console.error(error);
164
- } else {
165
- console.log('API called successfully. Returned data: ' + data);
166
- }
167
- };
168
- apiInstance.batchGeneratePdfs(submissionBatchData, callback);
169
- ```
170
-
171
- ### Parameters
172
-
173
- Name | Type | Description | Notes
174
- ------------- | ------------- | ------------- | -------------
175
- **submissionBatchData** | [**SubmissionBatchData**](SubmissionBatchData.md)| |
176
-
177
- ### Return type
178
-
179
- [**CreateSubmissionBatchResponse**](CreateSubmissionBatchResponse.md)
180
-
181
- ### Authorization
182
-
183
- [api_token_basic](../README.md#api_token_basic)
184
-
185
- ### HTTP request headers
186
-
187
- - **Content-Type**: application/json
188
- - **Accept**: application/json
189
-
190
- <a name="combinePdfs"></a>
191
- # **combinePdfs**
192
- > CreateCombinedSubmissionResponse combinePdfs(combinePdfsData)
193
-
194
- Merge submission PDFs, template PDFs, or custom files
195
-
196
- ### Example
197
- ```javascript
198
- var DocSpring = require('docspring');
199
- var defaultClient = DocSpring.ApiClient.instance;
200
-
201
- // Configure HTTP basic authorization: api_token_basic
202
- var api_token_basic = defaultClient.authentications['api_token_basic'];
203
- api_token_basic.username = 'YOUR USERNAME';
204
- api_token_basic.password = 'YOUR PASSWORD';
205
-
206
- var apiInstance = new DocSpring.PDFApi();
207
- var combinePdfsData = new DocSpring.CombinePdfsData(); // CombinePdfsData |
208
- var callback = function(error, data, response) {
209
- if (error) {
210
- console.error(error);
211
- } else {
212
- console.log('API called successfully. Returned data: ' + data);
213
- }
214
- };
215
- apiInstance.combinePdfs(combinePdfsData, callback);
216
- ```
217
-
218
- ### Parameters
219
-
220
- Name | Type | Description | Notes
221
- ------------- | ------------- | ------------- | -------------
222
- **combinePdfsData** | [**CombinePdfsData**](CombinePdfsData.md)| |
223
-
224
- ### Return type
225
-
226
- [**CreateCombinedSubmissionResponse**](CreateCombinedSubmissionResponse.md)
227
-
228
- ### Authorization
229
-
230
- [api_token_basic](../README.md#api_token_basic)
231
-
232
- ### HTTP request headers
233
-
234
- - **Content-Type**: application/json
235
- - **Accept**: application/json
236
-
237
- <a name="combineSubmissions"></a>
238
- # **combineSubmissions**
239
- > CreateCombinedSubmissionResponse combineSubmissions(combinedSubmissionData)
240
-
241
- Merge generated PDFs together
242
-
243
- ### Example
244
- ```javascript
245
- var DocSpring = require('docspring');
246
- var defaultClient = DocSpring.ApiClient.instance;
247
-
248
- // Configure HTTP basic authorization: api_token_basic
249
- var api_token_basic = defaultClient.authentications['api_token_basic'];
250
- api_token_basic.username = 'YOUR USERNAME';
251
- api_token_basic.password = 'YOUR PASSWORD';
252
-
253
- var apiInstance = new DocSpring.PDFApi();
254
- var combinedSubmissionData = new DocSpring.CombinedSubmissionData(); // CombinedSubmissionData |
255
- var callback = function(error, data, response) {
256
- if (error) {
257
- console.error(error);
258
- } else {
259
- console.log('API called successfully. Returned data: ' + data);
260
- }
261
- };
262
- apiInstance.combineSubmissions(combinedSubmissionData, callback);
263
- ```
264
-
265
- ### Parameters
266
-
267
- Name | Type | Description | Notes
268
- ------------- | ------------- | ------------- | -------------
269
- **combinedSubmissionData** | [**CombinedSubmissionData**](CombinedSubmissionData.md)| |
270
-
271
- ### Return type
272
-
273
- [**CreateCombinedSubmissionResponse**](CreateCombinedSubmissionResponse.md)
274
-
275
- ### Authorization
276
-
277
- [api_token_basic](../README.md#api_token_basic)
278
-
279
- ### HTTP request headers
280
-
281
- - **Content-Type**: application/json
282
- - **Accept**: application/json
283
-
284
- <a name="copyTemplate"></a>
285
- # **copyTemplate**
286
- > Template copyTemplate(templateId, copyTemplateData)
287
-
288
- Copy a Template
289
-
290
- ### Example
291
- ```javascript
292
- var DocSpring = require('docspring');
293
- var defaultClient = DocSpring.ApiClient.instance;
294
-
295
- // Configure HTTP basic authorization: api_token_basic
296
- var api_token_basic = defaultClient.authentications['api_token_basic'];
297
- api_token_basic.username = 'YOUR USERNAME';
298
- api_token_basic.password = 'YOUR PASSWORD';
299
-
300
- var apiInstance = new DocSpring.PDFApi();
301
- var templateId = tpl_000000000000000001; // String |
302
- var copyTemplateData = new DocSpring.CopyTemplateData(); // CopyTemplateData |
303
- var callback = function(error, data, response) {
304
- if (error) {
305
- console.error(error);
306
- } else {
307
- console.log('API called successfully. Returned data: ' + data);
308
- }
309
- };
310
- apiInstance.copyTemplate(templateId, copyTemplateData, callback);
311
- ```
312
-
313
- ### Parameters
314
-
315
- Name | Type | Description | Notes
316
- ------------- | ------------- | ------------- | -------------
317
- **templateId** | **String**| |
318
- **copyTemplateData** | [**CopyTemplateData**](CopyTemplateData.md)| |
319
-
320
- ### Return type
321
-
322
- [**Template**](Template.md)
323
-
324
- ### Authorization
325
-
326
- [api_token_basic](../README.md#api_token_basic)
327
-
328
- ### HTTP request headers
329
-
330
- - **Content-Type**: application/json
331
- - **Accept**: application/json
332
-
333
- <a name="createCustomFileFromUpload"></a>
334
- # **createCustomFileFromUpload**
335
- > CreateCustomFileResponse createCustomFileFromUpload(createCustomFileData)
336
-
337
- Create a new custom file from a cached presign upload
338
-
339
- ### Example
340
- ```javascript
341
- var DocSpring = require('docspring');
342
- var defaultClient = DocSpring.ApiClient.instance;
343
-
344
- // Configure HTTP basic authorization: api_token_basic
345
- var api_token_basic = defaultClient.authentications['api_token_basic'];
346
- api_token_basic.username = 'YOUR USERNAME';
347
- api_token_basic.password = 'YOUR PASSWORD';
348
-
349
- var apiInstance = new DocSpring.PDFApi();
350
- var createCustomFileData = new DocSpring.CreateCustomFileData(); // CreateCustomFileData |
351
- var callback = function(error, data, response) {
352
- if (error) {
353
- console.error(error);
354
- } else {
355
- console.log('API called successfully. Returned data: ' + data);
356
- }
357
- };
358
- apiInstance.createCustomFileFromUpload(createCustomFileData, callback);
359
- ```
360
-
361
- ### Parameters
362
-
363
- Name | Type | Description | Notes
364
- ------------- | ------------- | ------------- | -------------
365
- **createCustomFileData** | [**CreateCustomFileData**](CreateCustomFileData.md)| |
366
-
367
- ### Return type
368
-
369
- [**CreateCustomFileResponse**](CreateCustomFileResponse.md)
370
-
371
- ### Authorization
372
-
373
- [api_token_basic](../README.md#api_token_basic)
374
-
375
- ### HTTP request headers
376
-
377
- - **Content-Type**: application/json
378
- - **Accept**: application/json
379
-
380
- <a name="createDataRequestToken"></a>
381
- # **createDataRequestToken**
382
- > CreateSubmissionDataRequestTokenResponse createDataRequestToken(dataRequestId)
383
-
384
- Creates a new data request token for form authentication
385
-
386
- ### Example
387
- ```javascript
388
- var DocSpring = require('docspring');
389
- var defaultClient = DocSpring.ApiClient.instance;
390
-
391
- // Configure HTTP basic authorization: api_token_basic
392
- var api_token_basic = defaultClient.authentications['api_token_basic'];
393
- api_token_basic.username = 'YOUR USERNAME';
394
- api_token_basic.password = 'YOUR PASSWORD';
395
-
396
- var apiInstance = new DocSpring.PDFApi();
397
- var dataRequestId = drq_000000000000000001; // String |
398
- var callback = function(error, data, response) {
399
- if (error) {
400
- console.error(error);
401
- } else {
402
- console.log('API called successfully. Returned data: ' + data);
403
- }
404
- };
405
- apiInstance.createDataRequestToken(dataRequestId, callback);
406
- ```
407
-
408
- ### Parameters
409
-
410
- Name | Type | Description | Notes
411
- ------------- | ------------- | ------------- | -------------
412
- **dataRequestId** | **String**| |
413
-
414
- ### Return type
415
-
416
- [**CreateSubmissionDataRequestTokenResponse**](CreateSubmissionDataRequestTokenResponse.md)
417
-
418
- ### Authorization
419
-
420
- [api_token_basic](../README.md#api_token_basic)
421
-
422
- ### HTTP request headers
423
-
424
- - **Content-Type**: Not defined
425
- - **Accept**: application/json
426
-
427
- <a name="createFolder"></a>
428
- # **createFolder**
429
- > Folder createFolder(createFolderData)
430
-
431
- Create a folder
432
-
433
- ### Example
434
- ```javascript
435
- var DocSpring = require('docspring');
436
- var defaultClient = DocSpring.ApiClient.instance;
437
-
438
- // Configure HTTP basic authorization: api_token_basic
439
- var api_token_basic = defaultClient.authentications['api_token_basic'];
440
- api_token_basic.username = 'YOUR USERNAME';
441
- api_token_basic.password = 'YOUR PASSWORD';
442
-
443
- var apiInstance = new DocSpring.PDFApi();
444
- var createFolderData = new DocSpring.CreateFolderData(); // CreateFolderData |
445
- var callback = function(error, data, response) {
446
- if (error) {
447
- console.error(error);
448
- } else {
449
- console.log('API called successfully. Returned data: ' + data);
450
- }
451
- };
452
- apiInstance.createFolder(createFolderData, callback);
453
- ```
454
-
455
- ### Parameters
456
-
457
- Name | Type | Description | Notes
458
- ------------- | ------------- | ------------- | -------------
459
- **createFolderData** | [**CreateFolderData**](CreateFolderData.md)| |
460
-
461
- ### Return type
462
-
463
- [**Folder**](Folder.md)
464
-
465
- ### Authorization
466
-
467
- [api_token_basic](../README.md#api_token_basic)
468
-
469
- ### HTTP request headers
470
-
471
- - **Content-Type**: application/json
472
- - **Accept**: application/json
473
-
474
- <a name="createHTMLTemplate"></a>
475
- # **createHTMLTemplate**
476
- > PendingTemplate createHTMLTemplate(createHtmlTemplateData)
477
-
478
- Create a new HTML template
479
-
480
- ### Example
481
- ```javascript
482
- var DocSpring = require('docspring');
483
- var defaultClient = DocSpring.ApiClient.instance;
484
-
485
- // Configure HTTP basic authorization: api_token_basic
486
- var api_token_basic = defaultClient.authentications['api_token_basic'];
487
- api_token_basic.username = 'YOUR USERNAME';
488
- api_token_basic.password = 'YOUR PASSWORD';
489
-
490
- var apiInstance = new DocSpring.PDFApi();
491
- var createHtmlTemplateData = new DocSpring.CreateHtmlTemplateData(); // CreateHtmlTemplateData |
492
- var callback = function(error, data, response) {
493
- if (error) {
494
- console.error(error);
495
- } else {
496
- console.log('API called successfully. Returned data: ' + data);
497
- }
498
- };
499
- apiInstance.createHTMLTemplate(createHtmlTemplateData, callback);
500
- ```
501
-
502
- ### Parameters
503
-
504
- Name | Type | Description | Notes
505
- ------------- | ------------- | ------------- | -------------
506
- **createHtmlTemplateData** | [**CreateHtmlTemplateData**](CreateHtmlTemplateData.md)| |
507
-
508
- ### Return type
509
-
510
- [**PendingTemplate**](PendingTemplate.md)
511
-
512
- ### Authorization
513
-
514
- [api_token_basic](../README.md#api_token_basic)
515
-
516
- ### HTTP request headers
517
-
518
- - **Content-Type**: application/json
519
- - **Accept**: application/json
520
-
521
- <a name="createPDFTemplate"></a>
522
- # **createPDFTemplate**
523
- > PendingTemplate createPDFTemplate(templateDocument, templateName, opts)
524
-
525
- Create a new PDF template with a form POST file upload
526
-
527
- ### Example
528
- ```javascript
529
- var DocSpring = require('docspring');
530
- var defaultClient = DocSpring.ApiClient.instance;
531
-
532
- // Configure HTTP basic authorization: api_token_basic
533
- var api_token_basic = defaultClient.authentications['api_token_basic'];
534
- api_token_basic.username = 'YOUR USERNAME';
535
- api_token_basic.password = 'YOUR PASSWORD';
536
-
537
- var apiInstance = new DocSpring.PDFApi();
538
- var templateDocument = "/path/to/file"; // File |
539
- var templateName = "templateName_example"; // String |
540
- var opts = {
541
- 'templateParentFolderId': "templateParentFolderId_example" // String |
542
- };
543
- var callback = function(error, data, response) {
544
- if (error) {
545
- console.error(error);
546
- } else {
547
- console.log('API called successfully. Returned data: ' + data);
548
- }
549
- };
550
- apiInstance.createPDFTemplate(templateDocument, templateName, opts, callback);
551
- ```
552
-
553
- ### Parameters
554
-
555
- Name | Type | Description | Notes
556
- ------------- | ------------- | ------------- | -------------
557
- **templateDocument** | **File**| |
558
- **templateName** | **String**| |
559
- **templateParentFolderId** | **String**| | [optional]
560
-
561
- ### Return type
562
-
563
- [**PendingTemplate**](PendingTemplate.md)
564
-
565
- ### Authorization
566
-
567
- [api_token_basic](../README.md#api_token_basic)
568
-
569
- ### HTTP request headers
570
-
571
- - **Content-Type**: multipart/form-data
572
- - **Accept**: application/json
573
-
574
- <a name="createPDFTemplateFromUpload"></a>
575
- # **createPDFTemplateFromUpload**
576
- > PendingTemplate createPDFTemplateFromUpload(createTemplateFromUploadData)
577
-
578
- Create a new PDF template from a cached presign upload
579
-
580
- ### Example
581
- ```javascript
582
- var DocSpring = require('docspring');
583
- var defaultClient = DocSpring.ApiClient.instance;
584
-
585
- // Configure HTTP basic authorization: api_token_basic
586
- var api_token_basic = defaultClient.authentications['api_token_basic'];
587
- api_token_basic.username = 'YOUR USERNAME';
588
- api_token_basic.password = 'YOUR PASSWORD';
589
-
590
- var apiInstance = new DocSpring.PDFApi();
591
- var createTemplateFromUploadData = new DocSpring.CreateTemplateFromUploadData(); // CreateTemplateFromUploadData |
592
- var callback = function(error, data, response) {
593
- if (error) {
594
- console.error(error);
595
- } else {
596
- console.log('API called successfully. Returned data: ' + data);
597
- }
598
- };
599
- apiInstance.createPDFTemplateFromUpload(createTemplateFromUploadData, callback);
600
- ```
601
-
602
- ### Parameters
603
-
604
- Name | Type | Description | Notes
605
- ------------- | ------------- | ------------- | -------------
606
- **createTemplateFromUploadData** | [**CreateTemplateFromUploadData**](CreateTemplateFromUploadData.md)| |
607
-
608
- ### Return type
609
-
610
- [**PendingTemplate**](PendingTemplate.md)
611
-
612
- ### Authorization
613
-
614
- [api_token_basic](../README.md#api_token_basic)
615
-
616
- ### HTTP request headers
617
-
618
- - **Content-Type**: application/json
619
- - **Accept**: application/json
620
-
621
- <a name="deleteFolder"></a>
622
- # **deleteFolder**
623
- > Folder deleteFolder(folderId)
624
-
625
- Delete a folder
626
-
627
- ### Example
628
- ```javascript
629
- var DocSpring = require('docspring');
630
- var defaultClient = DocSpring.ApiClient.instance;
631
-
632
- // Configure HTTP basic authorization: api_token_basic
633
- var api_token_basic = defaultClient.authentications['api_token_basic'];
634
- api_token_basic.username = 'YOUR USERNAME';
635
- api_token_basic.password = 'YOUR PASSWORD';
636
-
637
- var apiInstance = new DocSpring.PDFApi();
638
- var folderId = fld_000000000000000001; // String |
639
- var callback = function(error, data, response) {
640
- if (error) {
641
- console.error(error);
642
- } else {
643
- console.log('API called successfully. Returned data: ' + data);
644
- }
645
- };
646
- apiInstance.deleteFolder(folderId, callback);
647
- ```
648
-
649
- ### Parameters
650
-
651
- Name | Type | Description | Notes
652
- ------------- | ------------- | ------------- | -------------
653
- **folderId** | **String**| |
654
-
655
- ### Return type
656
-
657
- [**Folder**](Folder.md)
658
-
659
- ### Authorization
660
-
661
- [api_token_basic](../README.md#api_token_basic)
662
-
663
- ### HTTP request headers
664
-
665
- - **Content-Type**: Not defined
666
- - **Accept**: application/json
667
-
668
- <a name="deleteTemplate"></a>
669
- # **deleteTemplate**
670
- > UpdateTemplateResponse deleteTemplate(templateId)
671
-
672
- Delete a template
673
-
674
- ### Example
675
- ```javascript
676
- var DocSpring = require('docspring');
677
- var defaultClient = DocSpring.ApiClient.instance;
678
-
679
- // Configure HTTP basic authorization: api_token_basic
680
- var api_token_basic = defaultClient.authentications['api_token_basic'];
681
- api_token_basic.username = 'YOUR USERNAME';
682
- api_token_basic.password = 'YOUR PASSWORD';
683
-
684
- var apiInstance = new DocSpring.PDFApi();
685
- var templateId = tpl_000000000000000001; // String |
686
- var callback = function(error, data, response) {
687
- if (error) {
688
- console.error(error);
689
- } else {
690
- console.log('API called successfully. Returned data: ' + data);
691
- }
692
- };
693
- apiInstance.deleteTemplate(templateId, callback);
694
- ```
695
-
696
- ### Parameters
697
-
698
- Name | Type | Description | Notes
699
- ------------- | ------------- | ------------- | -------------
700
- **templateId** | **String**| |
701
-
702
- ### Return type
703
-
704
- [**UpdateTemplateResponse**](UpdateTemplateResponse.md)
705
-
706
- ### Authorization
707
-
708
- [api_token_basic](../README.md#api_token_basic)
709
-
710
- ### HTTP request headers
711
-
712
- - **Content-Type**: Not defined
713
- - **Accept**: application/json
714
-
715
- <a name="expireCombinedSubmission"></a>
716
- # **expireCombinedSubmission**
717
- > CombinedSubmission expireCombinedSubmission(combinedSubmissionId)
718
-
719
- Expire a combined submission
720
-
721
- ### Example
722
- ```javascript
723
- var DocSpring = require('docspring');
724
- var defaultClient = DocSpring.ApiClient.instance;
725
-
726
- // Configure HTTP basic authorization: api_token_basic
727
- var api_token_basic = defaultClient.authentications['api_token_basic'];
728
- api_token_basic.username = 'YOUR USERNAME';
729
- api_token_basic.password = 'YOUR PASSWORD';
730
-
731
- var apiInstance = new DocSpring.PDFApi();
732
- var combinedSubmissionId = com_000000000000000001; // String |
733
- var callback = function(error, data, response) {
734
- if (error) {
735
- console.error(error);
736
- } else {
737
- console.log('API called successfully. Returned data: ' + data);
738
- }
739
- };
740
- apiInstance.expireCombinedSubmission(combinedSubmissionId, callback);
741
- ```
742
-
743
- ### Parameters
744
-
745
- Name | Type | Description | Notes
746
- ------------- | ------------- | ------------- | -------------
747
- **combinedSubmissionId** | **String**| |
748
-
749
- ### Return type
750
-
751
- [**CombinedSubmission**](CombinedSubmission.md)
752
-
753
- ### Authorization
754
-
755
- [api_token_basic](../README.md#api_token_basic)
756
-
757
- ### HTTP request headers
758
-
759
- - **Content-Type**: Not defined
760
- - **Accept**: application/json
761
-
762
- <a name="expireSubmission"></a>
763
- # **expireSubmission**
764
- > Submission expireSubmission(submissionId)
765
-
766
- Expire a PDF submission
767
-
768
- ### Example
769
- ```javascript
770
- var DocSpring = require('docspring');
771
- var defaultClient = DocSpring.ApiClient.instance;
772
-
773
- // Configure HTTP basic authorization: api_token_basic
774
- var api_token_basic = defaultClient.authentications['api_token_basic'];
775
- api_token_basic.username = 'YOUR USERNAME';
776
- api_token_basic.password = 'YOUR PASSWORD';
777
-
778
- var apiInstance = new DocSpring.PDFApi();
779
- var submissionId = sub_000000000000000001; // String |
780
- var callback = function(error, data, response) {
781
- if (error) {
782
- console.error(error);
783
- } else {
784
- console.log('API called successfully. Returned data: ' + data);
785
- }
786
- };
787
- apiInstance.expireSubmission(submissionId, callback);
788
- ```
789
-
790
- ### Parameters
791
-
792
- Name | Type | Description | Notes
793
- ------------- | ------------- | ------------- | -------------
794
- **submissionId** | **String**| |
795
-
796
- ### Return type
797
-
798
- [**Submission**](Submission.md)
799
-
800
- ### Authorization
801
-
802
- [api_token_basic](../README.md#api_token_basic)
803
-
804
- ### HTTP request headers
805
-
806
- - **Content-Type**: Not defined
807
- - **Accept**: application/json
808
-
809
- <a name="generatePDF"></a>
810
- # **generatePDF**
811
- > CreateSubmissionResponse generatePDF(templateId, submissionData)
812
-
813
- Generates a new PDF
814
-
815
- ### Example
816
- ```javascript
817
- var DocSpring = require('docspring');
818
- var defaultClient = DocSpring.ApiClient.instance;
819
-
820
- // Configure HTTP basic authorization: api_token_basic
821
- var api_token_basic = defaultClient.authentications['api_token_basic'];
822
- api_token_basic.username = 'YOUR USERNAME';
823
- api_token_basic.password = 'YOUR PASSWORD';
824
-
825
- var apiInstance = new DocSpring.PDFApi();
826
- var templateId = tpl_000000000000000001; // String |
827
- var submissionData = new DocSpring.SubmissionData(); // SubmissionData |
828
- var callback = function(error, data, response) {
829
- if (error) {
830
- console.error(error);
831
- } else {
832
- console.log('API called successfully. Returned data: ' + data);
833
- }
834
- };
835
- apiInstance.generatePDF(templateId, submissionData, callback);
836
- ```
837
-
838
- ### Parameters
839
-
840
- Name | Type | Description | Notes
841
- ------------- | ------------- | ------------- | -------------
842
- **templateId** | **String**| |
843
- **submissionData** | [**SubmissionData**](SubmissionData.md)| |
844
-
845
- ### Return type
846
-
847
- [**CreateSubmissionResponse**](CreateSubmissionResponse.md)
848
-
849
- ### Authorization
850
-
851
- [api_token_basic](../README.md#api_token_basic)
852
-
853
- ### HTTP request headers
854
-
855
- - **Content-Type**: application/json
856
- - **Accept**: application/json
857
-
858
- <a name="getCombinedSubmission"></a>
859
- # **getCombinedSubmission**
860
- > CombinedSubmission getCombinedSubmission(combinedSubmissionId)
861
-
862
- Check the status of a combined submission (merged PDFs)
863
-
864
- ### Example
865
- ```javascript
866
- var DocSpring = require('docspring');
867
- var defaultClient = DocSpring.ApiClient.instance;
868
-
869
- // Configure HTTP basic authorization: api_token_basic
870
- var api_token_basic = defaultClient.authentications['api_token_basic'];
871
- api_token_basic.username = 'YOUR USERNAME';
872
- api_token_basic.password = 'YOUR PASSWORD';
873
-
874
- var apiInstance = new DocSpring.PDFApi();
875
- var combinedSubmissionId = com_000000000000000001; // String |
876
- var callback = function(error, data, response) {
877
- if (error) {
878
- console.error(error);
879
- } else {
880
- console.log('API called successfully. Returned data: ' + data);
881
- }
882
- };
883
- apiInstance.getCombinedSubmission(combinedSubmissionId, callback);
884
- ```
885
-
886
- ### Parameters
887
-
888
- Name | Type | Description | Notes
889
- ------------- | ------------- | ------------- | -------------
890
- **combinedSubmissionId** | **String**| |
891
-
892
- ### Return type
893
-
894
- [**CombinedSubmission**](CombinedSubmission.md)
895
-
896
- ### Authorization
897
-
898
- [api_token_basic](../README.md#api_token_basic)
899
-
900
- ### HTTP request headers
901
-
902
- - **Content-Type**: Not defined
903
- - **Accept**: application/json
904
-
905
- <a name="getDataRequest"></a>
906
- # **getDataRequest**
907
- > SubmissionDataRequest getDataRequest(dataRequestId)
908
-
909
- Look up a submission data request
910
-
911
- ### Example
912
- ```javascript
913
- var DocSpring = require('docspring');
914
- var defaultClient = DocSpring.ApiClient.instance;
915
-
916
- // Configure HTTP basic authorization: api_token_basic
917
- var api_token_basic = defaultClient.authentications['api_token_basic'];
918
- api_token_basic.username = 'YOUR USERNAME';
919
- api_token_basic.password = 'YOUR PASSWORD';
920
-
921
- var apiInstance = new DocSpring.PDFApi();
922
- var dataRequestId = drq_000000000000000001; // String |
923
- var callback = function(error, data, response) {
924
- if (error) {
925
- console.error(error);
926
- } else {
927
- console.log('API called successfully. Returned data: ' + data);
928
- }
929
- };
930
- apiInstance.getDataRequest(dataRequestId, callback);
931
- ```
932
-
933
- ### Parameters
934
-
935
- Name | Type | Description | Notes
936
- ------------- | ------------- | ------------- | -------------
937
- **dataRequestId** | **String**| |
938
-
939
- ### Return type
940
-
941
- [**SubmissionDataRequest**](SubmissionDataRequest.md)
942
-
943
- ### Authorization
944
-
945
- [api_token_basic](../README.md#api_token_basic)
946
-
947
- ### HTTP request headers
948
-
949
- - **Content-Type**: Not defined
950
- - **Accept**: application/json
951
-
952
- <a name="getFullTemplate"></a>
953
- # **getFullTemplate**
954
- > FullTemplate getFullTemplate(templateId)
955
-
956
- Fetch the full template attributes
957
-
958
- ### Example
959
- ```javascript
960
- var DocSpring = require('docspring');
961
- var defaultClient = DocSpring.ApiClient.instance;
962
-
963
- // Configure HTTP basic authorization: api_token_basic
964
- var api_token_basic = defaultClient.authentications['api_token_basic'];
965
- api_token_basic.username = 'YOUR USERNAME';
966
- api_token_basic.password = 'YOUR PASSWORD';
967
-
968
- var apiInstance = new DocSpring.PDFApi();
969
- var templateId = tpl_000000000000000001; // String |
970
- var callback = function(error, data, response) {
971
- if (error) {
972
- console.error(error);
973
- } else {
974
- console.log('API called successfully. Returned data: ' + data);
975
- }
976
- };
977
- apiInstance.getFullTemplate(templateId, callback);
978
- ```
979
-
980
- ### Parameters
981
-
982
- Name | Type | Description | Notes
983
- ------------- | ------------- | ------------- | -------------
984
- **templateId** | **String**| |
985
-
986
- ### Return type
987
-
988
- [**FullTemplate**](FullTemplate.md)
989
-
990
- ### Authorization
991
-
992
- [api_token_basic](../README.md#api_token_basic)
993
-
994
- ### HTTP request headers
995
-
996
- - **Content-Type**: Not defined
997
- - **Accept**: application/json
998
-
999
- <a name="getPresignUrl"></a>
1000
- # **getPresignUrl**
1001
- > {String: Object} getPresignUrl()
1002
-
1003
- Get a presigned URL so that you can upload a file to our AWS S3 bucket
1004
-
1005
- ### Example
1006
- ```javascript
1007
- var DocSpring = require('docspring');
1008
- var defaultClient = DocSpring.ApiClient.instance;
1009
-
1010
- // Configure HTTP basic authorization: api_token_basic
1011
- var api_token_basic = defaultClient.authentications['api_token_basic'];
1012
- api_token_basic.username = 'YOUR USERNAME';
1013
- api_token_basic.password = 'YOUR PASSWORD';
1014
-
1015
- var apiInstance = new DocSpring.PDFApi();
1016
- var callback = function(error, data, response) {
1017
- if (error) {
1018
- console.error(error);
1019
- } else {
1020
- console.log('API called successfully. Returned data: ' + data);
1021
- }
1022
- };
1023
- apiInstance.getPresignUrl(callback);
1024
- ```
1025
-
1026
- ### Parameters
1027
- This endpoint does not need any parameter.
1028
-
1029
- ### Return type
1030
-
1031
- **{String: Object}**
1032
-
1033
- ### Authorization
1034
-
1035
- [api_token_basic](../README.md#api_token_basic)
1036
-
1037
- ### HTTP request headers
1038
-
1039
- - **Content-Type**: Not defined
1040
- - **Accept**: application/json
1041
-
1042
- <a name="getSubmission"></a>
1043
- # **getSubmission**
1044
- > Submission getSubmission(submissionId, opts)
1045
-
1046
- Check the status of a PDF
1047
-
1048
- ### Example
1049
- ```javascript
1050
- var DocSpring = require('docspring');
1051
- var defaultClient = DocSpring.ApiClient.instance;
1052
-
1053
- // Configure HTTP basic authorization: api_token_basic
1054
- var api_token_basic = defaultClient.authentications['api_token_basic'];
1055
- api_token_basic.username = 'YOUR USERNAME';
1056
- api_token_basic.password = 'YOUR PASSWORD';
1057
-
1058
- var apiInstance = new DocSpring.PDFApi();
1059
- var submissionId = sub_000000000000000001; // String |
1060
- var opts = {
1061
- 'includeData': true // Boolean |
1062
- };
1063
- var callback = function(error, data, response) {
1064
- if (error) {
1065
- console.error(error);
1066
- } else {
1067
- console.log('API called successfully. Returned data: ' + data);
1068
- }
1069
- };
1070
- apiInstance.getSubmission(submissionId, opts, callback);
1071
- ```
1072
-
1073
- ### Parameters
1074
-
1075
- Name | Type | Description | Notes
1076
- ------------- | ------------- | ------------- | -------------
1077
- **submissionId** | **String**| |
1078
- **includeData** | **Boolean**| | [optional]
1079
-
1080
- ### Return type
1081
-
1082
- [**Submission**](Submission.md)
1083
-
1084
- ### Authorization
1085
-
1086
- [api_token_basic](../README.md#api_token_basic)
1087
-
1088
- ### HTTP request headers
1089
-
1090
- - **Content-Type**: Not defined
1091
- - **Accept**: application/json
1092
-
1093
- <a name="getSubmissionBatch"></a>
1094
- # **getSubmissionBatch**
1095
- > SubmissionBatch getSubmissionBatch(submissionBatchId, opts)
1096
-
1097
- Check the status of a submission batch job
1098
-
1099
- ### Example
1100
- ```javascript
1101
- var DocSpring = require('docspring');
1102
- var defaultClient = DocSpring.ApiClient.instance;
1103
-
1104
- // Configure HTTP basic authorization: api_token_basic
1105
- var api_token_basic = defaultClient.authentications['api_token_basic'];
1106
- api_token_basic.username = 'YOUR USERNAME';
1107
- api_token_basic.password = 'YOUR PASSWORD';
1108
-
1109
- var apiInstance = new DocSpring.PDFApi();
1110
- var submissionBatchId = sbb_000000000000000001; // String |
1111
- var opts = {
1112
- 'includeSubmissions': true // Boolean |
1113
- };
1114
- var callback = function(error, data, response) {
1115
- if (error) {
1116
- console.error(error);
1117
- } else {
1118
- console.log('API called successfully. Returned data: ' + data);
1119
- }
1120
- };
1121
- apiInstance.getSubmissionBatch(submissionBatchId, opts, callback);
1122
- ```
1123
-
1124
- ### Parameters
1125
-
1126
- Name | Type | Description | Notes
1127
- ------------- | ------------- | ------------- | -------------
1128
- **submissionBatchId** | **String**| |
1129
- **includeSubmissions** | **Boolean**| | [optional]
1130
-
1131
- ### Return type
1132
-
1133
- [**SubmissionBatch**](SubmissionBatch.md)
1134
-
1135
- ### Authorization
1136
-
1137
- [api_token_basic](../README.md#api_token_basic)
1138
-
1139
- ### HTTP request headers
1140
-
1141
- - **Content-Type**: Not defined
1142
- - **Accept**: application/json
1143
-
1144
- <a name="getTemplate"></a>
1145
- # **getTemplate**
1146
- > Template getTemplate(templateId)
1147
-
1148
- Check the status of an uploaded template
1149
-
1150
- ### Example
1151
- ```javascript
1152
- var DocSpring = require('docspring');
1153
- var defaultClient = DocSpring.ApiClient.instance;
1154
-
1155
- // Configure HTTP basic authorization: api_token_basic
1156
- var api_token_basic = defaultClient.authentications['api_token_basic'];
1157
- api_token_basic.username = 'YOUR USERNAME';
1158
- api_token_basic.password = 'YOUR PASSWORD';
1159
-
1160
- var apiInstance = new DocSpring.PDFApi();
1161
- var templateId = tpl_000000000000000001; // String |
1162
- var callback = function(error, data, response) {
1163
- if (error) {
1164
- console.error(error);
1165
- } else {
1166
- console.log('API called successfully. Returned data: ' + data);
1167
- }
1168
- };
1169
- apiInstance.getTemplate(templateId, callback);
1170
- ```
1171
-
1172
- ### Parameters
1173
-
1174
- Name | Type | Description | Notes
1175
- ------------- | ------------- | ------------- | -------------
1176
- **templateId** | **String**| |
1177
-
1178
- ### Return type
1179
-
1180
- [**Template**](Template.md)
1181
-
1182
- ### Authorization
1183
-
1184
- [api_token_basic](../README.md#api_token_basic)
1185
-
1186
- ### HTTP request headers
1187
-
1188
- - **Content-Type**: Not defined
1189
- - **Accept**: application/json
1190
-
1191
- <a name="getTemplateSchema"></a>
1192
- # **getTemplateSchema**
1193
- > {String: Object} getTemplateSchema(templateId)
1194
-
1195
- Fetch the JSON schema for a template
1196
-
1197
- ### Example
1198
- ```javascript
1199
- var DocSpring = require('docspring');
1200
- var defaultClient = DocSpring.ApiClient.instance;
1201
-
1202
- // Configure HTTP basic authorization: api_token_basic
1203
- var api_token_basic = defaultClient.authentications['api_token_basic'];
1204
- api_token_basic.username = 'YOUR USERNAME';
1205
- api_token_basic.password = 'YOUR PASSWORD';
1206
-
1207
- var apiInstance = new DocSpring.PDFApi();
1208
- var templateId = tpl_000000000000000001; // String |
1209
- var callback = function(error, data, response) {
1210
- if (error) {
1211
- console.error(error);
1212
- } else {
1213
- console.log('API called successfully. Returned data: ' + data);
1214
- }
1215
- };
1216
- apiInstance.getTemplateSchema(templateId, callback);
1217
- ```
1218
-
1219
- ### Parameters
1220
-
1221
- Name | Type | Description | Notes
1222
- ------------- | ------------- | ------------- | -------------
1223
- **templateId** | **String**| |
1224
-
1225
- ### Return type
1226
-
1227
- **{String: Object}**
1228
-
1229
- ### Authorization
1230
-
1231
- [api_token_basic](../README.md#api_token_basic)
1232
-
1233
- ### HTTP request headers
1234
-
1235
- - **Content-Type**: Not defined
1236
- - **Accept**: application/json
1237
-
1238
- <a name="listCombinedSubmissions"></a>
1239
- # **listCombinedSubmissions**
1240
- > [CombinedSubmission] listCombinedSubmissions(opts)
1241
-
1242
- Get a list of all combined submissions
1243
-
1244
- ### Example
1245
- ```javascript
1246
- var DocSpring = require('docspring');
1247
- var defaultClient = DocSpring.ApiClient.instance;
1248
-
1249
- // Configure HTTP basic authorization: api_token_basic
1250
- var api_token_basic = defaultClient.authentications['api_token_basic'];
1251
- api_token_basic.username = 'YOUR USERNAME';
1252
- api_token_basic.password = 'YOUR PASSWORD';
1253
-
1254
- var apiInstance = new DocSpring.PDFApi();
1255
- var opts = {
1256
- 'page': 2, // Number | Default: 1
1257
- 'perPage': 1 // Number | Default: 50
1258
- };
1259
- var callback = function(error, data, response) {
1260
- if (error) {
1261
- console.error(error);
1262
- } else {
1263
- console.log('API called successfully. Returned data: ' + data);
1264
- }
1265
- };
1266
- apiInstance.listCombinedSubmissions(opts, callback);
1267
- ```
1268
-
1269
- ### Parameters
1270
-
1271
- Name | Type | Description | Notes
1272
- ------------- | ------------- | ------------- | -------------
1273
- **page** | **Number**| Default: 1 | [optional]
1274
- **perPage** | **Number**| Default: 50 | [optional]
1275
-
1276
- ### Return type
1277
-
1278
- [**[CombinedSubmission]**](CombinedSubmission.md)
1279
-
1280
- ### Authorization
1281
-
1282
- [api_token_basic](../README.md#api_token_basic)
1283
-
1284
- ### HTTP request headers
1285
-
1286
- - **Content-Type**: Not defined
1287
- - **Accept**: application/json
1288
-
1289
- <a name="listFolders"></a>
1290
- # **listFolders**
1291
- > [Folder] listFolders(opts)
1292
-
1293
- Get a list of all folders
1294
-
1295
- ### Example
1296
- ```javascript
1297
- var DocSpring = require('docspring');
1298
- var defaultClient = DocSpring.ApiClient.instance;
1299
-
1300
- // Configure HTTP basic authorization: api_token_basic
1301
- var api_token_basic = defaultClient.authentications['api_token_basic'];
1302
- api_token_basic.username = 'YOUR USERNAME';
1303
- api_token_basic.password = 'YOUR PASSWORD';
1304
-
1305
- var apiInstance = new DocSpring.PDFApi();
1306
- var opts = {
1307
- 'parentFolderId': fld_000000000000000002 // String | Filter By Folder Id
1308
- };
1309
- var callback = function(error, data, response) {
1310
- if (error) {
1311
- console.error(error);
1312
- } else {
1313
- console.log('API called successfully. Returned data: ' + data);
1314
- }
1315
- };
1316
- apiInstance.listFolders(opts, callback);
1317
- ```
1318
-
1319
- ### Parameters
1320
-
1321
- Name | Type | Description | Notes
1322
- ------------- | ------------- | ------------- | -------------
1323
- **parentFolderId** | **String**| Filter By Folder Id | [optional]
1324
-
1325
- ### Return type
1326
-
1327
- [**[Folder]**](Folder.md)
1328
-
1329
- ### Authorization
1330
-
1331
- [api_token_basic](../README.md#api_token_basic)
1332
-
1333
- ### HTTP request headers
1334
-
1335
- - **Content-Type**: Not defined
1336
- - **Accept**: application/json
1337
-
1338
- <a name="listSubmissions"></a>
1339
- # **listSubmissions**
1340
- > ListSubmissionsResponse listSubmissions(opts)
1341
-
1342
- List all submissions
1343
-
1344
- ### Example
1345
- ```javascript
1346
- var DocSpring = require('docspring');
1347
- var defaultClient = DocSpring.ApiClient.instance;
1348
-
1349
- // Configure HTTP basic authorization: api_token_basic
1350
- var api_token_basic = defaultClient.authentications['api_token_basic'];
1351
- api_token_basic.username = 'YOUR USERNAME';
1352
- api_token_basic.password = 'YOUR PASSWORD';
1353
-
1354
- var apiInstance = new DocSpring.PDFApi();
1355
- var opts = {
1356
- 'cursor': sub_list_000012, // String |
1357
- 'limit': 3, // Number |
1358
- 'createdAfter': 2019-01-01T09:00:00-05:00, // String |
1359
- 'createdBefore': 2020-01-01T09:00:00.000+0200, // String |
1360
- 'type': test, // String |
1361
- 'includeData': true // Boolean |
1362
- };
1363
- var callback = function(error, data, response) {
1364
- if (error) {
1365
- console.error(error);
1366
- } else {
1367
- console.log('API called successfully. Returned data: ' + data);
1368
- }
1369
- };
1370
- apiInstance.listSubmissions(opts, callback);
1371
- ```
1372
-
1373
- ### Parameters
1374
-
1375
- Name | Type | Description | Notes
1376
- ------------- | ------------- | ------------- | -------------
1377
- **cursor** | **String**| | [optional]
1378
- **limit** | **Number**| | [optional]
1379
- **createdAfter** | **String**| | [optional]
1380
- **createdBefore** | **String**| | [optional]
1381
- **type** | **String**| | [optional]
1382
- **includeData** | **Boolean**| | [optional]
1383
-
1384
- ### Return type
1385
-
1386
- [**ListSubmissionsResponse**](ListSubmissionsResponse.md)
1387
-
1388
- ### Authorization
1389
-
1390
- [api_token_basic](../README.md#api_token_basic)
1391
-
1392
- ### HTTP request headers
1393
-
1394
- - **Content-Type**: Not defined
1395
- - **Accept**: application/json
1396
-
1397
- <a name="listSubmissions_0"></a>
1398
- # **listSubmissions_0**
1399
- > ListSubmissionsResponse listSubmissions_0(templateId, opts)
1400
-
1401
- List all submissions for a given template
1402
-
1403
- ### Example
1404
- ```javascript
1405
- var DocSpring = require('docspring');
1406
- var defaultClient = DocSpring.ApiClient.instance;
1407
-
1408
- // Configure HTTP basic authorization: api_token_basic
1409
- var api_token_basic = defaultClient.authentications['api_token_basic'];
1410
- api_token_basic.username = 'YOUR USERNAME';
1411
- api_token_basic.password = 'YOUR PASSWORD';
1412
-
1413
- var apiInstance = new DocSpring.PDFApi();
1414
- var templateId = tpl_000000000000000002; // String |
1415
- var opts = {
1416
- 'cursor': "cursor_example", // String |
1417
- 'limit': 3.4, // Number |
1418
- 'createdAfter': "createdAfter_example", // String |
1419
- 'createdBefore': "createdBefore_example", // String |
1420
- 'type': "type_example", // String |
1421
- 'includeData': true // Boolean |
1422
- };
1423
- var callback = function(error, data, response) {
1424
- if (error) {
1425
- console.error(error);
1426
- } else {
1427
- console.log('API called successfully. Returned data: ' + data);
1428
- }
1429
- };
1430
- apiInstance.listSubmissions_0(templateId, opts, callback);
1431
- ```
1432
-
1433
- ### Parameters
1434
-
1435
- Name | Type | Description | Notes
1436
- ------------- | ------------- | ------------- | -------------
1437
- **templateId** | **String**| |
1438
- **cursor** | **String**| | [optional]
1439
- **limit** | **Number**| | [optional]
1440
- **createdAfter** | **String**| | [optional]
1441
- **createdBefore** | **String**| | [optional]
1442
- **type** | **String**| | [optional]
1443
- **includeData** | **Boolean**| | [optional]
1444
-
1445
- ### Return type
1446
-
1447
- [**ListSubmissionsResponse**](ListSubmissionsResponse.md)
1448
-
1449
- ### Authorization
1450
-
1451
- [api_token_basic](../README.md#api_token_basic)
1452
-
1453
- ### HTTP request headers
1454
-
1455
- - **Content-Type**: Not defined
1456
- - **Accept**: application/json
1457
-
1458
- <a name="listTemplates"></a>
1459
- # **listTemplates**
1460
- > [Template] listTemplates(opts)
1461
-
1462
- Get a list of all templates
1463
-
1464
- ### Example
1465
- ```javascript
1466
- var DocSpring = require('docspring');
1467
- var defaultClient = DocSpring.ApiClient.instance;
1468
-
1469
- // Configure HTTP basic authorization: api_token_basic
1470
- var api_token_basic = defaultClient.authentications['api_token_basic'];
1471
- api_token_basic.username = 'YOUR USERNAME';
1472
- api_token_basic.password = 'YOUR PASSWORD';
1473
-
1474
- var apiInstance = new DocSpring.PDFApi();
1475
- var opts = {
1476
- 'query': 2, // String | Search By Name
1477
- 'parentFolderId': fld_000000000000000001, // String | Filter By Folder Id
1478
- 'page': 2, // Number | Default: 1
1479
- 'perPage': 1 // Number | Default: 50
1480
- };
1481
- var callback = function(error, data, response) {
1482
- if (error) {
1483
- console.error(error);
1484
- } else {
1485
- console.log('API called successfully. Returned data: ' + data);
1486
- }
1487
- };
1488
- apiInstance.listTemplates(opts, callback);
1489
- ```
1490
-
1491
- ### Parameters
1492
-
1493
- Name | Type | Description | Notes
1494
- ------------- | ------------- | ------------- | -------------
1495
- **query** | **String**| Search By Name | [optional]
1496
- **parentFolderId** | **String**| Filter By Folder Id | [optional]
1497
- **page** | **Number**| Default: 1 | [optional]
1498
- **perPage** | **Number**| Default: 50 | [optional]
1499
-
1500
- ### Return type
1501
-
1502
- [**[Template]**](Template.md)
1503
-
1504
- ### Authorization
1505
-
1506
- [api_token_basic](../README.md#api_token_basic)
1507
-
1508
- ### HTTP request headers
1509
-
1510
- - **Content-Type**: Not defined
1511
- - **Accept**: application/json
1512
-
1513
- <a name="moveFolderToFolder"></a>
1514
- # **moveFolderToFolder**
1515
- > Folder moveFolderToFolder(folderId, moveFolderData)
1516
-
1517
- Move a folder
1518
-
1519
- ### Example
1520
- ```javascript
1521
- var DocSpring = require('docspring');
1522
- var defaultClient = DocSpring.ApiClient.instance;
1523
-
1524
- // Configure HTTP basic authorization: api_token_basic
1525
- var api_token_basic = defaultClient.authentications['api_token_basic'];
1526
- api_token_basic.username = 'YOUR USERNAME';
1527
- api_token_basic.password = 'YOUR PASSWORD';
1528
-
1529
- var apiInstance = new DocSpring.PDFApi();
1530
- var folderId = fld_000000000000000001; // String |
1531
- var moveFolderData = new DocSpring.MoveFolderData(); // MoveFolderData |
1532
- var callback = function(error, data, response) {
1533
- if (error) {
1534
- console.error(error);
1535
- } else {
1536
- console.log('API called successfully. Returned data: ' + data);
1537
- }
1538
- };
1539
- apiInstance.moveFolderToFolder(folderId, moveFolderData, callback);
1540
- ```
1541
-
1542
- ### Parameters
1543
-
1544
- Name | Type | Description | Notes
1545
- ------------- | ------------- | ------------- | -------------
1546
- **folderId** | **String**| |
1547
- **moveFolderData** | [**MoveFolderData**](MoveFolderData.md)| |
1548
-
1549
- ### Return type
1550
-
1551
- [**Folder**](Folder.md)
1552
-
1553
- ### Authorization
1554
-
1555
- [api_token_basic](../README.md#api_token_basic)
1556
-
1557
- ### HTTP request headers
1558
-
1559
- - **Content-Type**: application/json
1560
- - **Accept**: application/json
1561
-
1562
- <a name="moveTemplateToFolder"></a>
1563
- # **moveTemplateToFolder**
1564
- > Template moveTemplateToFolder(templateId, moveTemplateData)
1565
-
1566
- Move Template to folder
1567
-
1568
- ### Example
1569
- ```javascript
1570
- var DocSpring = require('docspring');
1571
- var defaultClient = DocSpring.ApiClient.instance;
1572
-
1573
- // Configure HTTP basic authorization: api_token_basic
1574
- var api_token_basic = defaultClient.authentications['api_token_basic'];
1575
- api_token_basic.username = 'YOUR USERNAME';
1576
- api_token_basic.password = 'YOUR PASSWORD';
1577
-
1578
- var apiInstance = new DocSpring.PDFApi();
1579
- var templateId = tpl_000000000000000001; // String |
1580
- var moveTemplateData = new DocSpring.MoveTemplateData(); // MoveTemplateData |
1581
- var callback = function(error, data, response) {
1582
- if (error) {
1583
- console.error(error);
1584
- } else {
1585
- console.log('API called successfully. Returned data: ' + data);
1586
- }
1587
- };
1588
- apiInstance.moveTemplateToFolder(templateId, moveTemplateData, callback);
1589
- ```
1590
-
1591
- ### Parameters
1592
-
1593
- Name | Type | Description | Notes
1594
- ------------- | ------------- | ------------- | -------------
1595
- **templateId** | **String**| |
1596
- **moveTemplateData** | [**MoveTemplateData**](MoveTemplateData.md)| |
1597
-
1598
- ### Return type
1599
-
1600
- [**Template**](Template.md)
1601
-
1602
- ### Authorization
1603
-
1604
- [api_token_basic](../README.md#api_token_basic)
1605
-
1606
- ### HTTP request headers
1607
-
1608
- - **Content-Type**: application/json
1609
- - **Accept**: application/json
1610
-
1611
- <a name="renameFolder"></a>
1612
- # **renameFolder**
1613
- > renameFolder(folderId, renameFolderData)
1614
-
1615
- Rename a folder
1616
-
1617
- ### Example
1618
- ```javascript
1619
- var DocSpring = require('docspring');
1620
- var defaultClient = DocSpring.ApiClient.instance;
1621
-
1622
- // Configure HTTP basic authorization: api_token_basic
1623
- var api_token_basic = defaultClient.authentications['api_token_basic'];
1624
- api_token_basic.username = 'YOUR USERNAME';
1625
- api_token_basic.password = 'YOUR PASSWORD';
1626
-
1627
- var apiInstance = new DocSpring.PDFApi();
1628
- var folderId = fld_000000000000000001; // String |
1629
- var renameFolderData = new DocSpring.RenameFolderData(); // RenameFolderData |
1630
- var callback = function(error, data, response) {
1631
- if (error) {
1632
- console.error(error);
1633
- } else {
1634
- console.log('API called successfully.');
1635
- }
1636
- };
1637
- apiInstance.renameFolder(folderId, renameFolderData, callback);
1638
- ```
1639
-
1640
- ### Parameters
1641
-
1642
- Name | Type | Description | Notes
1643
- ------------- | ------------- | ------------- | -------------
1644
- **folderId** | **String**| |
1645
- **renameFolderData** | [**RenameFolderData**](RenameFolderData.md)| |
1646
-
1647
- ### Return type
1648
-
1649
- null (empty response body)
1650
-
1651
- ### Authorization
1652
-
1653
- [api_token_basic](../README.md#api_token_basic)
1654
-
1655
- ### HTTP request headers
1656
-
1657
- - **Content-Type**: application/json
1658
- - **Accept**: application/json
1659
-
1660
- <a name="testAuthentication"></a>
1661
- # **testAuthentication**
1662
- > AuthenticationSuccessResponse testAuthentication()
1663
-
1664
- Test Authentication
1665
-
1666
- ### Example
1667
- ```javascript
1668
- var DocSpring = require('docspring');
1669
- var defaultClient = DocSpring.ApiClient.instance;
1670
-
1671
- // Configure HTTP basic authorization: api_token_basic
1672
- var api_token_basic = defaultClient.authentications['api_token_basic'];
1673
- api_token_basic.username = 'YOUR USERNAME';
1674
- api_token_basic.password = 'YOUR PASSWORD';
1675
-
1676
- var apiInstance = new DocSpring.PDFApi();
1677
- var callback = function(error, data, response) {
1678
- if (error) {
1679
- console.error(error);
1680
- } else {
1681
- console.log('API called successfully. Returned data: ' + data);
1682
- }
1683
- };
1684
- apiInstance.testAuthentication(callback);
1685
- ```
1686
-
1687
- ### Parameters
1688
- This endpoint does not need any parameter.
1689
-
1690
- ### Return type
1691
-
1692
- [**AuthenticationSuccessResponse**](AuthenticationSuccessResponse.md)
1693
-
1694
- ### Authorization
1695
-
1696
- [api_token_basic](../README.md#api_token_basic)
1697
-
1698
- ### HTTP request headers
1699
-
1700
- - **Content-Type**: Not defined
1701
- - **Accept**: application/json
1702
-
1703
- <a name="updateDataRequest"></a>
1704
- # **updateDataRequest**
1705
- > UpdateDataRequestResponse updateDataRequest(dataRequestId, updateSubmissionDataRequestData)
1706
-
1707
- Update a submission data request
1708
-
1709
- ### Example
1710
- ```javascript
1711
- var DocSpring = require('docspring');
1712
- var defaultClient = DocSpring.ApiClient.instance;
1713
-
1714
- // Configure HTTP basic authorization: api_token_basic
1715
- var api_token_basic = defaultClient.authentications['api_token_basic'];
1716
- api_token_basic.username = 'YOUR USERNAME';
1717
- api_token_basic.password = 'YOUR PASSWORD';
1718
-
1719
- var apiInstance = new DocSpring.PDFApi();
1720
- var dataRequestId = drq_000000000000000001; // String |
1721
- var updateSubmissionDataRequestData = new DocSpring.UpdateSubmissionDataRequestData(); // UpdateSubmissionDataRequestData |
1722
- var callback = function(error, data, response) {
1723
- if (error) {
1724
- console.error(error);
1725
- } else {
1726
- console.log('API called successfully. Returned data: ' + data);
1727
- }
1728
- };
1729
- apiInstance.updateDataRequest(dataRequestId, updateSubmissionDataRequestData, callback);
1730
- ```
1731
-
1732
- ### Parameters
1733
-
1734
- Name | Type | Description | Notes
1735
- ------------- | ------------- | ------------- | -------------
1736
- **dataRequestId** | **String**| |
1737
- **updateSubmissionDataRequestData** | [**UpdateSubmissionDataRequestData**](UpdateSubmissionDataRequestData.md)| |
1738
-
1739
- ### Return type
1740
-
1741
- [**UpdateDataRequestResponse**](UpdateDataRequestResponse.md)
1742
-
1743
- ### Authorization
1744
-
1745
- [api_token_basic](../README.md#api_token_basic)
1746
-
1747
- ### HTTP request headers
1748
-
1749
- - **Content-Type**: application/json
1750
- - **Accept**: application/json
1751
-
1752
- <a name="updateTemplate"></a>
1753
- # **updateTemplate**
1754
- > UpdateTemplateResponse updateTemplate(templateId, updateTemplateData)
1755
-
1756
- Update a Template
1757
-
1758
- ### Example
1759
- ```javascript
1760
- var DocSpring = require('docspring');
1761
- var defaultClient = DocSpring.ApiClient.instance;
1762
-
1763
- // Configure HTTP basic authorization: api_token_basic
1764
- var api_token_basic = defaultClient.authentications['api_token_basic'];
1765
- api_token_basic.username = 'YOUR USERNAME';
1766
- api_token_basic.password = 'YOUR PASSWORD';
1767
-
1768
- var apiInstance = new DocSpring.PDFApi();
1769
- var templateId = tpl_000000000000000003; // String |
1770
- var updateTemplateData = new DocSpring.UpdateTemplateData(); // UpdateTemplateData |
1771
- var callback = function(error, data, response) {
1772
- if (error) {
1773
- console.error(error);
1774
- } else {
1775
- console.log('API called successfully. Returned data: ' + data);
1776
- }
1777
- };
1778
- apiInstance.updateTemplate(templateId, updateTemplateData, callback);
1779
- ```
1780
-
1781
- ### Parameters
1782
-
1783
- Name | Type | Description | Notes
1784
- ------------- | ------------- | ------------- | -------------
1785
- **templateId** | **String**| |
1786
- **updateTemplateData** | [**UpdateTemplateData**](UpdateTemplateData.md)| |
1787
-
1788
- ### Return type
1789
-
1790
- [**UpdateTemplateResponse**](UpdateTemplateResponse.md)
1791
-
1792
- ### Authorization
1793
-
1794
- [api_token_basic](../README.md#api_token_basic)
1795
-
1796
- ### HTTP request headers
1797
-
1798
- - **Content-Type**: application/json
1799
- - **Accept**: application/json
1800
-