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