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 (239) hide show
  1. checksums.yaml +4 -4
  2. data/.gitlab-ci.yml +26 -0
  3. data/.openapi-generator/FILES +220 -0
  4. data/.openapi-generator/VERSION +1 -1
  5. data/.rubocop.yml +6 -12
  6. data/.travis.yml +11 -0
  7. data/CHANGELOG.md +9 -0
  8. data/Gemfile +5 -1
  9. data/Gemfile.lock +85 -48
  10. data/README.md +47 -16
  11. data/docs/AddFieldsData.md +13 -3
  12. data/docs/AddFieldsTemplateResponse.md +17 -5
  13. data/docs/AuthenticationError.md +15 -4
  14. data/docs/AuthenticationSuccessResponse.md +13 -3
  15. data/docs/CombinePdfsData.md +23 -7
  16. data/docs/CombinedSubmission.md +37 -12
  17. data/docs/CombinedSubmissionAction.md +23 -8
  18. data/docs/CombinedSubmissionData.md +21 -6
  19. data/docs/CopyTemplateData.md +15 -4
  20. data/docs/CreateCombinedSubmissionResponse.md +17 -5
  21. data/docs/CreateCustomFileData.md +13 -3
  22. data/docs/CreateCustomFileResponse.md +17 -5
  23. data/docs/CreateFolderAttributes.md +20 -0
  24. data/docs/CreateFolderData.md +13 -3
  25. data/docs/CreateHtmlTemplateData.md +13 -3
  26. data/docs/CreateSubmissionBatchResponse.md +21 -7
  27. data/docs/CreateSubmissionBatchSubmissionsResponse.md +17 -5
  28. data/docs/CreateSubmissionData.md +36 -0
  29. data/docs/CreateSubmissionDataRequestData.md +37 -15
  30. data/docs/CreateSubmissionDataRequestEventRequest.md +24 -0
  31. data/docs/CreateSubmissionDataRequestEventResponse.md +22 -0
  32. data/docs/CreateSubmissionDataRequestTokenResponse.md +17 -5
  33. data/docs/CreateSubmissionResponse.md +17 -5
  34. data/docs/CreateTemplateFromUploadData.md +13 -3
  35. data/docs/DataRequestToken.md +24 -0
  36. data/docs/DeleteTemplateResponse.md +20 -0
  37. data/docs/ErrorResponse.md +20 -0
  38. data/docs/Folder.md +19 -6
  39. data/docs/FullTemplate.md +94 -0
  40. data/docs/HtmlTemplateData.md +51 -19
  41. data/docs/HtmlTemplateDataWebhookOptions.md +18 -0
  42. data/docs/InvalidRequest.md +15 -4
  43. data/docs/InvalidRequestSingleError.md +20 -0
  44. data/docs/ListSubmissionsResponse.md +22 -0
  45. data/docs/MoveFolderData.md +13 -3
  46. data/docs/MoveTemplateData.md +13 -3
  47. data/docs/PDFApi.md +1746 -495
  48. data/docs/PendingTemplate.md +45 -19
  49. data/docs/PreviewPdfResponse.md +20 -0
  50. data/docs/PublishTemplateVersion404Response.md +20 -0
  51. data/docs/PublishTemplateVersion422Response.md +20 -0
  52. data/docs/PublishTemplateVersionResponse.md +20 -0
  53. data/docs/PublishTemplateVersionResponseResult.md +24 -0
  54. data/docs/PublishVersionData.md +20 -0
  55. data/docs/RenameFolderData.md +13 -3
  56. data/docs/RestoreTemplateVersionResponse.md +18 -0
  57. data/docs/RestoreVersionData.md +18 -0
  58. data/docs/Submission.md +49 -21
  59. data/docs/SubmissionAction.md +23 -8
  60. data/docs/SubmissionBatch.md +29 -11
  61. data/docs/SubmissionBatchData.md +21 -6
  62. data/docs/SubmissionData.md +23 -9
  63. data/docs/SubmissionDataBatchRequest.md +25 -8
  64. data/docs/SubmissionDataRequest.md +53 -22
  65. data/docs/SubmissionDataRequestEvent.md +30 -0
  66. data/docs/Template.md +51 -22
  67. data/docs/TemplateData.md +49 -18
  68. data/docs/TemplateDefaults.md +22 -0
  69. data/docs/TemplateDocument.md +22 -0
  70. data/docs/TemplateDocumentMetadata.md +22 -0
  71. data/docs/TemplateSchema.md +34 -0
  72. data/docs/UpdateDataRequestResponse.md +17 -5
  73. data/docs/UpdateSubmissionDataRequestData.md +37 -15
  74. data/docs/UpdateTemplateData.md +13 -3
  75. data/docs/UpdateTemplateResponse.md +15 -4
  76. data/docs/UploadPresign.md +24 -0
  77. data/docs/UploadTemplateData.md +53 -20
  78. data/docspring.gemspec +14 -11
  79. data/git_push.sh +11 -9
  80. data/lib/docspring/api/pdf_api.rb +1485 -497
  81. data/lib/docspring/api_client.rb +106 -98
  82. data/lib/docspring/api_error.rb +22 -2
  83. data/lib/docspring/configuration.rb +127 -16
  84. data/lib/docspring/models/add_fields_data.rb +59 -26
  85. data/lib/docspring/models/add_fields_template_response.rb +81 -43
  86. data/lib/docspring/models/authentication_error.rb +62 -29
  87. data/lib/docspring/models/authentication_success_response.rb +66 -28
  88. data/lib/docspring/models/combine_pdfs_data.rb +74 -32
  89. data/lib/docspring/models/combined_submission.rb +167 -68
  90. data/lib/docspring/models/combined_submission_action.rb +83 -39
  91. data/lib/docspring/models/combined_submission_data.rb +72 -30
  92. data/lib/docspring/models/copy_template_data.rb +59 -26
  93. data/lib/docspring/models/create_combined_submission_response.rb +86 -41
  94. data/lib/docspring/models/create_custom_file_data.rb +58 -25
  95. data/lib/docspring/models/create_custom_file_response.rb +86 -41
  96. data/lib/docspring/models/create_folder_attributes.rb +230 -0
  97. data/lib/docspring/models/create_folder_data.rb +59 -26
  98. data/lib/docspring/models/create_html_template_data.rb +58 -25
  99. data/lib/docspring/models/create_submission_batch_response.rb +104 -52
  100. data/lib/docspring/models/create_submission_batch_submissions_response.rb +79 -41
  101. data/lib/docspring/models/create_submission_data.rb +304 -0
  102. data/lib/docspring/models/create_submission_data_request_data.rb +139 -90
  103. data/lib/docspring/models/create_submission_data_request_event_request.rb +297 -0
  104. data/lib/docspring/models/create_submission_data_request_event_response.rb +282 -0
  105. data/lib/docspring/models/create_submission_data_request_token_response.rb +85 -40
  106. data/lib/docspring/models/create_submission_response.rb +86 -41
  107. data/lib/docspring/models/create_template_from_upload_data.rb +58 -25
  108. data/lib/docspring/models/{custom_file.rb → data_request_token.rb} +110 -33
  109. data/lib/docspring/models/delete_template_response.rb +266 -0
  110. data/lib/docspring/models/{error.rb → error_response.rb} +65 -30
  111. data/lib/docspring/models/folder.rb +78 -46
  112. data/lib/docspring/models/full_template.rb +801 -0
  113. data/lib/docspring/models/html_template_data.rb +180 -110
  114. data/lib/docspring/models/{folders_folder.rb → html_template_data_webhook_options.rb} +63 -41
  115. data/lib/docspring/models/invalid_request.rb +64 -29
  116. data/lib/docspring/models/invalid_request_single_error.rb +271 -0
  117. data/lib/docspring/models/list_submissions_response.rb +251 -0
  118. data/lib/docspring/models/move_folder_data.rb +56 -25
  119. data/lib/docspring/models/move_template_data.rb +58 -25
  120. data/lib/docspring/models/pending_template.rb +221 -118
  121. data/lib/docspring/models/preview_pdf_response.rb +264 -0
  122. data/lib/docspring/models/publish_template_version404_response.rb +271 -0
  123. data/lib/docspring/models/publish_template_version422_response.rb +273 -0
  124. data/lib/docspring/models/publish_template_version_response.rb +271 -0
  125. data/lib/docspring/models/publish_template_version_response_result.rb +263 -0
  126. data/lib/docspring/models/publish_version_data.rb +230 -0
  127. data/lib/docspring/models/rename_folder_data.rb +58 -25
  128. data/lib/docspring/models/restore_template_version_response.rb +255 -0
  129. data/lib/docspring/models/{create_submission_data_request_token_response_token.rb → restore_version_data.rb} +69 -58
  130. data/lib/docspring/models/submission.rb +98 -49
  131. data/lib/docspring/models/submission_action.rb +83 -39
  132. data/lib/docspring/models/submission_batch.rb +158 -75
  133. data/lib/docspring/models/submission_batch_data.rb +74 -30
  134. data/lib/docspring/models/submission_data.rb +65 -41
  135. data/lib/docspring/models/submission_data_batch_request.rb +100 -49
  136. data/lib/docspring/models/submission_data_request.rb +123 -54
  137. data/lib/docspring/models/submission_data_request_event.rb +309 -0
  138. data/lib/docspring/models/template.rb +267 -132
  139. data/lib/docspring/models/template_data.rb +173 -105
  140. data/lib/docspring/models/template_defaults.rb +249 -0
  141. data/lib/docspring/models/{upload_template_data_document.rb → template_document.rb} +91 -39
  142. data/lib/docspring/models/{upload_template_data_document_metadata.rb → template_document_metadata.rb} +94 -42
  143. data/lib/docspring/models/template_schema.rb +288 -0
  144. data/lib/docspring/models/update_data_request_response.rb +86 -41
  145. data/lib/docspring/models/update_submission_data_request_data.rb +82 -43
  146. data/lib/docspring/models/update_template_data.rb +58 -25
  147. data/lib/docspring/models/update_template_response.rb +79 -41
  148. data/lib/docspring/models/upload_presign.rb +296 -0
  149. data/lib/docspring/models/upload_template_data.rb +186 -116
  150. data/lib/docspring/version.rb +3 -3
  151. data/lib/docspring.rb +30 -10
  152. data/spec/api/client_integration_spec.rb +26 -19
  153. data/spec/api/pdf_api_integration_spec.rb +21 -19
  154. data/spec/api/pdf_api_spec_original.skipped.rb +469 -98
  155. data/spec/models/add_fields_data_spec.rb +8 -13
  156. data/spec/models/add_fields_template_response_spec.rb +16 -21
  157. data/spec/models/authentication_error_spec.rb +10 -15
  158. data/spec/models/authentication_success_response_spec.rb +9 -14
  159. data/spec/models/combine_pdfs_data_spec.rb +18 -17
  160. data/spec/models/combined_submission_action_spec.rb +16 -21
  161. data/spec/models/combined_submission_data_spec.rb +17 -16
  162. data/spec/models/combined_submission_spec.rb +45 -32
  163. data/spec/models/copy_template_data_spec.rb +9 -14
  164. data/spec/models/create_combined_submission_response_spec.rb +16 -21
  165. data/spec/models/create_custom_file_data_spec.rb +8 -13
  166. data/spec/models/create_custom_file_response_spec.rb +16 -21
  167. data/spec/models/create_folder_attributes_spec.rb +42 -0
  168. data/spec/models/create_folder_data_spec.rb +8 -13
  169. data/spec/models/create_html_template_data_spec.rb +8 -13
  170. data/spec/models/create_submission_batch_response_spec.rb +21 -26
  171. data/spec/models/create_submission_batch_submissions_response_spec.rb +16 -21
  172. data/spec/models/create_submission_data_request_data_spec.rb +33 -38
  173. data/spec/models/create_submission_data_request_event_request_spec.rb +62 -0
  174. data/spec/models/create_submission_data_request_event_response_spec.rb +52 -0
  175. data/spec/models/create_submission_data_request_token_response_spec.rb +15 -20
  176. data/spec/models/create_submission_data_spec.rb +90 -0
  177. data/spec/models/create_submission_response_spec.rb +16 -21
  178. data/spec/models/create_template_from_upload_data_spec.rb +8 -13
  179. data/spec/models/data_request_token_spec.rb +54 -0
  180. data/spec/models/delete_template_response_spec.rb +46 -0
  181. data/spec/models/error_response_spec.rb +46 -0
  182. data/spec/models/folder_spec.rb +15 -20
  183. data/spec/models/full_template_spec.rb +268 -0
  184. data/spec/models/html_template_data_spec.rb +62 -49
  185. data/spec/models/html_template_data_webhook_options_spec.rb +36 -0
  186. data/spec/models/invalid_request_single_error_spec.rb +46 -0
  187. data/spec/models/invalid_request_spec.rb +10 -15
  188. data/spec/models/list_submissions_response_spec.rb +48 -0
  189. data/spec/models/move_folder_data_spec.rb +8 -13
  190. data/spec/models/move_template_data_spec.rb +8 -13
  191. data/spec/models/pending_template_spec.rb +45 -50
  192. data/spec/models/preview_pdf_response_spec.rb +46 -0
  193. data/spec/models/publish_template_version404_response_spec.rb +46 -0
  194. data/spec/models/publish_template_version422_response_spec.rb +46 -0
  195. data/spec/models/publish_template_version_response_result_spec.rb +54 -0
  196. data/spec/models/publish_template_version_response_spec.rb +46 -0
  197. data/spec/models/publish_version_data_spec.rb +42 -0
  198. data/spec/models/rename_folder_data_spec.rb +8 -13
  199. data/spec/models/restore_template_version_response_spec.rb +40 -0
  200. data/spec/models/restore_version_data_spec.rb +36 -0
  201. data/spec/models/submission_action_spec.rb +16 -21
  202. data/spec/models/submission_batch_data_spec.rb +17 -16
  203. data/spec/models/submission_batch_spec.rb +29 -34
  204. data/spec/models/submission_data_batch_request_spec.rb +24 -23
  205. data/spec/models/submission_data_request_event_spec.rb +72 -0
  206. data/spec/models/submission_data_request_spec.rb +36 -35
  207. data/spec/models/submission_data_spec.rb +13 -24
  208. data/spec/models/submission_spec.rb +27 -32
  209. data/spec/models/template_data_spec.rb +59 -46
  210. data/spec/models/template_defaults_spec.rb +48 -0
  211. data/spec/models/template_document_metadata_spec.rb +52 -0
  212. data/spec/models/template_document_spec.rb +52 -0
  213. data/spec/models/template_schema_spec.rb +84 -0
  214. data/spec/models/template_spec.rb +50 -55
  215. data/spec/models/update_data_request_response_spec.rb +16 -21
  216. data/spec/models/update_submission_data_request_data_spec.rb +22 -27
  217. data/spec/models/update_template_data_spec.rb +8 -13
  218. data/spec/models/update_template_response_spec.rb +14 -19
  219. data/spec/models/upload_presign_spec.rb +58 -0
  220. data/spec/models/upload_template_data_spec.rb +64 -51
  221. data/spec/spec_helper.rb +5 -5
  222. metadata +112 -124
  223. data/docs/CreateSubmissionDataRequestTokenResponseToken.md +0 -11
  224. data/docs/CustomFile.md +0 -9
  225. data/docs/Error.md +0 -9
  226. data/docs/FoldersFolder.md +0 -9
  227. data/docs/TemplatestemplateIdaddFieldsFields.md +0 -92
  228. data/docs/UploadTemplateDataDocument.md +0 -10
  229. data/docs/UploadTemplateDataDocumentMetadata.md +0 -10
  230. data/lib/docspring/models/templatestemplate_idadd_fields_fields.rb +0 -1306
  231. data/spec/api_client_spec.rb +0 -226
  232. data/spec/configuration_spec.rb +0 -53
  233. data/spec/models/create_submission_data_request_token_response_token_spec.rb +0 -59
  234. data/spec/models/custom_file_spec.rb +0 -47
  235. data/spec/models/error_spec.rb +0 -51
  236. data/spec/models/folders_folder_spec.rb +0 -47
  237. data/spec/models/templatestemplate_idadd_fields_fields_spec.rb +0 -589
  238. data/spec/models/upload_template_data_document_metadata_spec.rb +0 -57
  239. data/spec/models/upload_template_data_document_spec.rb +0 -57
@@ -3,14 +3,14 @@
3
3
 
4
4
  #DocSpring is a service that helps you fill out and sign PDF templates.
5
5
 
6
- OpenAPI spec version: v1
6
+ The version of the OpenAPI document: v1
7
7
 
8
8
  Generated by: https://openapi-generator.tech
9
- OpenAPI Generator version: 3.3.0
9
+ Generator version: 7.11.0
10
10
 
11
11
  =end
12
12
 
13
- require 'uri'
13
+ require 'cgi'
14
14
 
15
15
  module DocSpring
16
16
  class PDFApi
@@ -20,21 +20,21 @@ module DocSpring
20
20
  @api_client = api_client
21
21
  end
22
22
  # Add new fields to a Template
23
- # @param template_id
24
- # @param add_fields_data
23
+ # @param template_id [String]
24
+ # @param data [AddFieldsData]
25
25
  # @param [Hash] opts the optional parameters
26
26
  # @return [AddFieldsTemplateResponse]
27
- def add_fields_to_template(template_id, add_fields_data, opts = {})
28
- data, _status_code, _headers = add_fields_to_template_with_http_info(template_id, add_fields_data, opts)
27
+ def add_fields_to_template(template_id, data, opts = {})
28
+ data, _status_code, _headers = add_fields_to_template_with_http_info(template_id, data, opts)
29
29
  data
30
30
  end
31
31
 
32
32
  # Add new fields to a Template
33
- # @param template_id
34
- # @param add_fields_data
33
+ # @param template_id [String]
34
+ # @param data [AddFieldsData]
35
35
  # @param [Hash] opts the optional parameters
36
- # @return [Array<(AddFieldsTemplateResponse, Fixnum, Hash)>] AddFieldsTemplateResponse data, response status code and response headers
37
- def add_fields_to_template_with_http_info(template_id, add_fields_data, opts = {})
36
+ # @return [Array<(AddFieldsTemplateResponse, Integer, Hash)>] AddFieldsTemplateResponse data, response status code and response headers
37
+ def add_fields_to_template_with_http_info(template_id, data, opts = {})
38
38
  if @api_client.config.debugging
39
39
  @api_client.config.logger.debug 'Calling API: PDFApi.add_fields_to_template ...'
40
40
  end
@@ -42,36 +42,49 @@ module DocSpring
42
42
  if @api_client.config.client_side_validation && template_id.nil?
43
43
  fail ArgumentError, "Missing the required parameter 'template_id' when calling PDFApi.add_fields_to_template"
44
44
  end
45
- # verify the required parameter 'add_fields_data' is set
46
- if @api_client.config.client_side_validation && add_fields_data.nil?
47
- fail ArgumentError, "Missing the required parameter 'add_fields_data' when calling PDFApi.add_fields_to_template"
45
+ # verify the required parameter 'data' is set
46
+ if @api_client.config.client_side_validation && data.nil?
47
+ fail ArgumentError, "Missing the required parameter 'data' when calling PDFApi.add_fields_to_template"
48
48
  end
49
49
  # resource path
50
- local_var_path = '/templates/{template_id}/add_fields'.sub('{' + 'template_id' + '}', template_id.to_s)
50
+ local_var_path = '/templates/{template_id}/add_fields'.sub('{' + 'template_id' + '}', CGI.escape(template_id.to_s))
51
51
 
52
52
  # query parameters
53
- query_params = {}
53
+ query_params = opts[:query_params] || {}
54
54
 
55
55
  # header parameters
56
- header_params = {}
56
+ header_params = opts[:header_params] || {}
57
57
  # HTTP header 'Accept' (if needed)
58
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
58
+ header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
59
59
  # HTTP header 'Content-Type'
60
- header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
60
+ content_type = @api_client.select_header_content_type(['application/json'])
61
+ if !content_type.nil?
62
+ header_params['Content-Type'] = content_type
63
+ end
61
64
 
62
65
  # form parameters
63
- form_params = {}
66
+ form_params = opts[:form_params] || {}
64
67
 
65
68
  # http body (model)
66
- post_body = @api_client.object_to_http_body(add_fields_data)
67
- auth_names = ['api_token_basic']
68
- data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
69
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(data)
70
+
71
+ # return_type
72
+ return_type = opts[:debug_return_type] || 'AddFieldsTemplateResponse'
73
+
74
+ # auth_names
75
+ auth_names = opts[:debug_auth_names] || ['api_token_basic']
76
+
77
+ new_options = opts.merge(
78
+ :operation => :"PDFApi.add_fields_to_template",
69
79
  :header_params => header_params,
70
80
  :query_params => query_params,
71
81
  :form_params => form_params,
72
82
  :body => post_body,
73
83
  :auth_names => auth_names,
74
- :return_type => 'AddFieldsTemplateResponse')
84
+ :return_type => return_type
85
+ )
86
+
87
+ data, status_code, headers = @api_client.call_api(:PUT, local_var_path, new_options)
75
88
  if @api_client.config.debugging
76
89
  @api_client.config.logger.debug "API called: PDFApi#add_fields_to_template\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
77
90
  end
@@ -79,21 +92,21 @@ module DocSpring
79
92
  end
80
93
 
81
94
  # Generates multiple PDFs
82
- # @param template_id
83
- # @param request_body
95
+ # @param template_id [String]
96
+ # @param data [Array<SubmissionData>]
84
97
  # @param [Hash] opts the optional parameters
85
98
  # @return [Array<CreateSubmissionResponse>]
86
- def batch_generate_pdf_v1(template_id, request_body, opts = {})
87
- data, _status_code, _headers = batch_generate_pdf_v1_with_http_info(template_id, request_body, opts)
99
+ def batch_generate_pdf_v1(template_id, data, opts = {})
100
+ data, _status_code, _headers = batch_generate_pdf_v1_with_http_info(template_id, data, opts)
88
101
  data
89
102
  end
90
103
 
91
104
  # Generates multiple PDFs
92
- # @param template_id
93
- # @param request_body
105
+ # @param template_id [String]
106
+ # @param data [Array<SubmissionData>]
94
107
  # @param [Hash] opts the optional parameters
95
- # @return [Array<(Array<CreateSubmissionResponse>, Fixnum, Hash)>] Array<CreateSubmissionResponse> data, response status code and response headers
96
- def batch_generate_pdf_v1_with_http_info(template_id, request_body, opts = {})
108
+ # @return [Array<(Array<CreateSubmissionResponse>, Integer, Hash)>] Array<CreateSubmissionResponse> data, response status code and response headers
109
+ def batch_generate_pdf_v1_with_http_info(template_id, data, opts = {})
97
110
  if @api_client.config.debugging
98
111
  @api_client.config.logger.debug 'Calling API: PDFApi.batch_generate_pdf_v1 ...'
99
112
  end
@@ -101,36 +114,49 @@ module DocSpring
101
114
  if @api_client.config.client_side_validation && template_id.nil?
102
115
  fail ArgumentError, "Missing the required parameter 'template_id' when calling PDFApi.batch_generate_pdf_v1"
103
116
  end
104
- # verify the required parameter 'request_body' is set
105
- if @api_client.config.client_side_validation && request_body.nil?
106
- fail ArgumentError, "Missing the required parameter 'request_body' when calling PDFApi.batch_generate_pdf_v1"
117
+ # verify the required parameter 'data' is set
118
+ if @api_client.config.client_side_validation && data.nil?
119
+ fail ArgumentError, "Missing the required parameter 'data' when calling PDFApi.batch_generate_pdf_v1"
107
120
  end
108
121
  # resource path
109
- local_var_path = '/templates/{template_id}/submissions/batch'.sub('{' + 'template_id' + '}', template_id.to_s)
122
+ local_var_path = '/templates/{template_id}/submissions/batch'.sub('{' + 'template_id' + '}', CGI.escape(template_id.to_s))
110
123
 
111
124
  # query parameters
112
- query_params = {}
125
+ query_params = opts[:query_params] || {}
113
126
 
114
127
  # header parameters
115
- header_params = {}
128
+ header_params = opts[:header_params] || {}
116
129
  # HTTP header 'Accept' (if needed)
117
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
130
+ header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
118
131
  # HTTP header 'Content-Type'
119
- header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
132
+ content_type = @api_client.select_header_content_type(['application/json'])
133
+ if !content_type.nil?
134
+ header_params['Content-Type'] = content_type
135
+ end
120
136
 
121
137
  # form parameters
122
- form_params = {}
138
+ form_params = opts[:form_params] || {}
123
139
 
124
140
  # http body (model)
125
- post_body = @api_client.object_to_http_body(request_body)
126
- auth_names = ['api_token_basic']
127
- data, status_code, headers = @api_client.call_api(:POST, local_var_path,
141
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(data)
142
+
143
+ # return_type
144
+ return_type = opts[:debug_return_type] || 'Array<CreateSubmissionResponse>'
145
+
146
+ # auth_names
147
+ auth_names = opts[:debug_auth_names] || ['api_token_basic']
148
+
149
+ new_options = opts.merge(
150
+ :operation => :"PDFApi.batch_generate_pdf_v1",
128
151
  :header_params => header_params,
129
152
  :query_params => query_params,
130
153
  :form_params => form_params,
131
154
  :body => post_body,
132
155
  :auth_names => auth_names,
133
- :return_type => 'Array<CreateSubmissionResponse>')
156
+ :return_type => return_type
157
+ )
158
+
159
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
134
160
  if @api_client.config.debugging
135
161
  @api_client.config.logger.debug "API called: PDFApi#batch_generate_pdf_v1\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
136
162
  end
@@ -138,52 +164,65 @@ module DocSpring
138
164
  end
139
165
 
140
166
  # Generates multiple PDFs
141
- # @param submission_batch_data
167
+ # @param data [SubmissionBatchData]
142
168
  # @param [Hash] opts the optional parameters
143
169
  # @return [CreateSubmissionBatchResponse]
144
- def batch_generate_pdfs(submission_batch_data, opts = {})
145
- data, _status_code, _headers = batch_generate_pdfs_with_http_info(submission_batch_data, opts)
170
+ def batch_generate_pdfs(data, opts = {})
171
+ data, _status_code, _headers = batch_generate_pdfs_with_http_info(data, opts)
146
172
  data
147
173
  end
148
174
 
149
175
  # Generates multiple PDFs
150
- # @param submission_batch_data
176
+ # @param data [SubmissionBatchData]
151
177
  # @param [Hash] opts the optional parameters
152
- # @return [Array<(CreateSubmissionBatchResponse, Fixnum, Hash)>] CreateSubmissionBatchResponse data, response status code and response headers
153
- def batch_generate_pdfs_with_http_info(submission_batch_data, opts = {})
178
+ # @return [Array<(CreateSubmissionBatchResponse, Integer, Hash)>] CreateSubmissionBatchResponse data, response status code and response headers
179
+ def batch_generate_pdfs_with_http_info(data, opts = {})
154
180
  if @api_client.config.debugging
155
181
  @api_client.config.logger.debug 'Calling API: PDFApi.batch_generate_pdfs ...'
156
182
  end
157
- # verify the required parameter 'submission_batch_data' is set
158
- if @api_client.config.client_side_validation && submission_batch_data.nil?
159
- fail ArgumentError, "Missing the required parameter 'submission_batch_data' when calling PDFApi.batch_generate_pdfs"
183
+ # verify the required parameter 'data' is set
184
+ if @api_client.config.client_side_validation && data.nil?
185
+ fail ArgumentError, "Missing the required parameter 'data' when calling PDFApi.batch_generate_pdfs"
160
186
  end
161
187
  # resource path
162
188
  local_var_path = '/submissions/batches'
163
189
 
164
190
  # query parameters
165
- query_params = {}
191
+ query_params = opts[:query_params] || {}
166
192
 
167
193
  # header parameters
168
- header_params = {}
194
+ header_params = opts[:header_params] || {}
169
195
  # HTTP header 'Accept' (if needed)
170
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
196
+ header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
171
197
  # HTTP header 'Content-Type'
172
- header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
198
+ content_type = @api_client.select_header_content_type(['application/json'])
199
+ if !content_type.nil?
200
+ header_params['Content-Type'] = content_type
201
+ end
173
202
 
174
203
  # form parameters
175
- form_params = {}
204
+ form_params = opts[:form_params] || {}
176
205
 
177
206
  # http body (model)
178
- post_body = @api_client.object_to_http_body(submission_batch_data)
179
- auth_names = ['api_token_basic']
180
- data, status_code, headers = @api_client.call_api(:POST, local_var_path,
207
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(data)
208
+
209
+ # return_type
210
+ return_type = opts[:debug_return_type] || 'CreateSubmissionBatchResponse'
211
+
212
+ # auth_names
213
+ auth_names = opts[:debug_auth_names] || ['api_token_basic']
214
+
215
+ new_options = opts.merge(
216
+ :operation => :"PDFApi.batch_generate_pdfs",
181
217
  :header_params => header_params,
182
218
  :query_params => query_params,
183
219
  :form_params => form_params,
184
220
  :body => post_body,
185
221
  :auth_names => auth_names,
186
- :return_type => 'CreateSubmissionBatchResponse')
222
+ :return_type => return_type
223
+ )
224
+
225
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
187
226
  if @api_client.config.debugging
188
227
  @api_client.config.logger.debug "API called: PDFApi#batch_generate_pdfs\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
189
228
  end
@@ -191,52 +230,65 @@ module DocSpring
191
230
  end
192
231
 
193
232
  # Merge submission PDFs, template PDFs, or custom files
194
- # @param combine_pdfs_data
233
+ # @param data [CombinePdfsData]
195
234
  # @param [Hash] opts the optional parameters
196
235
  # @return [CreateCombinedSubmissionResponse]
197
- def combine_pdfs(combine_pdfs_data, opts = {})
198
- data, _status_code, _headers = combine_pdfs_with_http_info(combine_pdfs_data, opts)
236
+ def combine_pdfs(data, opts = {})
237
+ data, _status_code, _headers = combine_pdfs_with_http_info(data, opts)
199
238
  data
200
239
  end
201
240
 
202
241
  # Merge submission PDFs, template PDFs, or custom files
203
- # @param combine_pdfs_data
242
+ # @param data [CombinePdfsData]
204
243
  # @param [Hash] opts the optional parameters
205
- # @return [Array<(CreateCombinedSubmissionResponse, Fixnum, Hash)>] CreateCombinedSubmissionResponse data, response status code and response headers
206
- def combine_pdfs_with_http_info(combine_pdfs_data, opts = {})
244
+ # @return [Array<(CreateCombinedSubmissionResponse, Integer, Hash)>] CreateCombinedSubmissionResponse data, response status code and response headers
245
+ def combine_pdfs_with_http_info(data, opts = {})
207
246
  if @api_client.config.debugging
208
247
  @api_client.config.logger.debug 'Calling API: PDFApi.combine_pdfs ...'
209
248
  end
210
- # verify the required parameter 'combine_pdfs_data' is set
211
- if @api_client.config.client_side_validation && combine_pdfs_data.nil?
212
- fail ArgumentError, "Missing the required parameter 'combine_pdfs_data' when calling PDFApi.combine_pdfs"
249
+ # verify the required parameter 'data' is set
250
+ if @api_client.config.client_side_validation && data.nil?
251
+ fail ArgumentError, "Missing the required parameter 'data' when calling PDFApi.combine_pdfs"
213
252
  end
214
253
  # resource path
215
254
  local_var_path = '/combined_submissions?v=2'
216
255
 
217
256
  # query parameters
218
- query_params = {}
257
+ query_params = opts[:query_params] || {}
219
258
 
220
259
  # header parameters
221
- header_params = {}
260
+ header_params = opts[:header_params] || {}
222
261
  # HTTP header 'Accept' (if needed)
223
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
262
+ header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
224
263
  # HTTP header 'Content-Type'
225
- header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
264
+ content_type = @api_client.select_header_content_type(['application/json'])
265
+ if !content_type.nil?
266
+ header_params['Content-Type'] = content_type
267
+ end
226
268
 
227
269
  # form parameters
228
- form_params = {}
270
+ form_params = opts[:form_params] || {}
229
271
 
230
272
  # http body (model)
231
- post_body = @api_client.object_to_http_body(combine_pdfs_data)
232
- auth_names = ['api_token_basic']
233
- data, status_code, headers = @api_client.call_api(:POST, local_var_path,
273
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(data)
274
+
275
+ # return_type
276
+ return_type = opts[:debug_return_type] || 'CreateCombinedSubmissionResponse'
277
+
278
+ # auth_names
279
+ auth_names = opts[:debug_auth_names] || ['api_token_basic']
280
+
281
+ new_options = opts.merge(
282
+ :operation => :"PDFApi.combine_pdfs",
234
283
  :header_params => header_params,
235
284
  :query_params => query_params,
236
285
  :form_params => form_params,
237
286
  :body => post_body,
238
287
  :auth_names => auth_names,
239
- :return_type => 'CreateCombinedSubmissionResponse')
288
+ :return_type => return_type
289
+ )
290
+
291
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
240
292
  if @api_client.config.debugging
241
293
  @api_client.config.logger.debug "API called: PDFApi#combine_pdfs\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
242
294
  end
@@ -244,52 +296,65 @@ module DocSpring
244
296
  end
245
297
 
246
298
  # Merge generated PDFs together
247
- # @param combined_submission_data
299
+ # @param data [CombinedSubmissionData]
248
300
  # @param [Hash] opts the optional parameters
249
301
  # @return [CreateCombinedSubmissionResponse]
250
- def combine_submissions(combined_submission_data, opts = {})
251
- data, _status_code, _headers = combine_submissions_with_http_info(combined_submission_data, opts)
302
+ def combine_submissions(data, opts = {})
303
+ data, _status_code, _headers = combine_submissions_with_http_info(data, opts)
252
304
  data
253
305
  end
254
306
 
255
307
  # Merge generated PDFs together
256
- # @param combined_submission_data
308
+ # @param data [CombinedSubmissionData]
257
309
  # @param [Hash] opts the optional parameters
258
- # @return [Array<(CreateCombinedSubmissionResponse, Fixnum, Hash)>] CreateCombinedSubmissionResponse data, response status code and response headers
259
- def combine_submissions_with_http_info(combined_submission_data, opts = {})
310
+ # @return [Array<(CreateCombinedSubmissionResponse, Integer, Hash)>] CreateCombinedSubmissionResponse data, response status code and response headers
311
+ def combine_submissions_with_http_info(data, opts = {})
260
312
  if @api_client.config.debugging
261
313
  @api_client.config.logger.debug 'Calling API: PDFApi.combine_submissions ...'
262
314
  end
263
- # verify the required parameter 'combined_submission_data' is set
264
- if @api_client.config.client_side_validation && combined_submission_data.nil?
265
- fail ArgumentError, "Missing the required parameter 'combined_submission_data' when calling PDFApi.combine_submissions"
315
+ # verify the required parameter 'data' is set
316
+ if @api_client.config.client_side_validation && data.nil?
317
+ fail ArgumentError, "Missing the required parameter 'data' when calling PDFApi.combine_submissions"
266
318
  end
267
319
  # resource path
268
320
  local_var_path = '/combined_submissions'
269
321
 
270
322
  # query parameters
271
- query_params = {}
323
+ query_params = opts[:query_params] || {}
272
324
 
273
325
  # header parameters
274
- header_params = {}
326
+ header_params = opts[:header_params] || {}
275
327
  # HTTP header 'Accept' (if needed)
276
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
328
+ header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
277
329
  # HTTP header 'Content-Type'
278
- header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
330
+ content_type = @api_client.select_header_content_type(['application/json'])
331
+ if !content_type.nil?
332
+ header_params['Content-Type'] = content_type
333
+ end
279
334
 
280
335
  # form parameters
281
- form_params = {}
336
+ form_params = opts[:form_params] || {}
282
337
 
283
338
  # http body (model)
284
- post_body = @api_client.object_to_http_body(combined_submission_data)
285
- auth_names = ['api_token_basic']
286
- data, status_code, headers = @api_client.call_api(:POST, local_var_path,
339
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(data)
340
+
341
+ # return_type
342
+ return_type = opts[:debug_return_type] || 'CreateCombinedSubmissionResponse'
343
+
344
+ # auth_names
345
+ auth_names = opts[:debug_auth_names] || ['api_token_basic']
346
+
347
+ new_options = opts.merge(
348
+ :operation => :"PDFApi.combine_submissions",
287
349
  :header_params => header_params,
288
350
  :query_params => query_params,
289
351
  :form_params => form_params,
290
352
  :body => post_body,
291
353
  :auth_names => auth_names,
292
- :return_type => 'CreateCombinedSubmissionResponse')
354
+ :return_type => return_type
355
+ )
356
+
357
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
293
358
  if @api_client.config.debugging
294
359
  @api_client.config.logger.debug "API called: PDFApi#combine_submissions\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
295
360
  end
@@ -297,21 +362,21 @@ module DocSpring
297
362
  end
298
363
 
299
364
  # Copy a Template
300
- # @param template_id
301
- # @param copy_template_data
365
+ # @param template_id [String]
366
+ # @param data [CopyTemplateData]
302
367
  # @param [Hash] opts the optional parameters
303
368
  # @return [Template]
304
- def copy_template(template_id, copy_template_data, opts = {})
305
- data, _status_code, _headers = copy_template_with_http_info(template_id, copy_template_data, opts)
369
+ def copy_template(template_id, data, opts = {})
370
+ data, _status_code, _headers = copy_template_with_http_info(template_id, data, opts)
306
371
  data
307
372
  end
308
373
 
309
374
  # Copy a Template
310
- # @param template_id
311
- # @param copy_template_data
375
+ # @param template_id [String]
376
+ # @param data [CopyTemplateData]
312
377
  # @param [Hash] opts the optional parameters
313
- # @return [Array<(Template, Fixnum, Hash)>] Template data, response status code and response headers
314
- def copy_template_with_http_info(template_id, copy_template_data, opts = {})
378
+ # @return [Array<(Template, Integer, Hash)>] Template data, response status code and response headers
379
+ def copy_template_with_http_info(template_id, data, opts = {})
315
380
  if @api_client.config.debugging
316
381
  @api_client.config.logger.debug 'Calling API: PDFApi.copy_template ...'
317
382
  end
@@ -319,36 +384,49 @@ module DocSpring
319
384
  if @api_client.config.client_side_validation && template_id.nil?
320
385
  fail ArgumentError, "Missing the required parameter 'template_id' when calling PDFApi.copy_template"
321
386
  end
322
- # verify the required parameter 'copy_template_data' is set
323
- if @api_client.config.client_side_validation && copy_template_data.nil?
324
- fail ArgumentError, "Missing the required parameter 'copy_template_data' when calling PDFApi.copy_template"
387
+ # verify the required parameter 'data' is set
388
+ if @api_client.config.client_side_validation && data.nil?
389
+ fail ArgumentError, "Missing the required parameter 'data' when calling PDFApi.copy_template"
325
390
  end
326
391
  # resource path
327
- local_var_path = '/templates/{template_id}/copy'.sub('{' + 'template_id' + '}', template_id.to_s)
392
+ local_var_path = '/templates/{template_id}/copy'.sub('{' + 'template_id' + '}', CGI.escape(template_id.to_s))
328
393
 
329
394
  # query parameters
330
- query_params = {}
395
+ query_params = opts[:query_params] || {}
331
396
 
332
397
  # header parameters
333
- header_params = {}
398
+ header_params = opts[:header_params] || {}
334
399
  # HTTP header 'Accept' (if needed)
335
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
400
+ header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
336
401
  # HTTP header 'Content-Type'
337
- header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
402
+ content_type = @api_client.select_header_content_type(['application/json'])
403
+ if !content_type.nil?
404
+ header_params['Content-Type'] = content_type
405
+ end
338
406
 
339
407
  # form parameters
340
- form_params = {}
408
+ form_params = opts[:form_params] || {}
341
409
 
342
410
  # http body (model)
343
- post_body = @api_client.object_to_http_body(copy_template_data)
344
- auth_names = ['api_token_basic']
345
- data, status_code, headers = @api_client.call_api(:POST, local_var_path,
411
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(data)
412
+
413
+ # return_type
414
+ return_type = opts[:debug_return_type] || 'Template'
415
+
416
+ # auth_names
417
+ auth_names = opts[:debug_auth_names] || ['api_token_basic']
418
+
419
+ new_options = opts.merge(
420
+ :operation => :"PDFApi.copy_template",
346
421
  :header_params => header_params,
347
422
  :query_params => query_params,
348
423
  :form_params => form_params,
349
424
  :body => post_body,
350
425
  :auth_names => auth_names,
351
- :return_type => 'Template')
426
+ :return_type => return_type
427
+ )
428
+
429
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
352
430
  if @api_client.config.debugging
353
431
  @api_client.config.logger.debug "API called: PDFApi#copy_template\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
354
432
  end
@@ -356,60 +434,145 @@ module DocSpring
356
434
  end
357
435
 
358
436
  # Create a new custom file from a cached presign upload
359
- # @param create_custom_file_data
437
+ # @param data [CreateCustomFileData]
360
438
  # @param [Hash] opts the optional parameters
361
439
  # @return [CreateCustomFileResponse]
362
- def create_custom_file_from_upload(create_custom_file_data, opts = {})
363
- data, _status_code, _headers = create_custom_file_from_upload_with_http_info(create_custom_file_data, opts)
440
+ def create_custom_file_from_upload(data, opts = {})
441
+ data, _status_code, _headers = create_custom_file_from_upload_with_http_info(data, opts)
364
442
  data
365
443
  end
366
444
 
367
445
  # Create a new custom file from a cached presign upload
368
- # @param create_custom_file_data
446
+ # @param data [CreateCustomFileData]
369
447
  # @param [Hash] opts the optional parameters
370
- # @return [Array<(CreateCustomFileResponse, Fixnum, Hash)>] CreateCustomFileResponse data, response status code and response headers
371
- def create_custom_file_from_upload_with_http_info(create_custom_file_data, opts = {})
448
+ # @return [Array<(CreateCustomFileResponse, Integer, Hash)>] CreateCustomFileResponse data, response status code and response headers
449
+ def create_custom_file_from_upload_with_http_info(data, opts = {})
372
450
  if @api_client.config.debugging
373
451
  @api_client.config.logger.debug 'Calling API: PDFApi.create_custom_file_from_upload ...'
374
452
  end
375
- # verify the required parameter 'create_custom_file_data' is set
376
- if @api_client.config.client_side_validation && create_custom_file_data.nil?
377
- fail ArgumentError, "Missing the required parameter 'create_custom_file_data' when calling PDFApi.create_custom_file_from_upload"
453
+ # verify the required parameter 'data' is set
454
+ if @api_client.config.client_side_validation && data.nil?
455
+ fail ArgumentError, "Missing the required parameter 'data' when calling PDFApi.create_custom_file_from_upload"
378
456
  end
379
457
  # resource path
380
458
  local_var_path = '/custom_files'
381
459
 
382
460
  # query parameters
383
- query_params = {}
461
+ query_params = opts[:query_params] || {}
384
462
 
385
463
  # header parameters
386
- header_params = {}
464
+ header_params = opts[:header_params] || {}
387
465
  # HTTP header 'Accept' (if needed)
388
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
466
+ header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
389
467
  # HTTP header 'Content-Type'
390
- header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
468
+ content_type = @api_client.select_header_content_type(['application/json'])
469
+ if !content_type.nil?
470
+ header_params['Content-Type'] = content_type
471
+ end
391
472
 
392
473
  # form parameters
393
- form_params = {}
474
+ form_params = opts[:form_params] || {}
394
475
 
395
476
  # http body (model)
396
- post_body = @api_client.object_to_http_body(create_custom_file_data)
397
- auth_names = ['api_token_basic']
398
- data, status_code, headers = @api_client.call_api(:POST, local_var_path,
477
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(data)
478
+
479
+ # return_type
480
+ return_type = opts[:debug_return_type] || 'CreateCustomFileResponse'
481
+
482
+ # auth_names
483
+ auth_names = opts[:debug_auth_names] || ['api_token_basic']
484
+
485
+ new_options = opts.merge(
486
+ :operation => :"PDFApi.create_custom_file_from_upload",
399
487
  :header_params => header_params,
400
488
  :query_params => query_params,
401
489
  :form_params => form_params,
402
490
  :body => post_body,
403
491
  :auth_names => auth_names,
404
- :return_type => 'CreateCustomFileResponse')
492
+ :return_type => return_type
493
+ )
494
+
495
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
405
496
  if @api_client.config.debugging
406
497
  @api_client.config.logger.debug "API called: PDFApi#create_custom_file_from_upload\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
407
498
  end
408
499
  return data, status_code, headers
409
500
  end
410
501
 
502
+ # Creates a new event for emailing a signee a request for signature
503
+ # @param data_request_id [String]
504
+ # @param event [CreateSubmissionDataRequestEventRequest]
505
+ # @param [Hash] opts the optional parameters
506
+ # @return [CreateSubmissionDataRequestEventResponse]
507
+ def create_data_request_event(data_request_id, event, opts = {})
508
+ data, _status_code, _headers = create_data_request_event_with_http_info(data_request_id, event, opts)
509
+ data
510
+ end
511
+
512
+ # Creates a new event for emailing a signee a request for signature
513
+ # @param data_request_id [String]
514
+ # @param event [CreateSubmissionDataRequestEventRequest]
515
+ # @param [Hash] opts the optional parameters
516
+ # @return [Array<(CreateSubmissionDataRequestEventResponse, Integer, Hash)>] CreateSubmissionDataRequestEventResponse data, response status code and response headers
517
+ def create_data_request_event_with_http_info(data_request_id, event, opts = {})
518
+ if @api_client.config.debugging
519
+ @api_client.config.logger.debug 'Calling API: PDFApi.create_data_request_event ...'
520
+ end
521
+ # verify the required parameter 'data_request_id' is set
522
+ if @api_client.config.client_side_validation && data_request_id.nil?
523
+ fail ArgumentError, "Missing the required parameter 'data_request_id' when calling PDFApi.create_data_request_event"
524
+ end
525
+ # verify the required parameter 'event' is set
526
+ if @api_client.config.client_side_validation && event.nil?
527
+ fail ArgumentError, "Missing the required parameter 'event' when calling PDFApi.create_data_request_event"
528
+ end
529
+ # resource path
530
+ local_var_path = '/data_requests/{data_request_id}/events'.sub('{' + 'data_request_id' + '}', CGI.escape(data_request_id.to_s))
531
+
532
+ # query parameters
533
+ query_params = opts[:query_params] || {}
534
+
535
+ # header parameters
536
+ header_params = opts[:header_params] || {}
537
+ # HTTP header 'Accept' (if needed)
538
+ header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
539
+ # HTTP header 'Content-Type'
540
+ content_type = @api_client.select_header_content_type(['application/json'])
541
+ if !content_type.nil?
542
+ header_params['Content-Type'] = content_type
543
+ end
544
+
545
+ # form parameters
546
+ form_params = opts[:form_params] || {}
547
+
548
+ # http body (model)
549
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(event)
550
+
551
+ # return_type
552
+ return_type = opts[:debug_return_type] || 'CreateSubmissionDataRequestEventResponse'
553
+
554
+ # auth_names
555
+ auth_names = opts[:debug_auth_names] || ['api_token_basic']
556
+
557
+ new_options = opts.merge(
558
+ :operation => :"PDFApi.create_data_request_event",
559
+ :header_params => header_params,
560
+ :query_params => query_params,
561
+ :form_params => form_params,
562
+ :body => post_body,
563
+ :auth_names => auth_names,
564
+ :return_type => return_type
565
+ )
566
+
567
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
568
+ if @api_client.config.debugging
569
+ @api_client.config.logger.debug "API called: PDFApi#create_data_request_event\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
570
+ end
571
+ return data, status_code, headers
572
+ end
573
+
411
574
  # Creates a new data request token for form authentication
412
- # @param data_request_id
575
+ # @param data_request_id [String]
413
576
  # @param [Hash] opts the optional parameters
414
577
  # @return [CreateSubmissionDataRequestTokenResponse]
415
578
  def create_data_request_token(data_request_id, opts = {})
@@ -418,9 +581,9 @@ module DocSpring
418
581
  end
419
582
 
420
583
  # Creates a new data request token for form authentication
421
- # @param data_request_id
584
+ # @param data_request_id [String]
422
585
  # @param [Hash] opts the optional parameters
423
- # @return [Array<(CreateSubmissionDataRequestTokenResponse, Fixnum, Hash)>] CreateSubmissionDataRequestTokenResponse data, response status code and response headers
586
+ # @return [Array<(CreateSubmissionDataRequestTokenResponse, Integer, Hash)>] CreateSubmissionDataRequestTokenResponse data, response status code and response headers
424
587
  def create_data_request_token_with_http_info(data_request_id, opts = {})
425
588
  if @api_client.config.debugging
426
589
  @api_client.config.logger.debug 'Calling API: PDFApi.create_data_request_token ...'
@@ -430,29 +593,39 @@ module DocSpring
430
593
  fail ArgumentError, "Missing the required parameter 'data_request_id' when calling PDFApi.create_data_request_token"
431
594
  end
432
595
  # resource path
433
- local_var_path = '/data_requests/{data_request_id}/tokens'.sub('{' + 'data_request_id' + '}', data_request_id.to_s)
596
+ local_var_path = '/data_requests/{data_request_id}/tokens'.sub('{' + 'data_request_id' + '}', CGI.escape(data_request_id.to_s))
434
597
 
435
598
  # query parameters
436
- query_params = {}
599
+ query_params = opts[:query_params] || {}
437
600
 
438
601
  # header parameters
439
- header_params = {}
602
+ header_params = opts[:header_params] || {}
440
603
  # HTTP header 'Accept' (if needed)
441
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
604
+ header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
442
605
 
443
606
  # form parameters
444
- form_params = {}
607
+ form_params = opts[:form_params] || {}
445
608
 
446
609
  # http body (model)
447
- post_body = nil
448
- auth_names = ['api_token_basic']
449
- data, status_code, headers = @api_client.call_api(:POST, local_var_path,
610
+ post_body = opts[:debug_body]
611
+
612
+ # return_type
613
+ return_type = opts[:debug_return_type] || 'CreateSubmissionDataRequestTokenResponse'
614
+
615
+ # auth_names
616
+ auth_names = opts[:debug_auth_names] || ['api_token_basic']
617
+
618
+ new_options = opts.merge(
619
+ :operation => :"PDFApi.create_data_request_token",
450
620
  :header_params => header_params,
451
621
  :query_params => query_params,
452
622
  :form_params => form_params,
453
623
  :body => post_body,
454
624
  :auth_names => auth_names,
455
- :return_type => 'CreateSubmissionDataRequestTokenResponse')
625
+ :return_type => return_type
626
+ )
627
+
628
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
456
629
  if @api_client.config.debugging
457
630
  @api_client.config.logger.debug "API called: PDFApi#create_data_request_token\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
458
631
  end
@@ -460,52 +633,65 @@ module DocSpring
460
633
  end
461
634
 
462
635
  # Create a folder
463
- # @param create_folder_data
636
+ # @param data [CreateFolderData]
464
637
  # @param [Hash] opts the optional parameters
465
638
  # @return [Folder]
466
- def create_folder(create_folder_data, opts = {})
467
- data, _status_code, _headers = create_folder_with_http_info(create_folder_data, opts)
639
+ def create_folder(data, opts = {})
640
+ data, _status_code, _headers = create_folder_with_http_info(data, opts)
468
641
  data
469
642
  end
470
643
 
471
644
  # Create a folder
472
- # @param create_folder_data
645
+ # @param data [CreateFolderData]
473
646
  # @param [Hash] opts the optional parameters
474
- # @return [Array<(Folder, Fixnum, Hash)>] Folder data, response status code and response headers
475
- def create_folder_with_http_info(create_folder_data, opts = {})
647
+ # @return [Array<(Folder, Integer, Hash)>] Folder data, response status code and response headers
648
+ def create_folder_with_http_info(data, opts = {})
476
649
  if @api_client.config.debugging
477
650
  @api_client.config.logger.debug 'Calling API: PDFApi.create_folder ...'
478
651
  end
479
- # verify the required parameter 'create_folder_data' is set
480
- if @api_client.config.client_side_validation && create_folder_data.nil?
481
- fail ArgumentError, "Missing the required parameter 'create_folder_data' when calling PDFApi.create_folder"
652
+ # verify the required parameter 'data' is set
653
+ if @api_client.config.client_side_validation && data.nil?
654
+ fail ArgumentError, "Missing the required parameter 'data' when calling PDFApi.create_folder"
482
655
  end
483
656
  # resource path
484
657
  local_var_path = '/folders/'
485
658
 
486
659
  # query parameters
487
- query_params = {}
660
+ query_params = opts[:query_params] || {}
488
661
 
489
662
  # header parameters
490
- header_params = {}
663
+ header_params = opts[:header_params] || {}
491
664
  # HTTP header 'Accept' (if needed)
492
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
665
+ header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
493
666
  # HTTP header 'Content-Type'
494
- header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
667
+ content_type = @api_client.select_header_content_type(['application/json'])
668
+ if !content_type.nil?
669
+ header_params['Content-Type'] = content_type
670
+ end
495
671
 
496
672
  # form parameters
497
- form_params = {}
673
+ form_params = opts[:form_params] || {}
498
674
 
499
675
  # http body (model)
500
- post_body = @api_client.object_to_http_body(create_folder_data)
501
- auth_names = ['api_token_basic']
502
- data, status_code, headers = @api_client.call_api(:POST, local_var_path,
676
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(data)
677
+
678
+ # return_type
679
+ return_type = opts[:debug_return_type] || 'Folder'
680
+
681
+ # auth_names
682
+ auth_names = opts[:debug_auth_names] || ['api_token_basic']
683
+
684
+ new_options = opts.merge(
685
+ :operation => :"PDFApi.create_folder",
503
686
  :header_params => header_params,
504
687
  :query_params => query_params,
505
688
  :form_params => form_params,
506
689
  :body => post_body,
507
690
  :auth_names => auth_names,
508
- :return_type => 'Folder')
691
+ :return_type => return_type
692
+ )
693
+
694
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
509
695
  if @api_client.config.debugging
510
696
  @api_client.config.logger.debug "API called: PDFApi#create_folder\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
511
697
  end
@@ -513,52 +699,65 @@ module DocSpring
513
699
  end
514
700
 
515
701
  # Create a new HTML template
516
- # @param create_html_template_data
702
+ # @param data [CreateHtmlTemplateData]
517
703
  # @param [Hash] opts the optional parameters
518
704
  # @return [PendingTemplate]
519
- def create_html_template(create_html_template_data, opts = {})
520
- data, _status_code, _headers = create_html_template_with_http_info(create_html_template_data, opts)
705
+ def create_html_template(data, opts = {})
706
+ data, _status_code, _headers = create_html_template_with_http_info(data, opts)
521
707
  data
522
708
  end
523
709
 
524
710
  # Create a new HTML template
525
- # @param create_html_template_data
711
+ # @param data [CreateHtmlTemplateData]
526
712
  # @param [Hash] opts the optional parameters
527
- # @return [Array<(PendingTemplate, Fixnum, Hash)>] PendingTemplate data, response status code and response headers
528
- def create_html_template_with_http_info(create_html_template_data, opts = {})
713
+ # @return [Array<(PendingTemplate, Integer, Hash)>] PendingTemplate data, response status code and response headers
714
+ def create_html_template_with_http_info(data, opts = {})
529
715
  if @api_client.config.debugging
530
716
  @api_client.config.logger.debug 'Calling API: PDFApi.create_html_template ...'
531
717
  end
532
- # verify the required parameter 'create_html_template_data' is set
533
- if @api_client.config.client_side_validation && create_html_template_data.nil?
534
- fail ArgumentError, "Missing the required parameter 'create_html_template_data' when calling PDFApi.create_html_template"
718
+ # verify the required parameter 'data' is set
719
+ if @api_client.config.client_side_validation && data.nil?
720
+ fail ArgumentError, "Missing the required parameter 'data' when calling PDFApi.create_html_template"
535
721
  end
536
722
  # resource path
537
723
  local_var_path = '/templates?desc=html'
538
724
 
539
725
  # query parameters
540
- query_params = {}
726
+ query_params = opts[:query_params] || {}
541
727
 
542
728
  # header parameters
543
- header_params = {}
729
+ header_params = opts[:header_params] || {}
544
730
  # HTTP header 'Accept' (if needed)
545
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
731
+ header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
546
732
  # HTTP header 'Content-Type'
547
- header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
733
+ content_type = @api_client.select_header_content_type(['application/json'])
734
+ if !content_type.nil?
735
+ header_params['Content-Type'] = content_type
736
+ end
548
737
 
549
738
  # form parameters
550
- form_params = {}
739
+ form_params = opts[:form_params] || {}
551
740
 
552
741
  # http body (model)
553
- post_body = @api_client.object_to_http_body(create_html_template_data)
554
- auth_names = ['api_token_basic']
555
- data, status_code, headers = @api_client.call_api(:POST, local_var_path,
742
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(data)
743
+
744
+ # return_type
745
+ return_type = opts[:debug_return_type] || 'PendingTemplate'
746
+
747
+ # auth_names
748
+ auth_names = opts[:debug_auth_names] || ['api_token_basic']
749
+
750
+ new_options = opts.merge(
751
+ :operation => :"PDFApi.create_html_template",
556
752
  :header_params => header_params,
557
753
  :query_params => query_params,
558
754
  :form_params => form_params,
559
755
  :body => post_body,
560
756
  :auth_names => auth_names,
561
- :return_type => 'PendingTemplate')
757
+ :return_type => return_type
758
+ )
759
+
760
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
562
761
  if @api_client.config.debugging
563
762
  @api_client.config.logger.debug "API called: PDFApi#create_html_template\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
564
763
  end
@@ -566,8 +765,8 @@ module DocSpring
566
765
  end
567
766
 
568
767
  # Create a new PDF template with a form POST file upload
569
- # @param template_document
570
- # @param template_name
768
+ # @param template_document [File]
769
+ # @param template_name [String]
571
770
  # @param [Hash] opts the optional parameters
572
771
  # @option opts [String] :template_parent_folder_id
573
772
  # @return [PendingTemplate]
@@ -577,11 +776,11 @@ module DocSpring
577
776
  end
578
777
 
579
778
  # Create a new PDF template with a form POST file upload
580
- # @param template_document
581
- # @param template_name
779
+ # @param template_document [File]
780
+ # @param template_name [String]
582
781
  # @param [Hash] opts the optional parameters
583
782
  # @option opts [String] :template_parent_folder_id
584
- # @return [Array<(PendingTemplate, Fixnum, Hash)>] PendingTemplate data, response status code and response headers
783
+ # @return [Array<(PendingTemplate, Integer, Hash)>] PendingTemplate data, response status code and response headers
585
784
  def create_pdf_template_with_http_info(template_document, template_name, opts = {})
586
785
  if @api_client.config.debugging
587
786
  @api_client.config.logger.debug 'Calling API: PDFApi.create_pdf_template ...'
@@ -598,31 +797,44 @@ module DocSpring
598
797
  local_var_path = '/templates'
599
798
 
600
799
  # query parameters
601
- query_params = {}
800
+ query_params = opts[:query_params] || {}
602
801
 
603
802
  # header parameters
604
- header_params = {}
803
+ header_params = opts[:header_params] || {}
605
804
  # HTTP header 'Accept' (if needed)
606
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
805
+ header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
607
806
  # HTTP header 'Content-Type'
608
- header_params['Content-Type'] = @api_client.select_header_content_type(['multipart/form-data'])
807
+ content_type = @api_client.select_header_content_type(['multipart/form-data'])
808
+ if !content_type.nil?
809
+ header_params['Content-Type'] = content_type
810
+ end
609
811
 
610
812
  # form parameters
611
- form_params = {}
813
+ form_params = opts[:form_params] || {}
612
814
  form_params['template[document]'] = template_document
613
815
  form_params['template[name]'] = template_name
614
816
  form_params['template[parent_folder_id]'] = opts[:'template_parent_folder_id'] if !opts[:'template_parent_folder_id'].nil?
615
817
 
616
818
  # http body (model)
617
- post_body = nil
618
- auth_names = ['api_token_basic']
619
- data, status_code, headers = @api_client.call_api(:POST, local_var_path,
819
+ post_body = opts[:debug_body]
820
+
821
+ # return_type
822
+ return_type = opts[:debug_return_type] || 'PendingTemplate'
823
+
824
+ # auth_names
825
+ auth_names = opts[:debug_auth_names] || ['api_token_basic']
826
+
827
+ new_options = opts.merge(
828
+ :operation => :"PDFApi.create_pdf_template",
620
829
  :header_params => header_params,
621
830
  :query_params => query_params,
622
831
  :form_params => form_params,
623
832
  :body => post_body,
624
833
  :auth_names => auth_names,
625
- :return_type => 'PendingTemplate')
834
+ :return_type => return_type
835
+ )
836
+
837
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
626
838
  if @api_client.config.debugging
627
839
  @api_client.config.logger.debug "API called: PDFApi#create_pdf_template\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
628
840
  end
@@ -630,52 +842,65 @@ module DocSpring
630
842
  end
631
843
 
632
844
  # Create a new PDF template from a cached presign upload
633
- # @param create_template_from_upload_data
845
+ # @param data [CreateTemplateFromUploadData]
634
846
  # @param [Hash] opts the optional parameters
635
847
  # @return [PendingTemplate]
636
- def create_pdf_template_from_upload(create_template_from_upload_data, opts = {})
637
- data, _status_code, _headers = create_pdf_template_from_upload_with_http_info(create_template_from_upload_data, opts)
848
+ def create_pdf_template_from_upload(data, opts = {})
849
+ data, _status_code, _headers = create_pdf_template_from_upload_with_http_info(data, opts)
638
850
  data
639
851
  end
640
852
 
641
853
  # Create a new PDF template from a cached presign upload
642
- # @param create_template_from_upload_data
854
+ # @param data [CreateTemplateFromUploadData]
643
855
  # @param [Hash] opts the optional parameters
644
- # @return [Array<(PendingTemplate, Fixnum, Hash)>] PendingTemplate data, response status code and response headers
645
- def create_pdf_template_from_upload_with_http_info(create_template_from_upload_data, opts = {})
856
+ # @return [Array<(PendingTemplate, Integer, Hash)>] PendingTemplate data, response status code and response headers
857
+ def create_pdf_template_from_upload_with_http_info(data, opts = {})
646
858
  if @api_client.config.debugging
647
859
  @api_client.config.logger.debug 'Calling API: PDFApi.create_pdf_template_from_upload ...'
648
860
  end
649
- # verify the required parameter 'create_template_from_upload_data' is set
650
- if @api_client.config.client_side_validation && create_template_from_upload_data.nil?
651
- fail ArgumentError, "Missing the required parameter 'create_template_from_upload_data' when calling PDFApi.create_pdf_template_from_upload"
861
+ # verify the required parameter 'data' is set
862
+ if @api_client.config.client_side_validation && data.nil?
863
+ fail ArgumentError, "Missing the required parameter 'data' when calling PDFApi.create_pdf_template_from_upload"
652
864
  end
653
865
  # resource path
654
866
  local_var_path = '/templates?desc=cached_upload'
655
867
 
656
868
  # query parameters
657
- query_params = {}
869
+ query_params = opts[:query_params] || {}
658
870
 
659
871
  # header parameters
660
- header_params = {}
872
+ header_params = opts[:header_params] || {}
661
873
  # HTTP header 'Accept' (if needed)
662
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
874
+ header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
663
875
  # HTTP header 'Content-Type'
664
- header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
876
+ content_type = @api_client.select_header_content_type(['application/json'])
877
+ if !content_type.nil?
878
+ header_params['Content-Type'] = content_type
879
+ end
665
880
 
666
881
  # form parameters
667
- form_params = {}
882
+ form_params = opts[:form_params] || {}
668
883
 
669
884
  # http body (model)
670
- post_body = @api_client.object_to_http_body(create_template_from_upload_data)
671
- auth_names = ['api_token_basic']
672
- data, status_code, headers = @api_client.call_api(:POST, local_var_path,
885
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(data)
886
+
887
+ # return_type
888
+ return_type = opts[:debug_return_type] || 'PendingTemplate'
889
+
890
+ # auth_names
891
+ auth_names = opts[:debug_auth_names] || ['api_token_basic']
892
+
893
+ new_options = opts.merge(
894
+ :operation => :"PDFApi.create_pdf_template_from_upload",
673
895
  :header_params => header_params,
674
896
  :query_params => query_params,
675
897
  :form_params => form_params,
676
898
  :body => post_body,
677
899
  :auth_names => auth_names,
678
- :return_type => 'PendingTemplate')
900
+ :return_type => return_type
901
+ )
902
+
903
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
679
904
  if @api_client.config.debugging
680
905
  @api_client.config.logger.debug "API called: PDFApi#create_pdf_template_from_upload\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
681
906
  end
@@ -683,7 +908,7 @@ module DocSpring
683
908
  end
684
909
 
685
910
  # Delete a folder
686
- # @param folder_id
911
+ # @param folder_id [String]
687
912
  # @param [Hash] opts the optional parameters
688
913
  # @return [Folder]
689
914
  def delete_folder(folder_id, opts = {})
@@ -692,9 +917,9 @@ module DocSpring
692
917
  end
693
918
 
694
919
  # Delete a folder
695
- # @param folder_id
920
+ # @param folder_id [String]
696
921
  # @param [Hash] opts the optional parameters
697
- # @return [Array<(Folder, Fixnum, Hash)>] Folder data, response status code and response headers
922
+ # @return [Array<(Folder, Integer, Hash)>] Folder data, response status code and response headers
698
923
  def delete_folder_with_http_info(folder_id, opts = {})
699
924
  if @api_client.config.debugging
700
925
  @api_client.config.logger.debug 'Calling API: PDFApi.delete_folder ...'
@@ -704,37 +929,111 @@ module DocSpring
704
929
  fail ArgumentError, "Missing the required parameter 'folder_id' when calling PDFApi.delete_folder"
705
930
  end
706
931
  # resource path
707
- local_var_path = '/folders/{folder_id}'.sub('{' + 'folder_id' + '}', folder_id.to_s)
932
+ local_var_path = '/folders/{folder_id}'.sub('{' + 'folder_id' + '}', CGI.escape(folder_id.to_s))
708
933
 
709
934
  # query parameters
710
- query_params = {}
935
+ query_params = opts[:query_params] || {}
711
936
 
712
937
  # header parameters
713
- header_params = {}
938
+ header_params = opts[:header_params] || {}
714
939
  # HTTP header 'Accept' (if needed)
715
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
940
+ header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
716
941
 
717
942
  # form parameters
718
- form_params = {}
943
+ form_params = opts[:form_params] || {}
719
944
 
720
945
  # http body (model)
721
- post_body = nil
722
- auth_names = ['api_token_basic']
723
- data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
946
+ post_body = opts[:debug_body]
947
+
948
+ # return_type
949
+ return_type = opts[:debug_return_type] || 'Folder'
950
+
951
+ # auth_names
952
+ auth_names = opts[:debug_auth_names] || ['api_token_basic']
953
+
954
+ new_options = opts.merge(
955
+ :operation => :"PDFApi.delete_folder",
724
956
  :header_params => header_params,
725
957
  :query_params => query_params,
726
958
  :form_params => form_params,
727
959
  :body => post_body,
728
960
  :auth_names => auth_names,
729
- :return_type => 'Folder')
961
+ :return_type => return_type
962
+ )
963
+
964
+ data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options)
730
965
  if @api_client.config.debugging
731
966
  @api_client.config.logger.debug "API called: PDFApi#delete_folder\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
732
967
  end
733
968
  return data, status_code, headers
734
969
  end
735
970
 
971
+ # Delete a template
972
+ # @param template_id [String]
973
+ # @param [Hash] opts the optional parameters
974
+ # @option opts [String] :version
975
+ # @return [DeleteTemplateResponse]
976
+ def delete_template(template_id, opts = {})
977
+ data, _status_code, _headers = delete_template_with_http_info(template_id, opts)
978
+ data
979
+ end
980
+
981
+ # Delete a template
982
+ # @param template_id [String]
983
+ # @param [Hash] opts the optional parameters
984
+ # @option opts [String] :version
985
+ # @return [Array<(DeleteTemplateResponse, Integer, Hash)>] DeleteTemplateResponse data, response status code and response headers
986
+ def delete_template_with_http_info(template_id, opts = {})
987
+ if @api_client.config.debugging
988
+ @api_client.config.logger.debug 'Calling API: PDFApi.delete_template ...'
989
+ end
990
+ # verify the required parameter 'template_id' is set
991
+ if @api_client.config.client_side_validation && template_id.nil?
992
+ fail ArgumentError, "Missing the required parameter 'template_id' when calling PDFApi.delete_template"
993
+ end
994
+ # resource path
995
+ local_var_path = '/templates/{template_id}'.sub('{' + 'template_id' + '}', CGI.escape(template_id.to_s))
996
+
997
+ # query parameters
998
+ query_params = opts[:query_params] || {}
999
+ query_params[:'version'] = opts[:'version'] if !opts[:'version'].nil?
1000
+
1001
+ # header parameters
1002
+ header_params = opts[:header_params] || {}
1003
+ # HTTP header 'Accept' (if needed)
1004
+ header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
1005
+
1006
+ # form parameters
1007
+ form_params = opts[:form_params] || {}
1008
+
1009
+ # http body (model)
1010
+ post_body = opts[:debug_body]
1011
+
1012
+ # return_type
1013
+ return_type = opts[:debug_return_type] || 'DeleteTemplateResponse'
1014
+
1015
+ # auth_names
1016
+ auth_names = opts[:debug_auth_names] || ['api_token_basic']
1017
+
1018
+ new_options = opts.merge(
1019
+ :operation => :"PDFApi.delete_template",
1020
+ :header_params => header_params,
1021
+ :query_params => query_params,
1022
+ :form_params => form_params,
1023
+ :body => post_body,
1024
+ :auth_names => auth_names,
1025
+ :return_type => return_type
1026
+ )
1027
+
1028
+ data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options)
1029
+ if @api_client.config.debugging
1030
+ @api_client.config.logger.debug "API called: PDFApi#delete_template\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1031
+ end
1032
+ return data, status_code, headers
1033
+ end
1034
+
736
1035
  # Expire a combined submission
737
- # @param combined_submission_id
1036
+ # @param combined_submission_id [String]
738
1037
  # @param [Hash] opts the optional parameters
739
1038
  # @return [CombinedSubmission]
740
1039
  def expire_combined_submission(combined_submission_id, opts = {})
@@ -743,9 +1042,9 @@ module DocSpring
743
1042
  end
744
1043
 
745
1044
  # Expire a combined submission
746
- # @param combined_submission_id
1045
+ # @param combined_submission_id [String]
747
1046
  # @param [Hash] opts the optional parameters
748
- # @return [Array<(CombinedSubmission, Fixnum, Hash)>] CombinedSubmission data, response status code and response headers
1047
+ # @return [Array<(CombinedSubmission, Integer, Hash)>] CombinedSubmission data, response status code and response headers
749
1048
  def expire_combined_submission_with_http_info(combined_submission_id, opts = {})
750
1049
  if @api_client.config.debugging
751
1050
  @api_client.config.logger.debug 'Calling API: PDFApi.expire_combined_submission ...'
@@ -755,29 +1054,39 @@ module DocSpring
755
1054
  fail ArgumentError, "Missing the required parameter 'combined_submission_id' when calling PDFApi.expire_combined_submission"
756
1055
  end
757
1056
  # resource path
758
- local_var_path = '/combined_submissions/{combined_submission_id}'.sub('{' + 'combined_submission_id' + '}', combined_submission_id.to_s)
1057
+ local_var_path = '/combined_submissions/{combined_submission_id}'.sub('{' + 'combined_submission_id' + '}', CGI.escape(combined_submission_id.to_s))
759
1058
 
760
1059
  # query parameters
761
- query_params = {}
1060
+ query_params = opts[:query_params] || {}
762
1061
 
763
1062
  # header parameters
764
- header_params = {}
1063
+ header_params = opts[:header_params] || {}
765
1064
  # HTTP header 'Accept' (if needed)
766
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
1065
+ header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
767
1066
 
768
1067
  # form parameters
769
- form_params = {}
1068
+ form_params = opts[:form_params] || {}
770
1069
 
771
1070
  # http body (model)
772
- post_body = nil
773
- auth_names = ['api_token_basic']
774
- data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
1071
+ post_body = opts[:debug_body]
1072
+
1073
+ # return_type
1074
+ return_type = opts[:debug_return_type] || 'CombinedSubmission'
1075
+
1076
+ # auth_names
1077
+ auth_names = opts[:debug_auth_names] || ['api_token_basic']
1078
+
1079
+ new_options = opts.merge(
1080
+ :operation => :"PDFApi.expire_combined_submission",
775
1081
  :header_params => header_params,
776
1082
  :query_params => query_params,
777
1083
  :form_params => form_params,
778
1084
  :body => post_body,
779
1085
  :auth_names => auth_names,
780
- :return_type => 'CombinedSubmission')
1086
+ :return_type => return_type
1087
+ )
1088
+
1089
+ data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options)
781
1090
  if @api_client.config.debugging
782
1091
  @api_client.config.logger.debug "API called: PDFApi#expire_combined_submission\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
783
1092
  end
@@ -785,7 +1094,7 @@ module DocSpring
785
1094
  end
786
1095
 
787
1096
  # Expire a PDF submission
788
- # @param submission_id
1097
+ # @param submission_id [String]
789
1098
  # @param [Hash] opts the optional parameters
790
1099
  # @return [Submission]
791
1100
  def expire_submission(submission_id, opts = {})
@@ -794,9 +1103,9 @@ module DocSpring
794
1103
  end
795
1104
 
796
1105
  # Expire a PDF submission
797
- # @param submission_id
1106
+ # @param submission_id [String]
798
1107
  # @param [Hash] opts the optional parameters
799
- # @return [Array<(Submission, Fixnum, Hash)>] Submission data, response status code and response headers
1108
+ # @return [Array<(Submission, Integer, Hash)>] Submission data, response status code and response headers
800
1109
  def expire_submission_with_http_info(submission_id, opts = {})
801
1110
  if @api_client.config.debugging
802
1111
  @api_client.config.logger.debug 'Calling API: PDFApi.expire_submission ...'
@@ -806,29 +1115,39 @@ module DocSpring
806
1115
  fail ArgumentError, "Missing the required parameter 'submission_id' when calling PDFApi.expire_submission"
807
1116
  end
808
1117
  # resource path
809
- local_var_path = '/submissions/{submission_id}'.sub('{' + 'submission_id' + '}', submission_id.to_s)
1118
+ local_var_path = '/submissions/{submission_id}'.sub('{' + 'submission_id' + '}', CGI.escape(submission_id.to_s))
810
1119
 
811
1120
  # query parameters
812
- query_params = {}
1121
+ query_params = opts[:query_params] || {}
813
1122
 
814
1123
  # header parameters
815
- header_params = {}
1124
+ header_params = opts[:header_params] || {}
816
1125
  # HTTP header 'Accept' (if needed)
817
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
1126
+ header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
818
1127
 
819
1128
  # form parameters
820
- form_params = {}
1129
+ form_params = opts[:form_params] || {}
821
1130
 
822
1131
  # http body (model)
823
- post_body = nil
824
- auth_names = ['api_token_basic']
825
- data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
1132
+ post_body = opts[:debug_body]
1133
+
1134
+ # return_type
1135
+ return_type = opts[:debug_return_type] || 'Submission'
1136
+
1137
+ # auth_names
1138
+ auth_names = opts[:debug_auth_names] || ['api_token_basic']
1139
+
1140
+ new_options = opts.merge(
1141
+ :operation => :"PDFApi.expire_submission",
826
1142
  :header_params => header_params,
827
1143
  :query_params => query_params,
828
1144
  :form_params => form_params,
829
1145
  :body => post_body,
830
1146
  :auth_names => auth_names,
831
- :return_type => 'Submission')
1147
+ :return_type => return_type
1148
+ )
1149
+
1150
+ data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options)
832
1151
  if @api_client.config.debugging
833
1152
  @api_client.config.logger.debug "API called: PDFApi#expire_submission\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
834
1153
  end
@@ -836,21 +1155,21 @@ module DocSpring
836
1155
  end
837
1156
 
838
1157
  # Generates a new PDF
839
- # @param template_id
840
- # @param submission_data
1158
+ # @param template_id [String]
1159
+ # @param submission [CreateSubmissionData]
841
1160
  # @param [Hash] opts the optional parameters
842
1161
  # @return [CreateSubmissionResponse]
843
- def generate_pdf(template_id, submission_data, opts = {})
844
- data, _status_code, _headers = generate_pdf_with_http_info(template_id, submission_data, opts)
1162
+ def generate_pdf(template_id, submission, opts = {})
1163
+ data, _status_code, _headers = generate_pdf_with_http_info(template_id, submission, opts)
845
1164
  data
846
1165
  end
847
1166
 
848
1167
  # Generates a new PDF
849
- # @param template_id
850
- # @param submission_data
1168
+ # @param template_id [String]
1169
+ # @param submission [CreateSubmissionData]
851
1170
  # @param [Hash] opts the optional parameters
852
- # @return [Array<(CreateSubmissionResponse, Fixnum, Hash)>] CreateSubmissionResponse data, response status code and response headers
853
- def generate_pdf_with_http_info(template_id, submission_data, opts = {})
1171
+ # @return [Array<(CreateSubmissionResponse, Integer, Hash)>] CreateSubmissionResponse data, response status code and response headers
1172
+ def generate_pdf_with_http_info(template_id, submission, opts = {})
854
1173
  if @api_client.config.debugging
855
1174
  @api_client.config.logger.debug 'Calling API: PDFApi.generate_pdf ...'
856
1175
  end
@@ -858,44 +1177,118 @@ module DocSpring
858
1177
  if @api_client.config.client_side_validation && template_id.nil?
859
1178
  fail ArgumentError, "Missing the required parameter 'template_id' when calling PDFApi.generate_pdf"
860
1179
  end
861
- # verify the required parameter 'submission_data' is set
862
- if @api_client.config.client_side_validation && submission_data.nil?
863
- fail ArgumentError, "Missing the required parameter 'submission_data' when calling PDFApi.generate_pdf"
1180
+ # verify the required parameter 'submission' is set
1181
+ if @api_client.config.client_side_validation && submission.nil?
1182
+ fail ArgumentError, "Missing the required parameter 'submission' when calling PDFApi.generate_pdf"
864
1183
  end
865
1184
  # resource path
866
- local_var_path = '/templates/{template_id}/submissions'.sub('{' + 'template_id' + '}', template_id.to_s)
1185
+ local_var_path = '/templates/{template_id}/submissions'.sub('{' + 'template_id' + '}', CGI.escape(template_id.to_s))
867
1186
 
868
1187
  # query parameters
869
- query_params = {}
1188
+ query_params = opts[:query_params] || {}
870
1189
 
871
1190
  # header parameters
872
- header_params = {}
1191
+ header_params = opts[:header_params] || {}
873
1192
  # HTTP header 'Accept' (if needed)
874
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
1193
+ header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
875
1194
  # HTTP header 'Content-Type'
876
- header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
1195
+ content_type = @api_client.select_header_content_type(['application/json'])
1196
+ if !content_type.nil?
1197
+ header_params['Content-Type'] = content_type
1198
+ end
877
1199
 
878
1200
  # form parameters
879
- form_params = {}
1201
+ form_params = opts[:form_params] || {}
880
1202
 
881
1203
  # http body (model)
882
- post_body = @api_client.object_to_http_body(submission_data)
883
- auth_names = ['api_token_basic']
884
- data, status_code, headers = @api_client.call_api(:POST, local_var_path,
1204
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(submission)
1205
+
1206
+ # return_type
1207
+ return_type = opts[:debug_return_type] || 'CreateSubmissionResponse'
1208
+
1209
+ # auth_names
1210
+ auth_names = opts[:debug_auth_names] || ['api_token_basic']
1211
+
1212
+ new_options = opts.merge(
1213
+ :operation => :"PDFApi.generate_pdf",
885
1214
  :header_params => header_params,
886
1215
  :query_params => query_params,
887
1216
  :form_params => form_params,
888
1217
  :body => post_body,
889
1218
  :auth_names => auth_names,
890
- :return_type => 'CreateSubmissionResponse')
1219
+ :return_type => return_type
1220
+ )
1221
+
1222
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
891
1223
  if @api_client.config.debugging
892
1224
  @api_client.config.logger.debug "API called: PDFApi#generate_pdf\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
893
1225
  end
894
1226
  return data, status_code, headers
895
1227
  end
896
1228
 
1229
+ # Generated a preview PDF for partially completed data requests
1230
+ # @param submission_id [String]
1231
+ # @param [Hash] opts the optional parameters
1232
+ # @return [PreviewPdfResponse]
1233
+ def generate_preview(submission_id, opts = {})
1234
+ data, _status_code, _headers = generate_preview_with_http_info(submission_id, opts)
1235
+ data
1236
+ end
1237
+
1238
+ # Generated a preview PDF for partially completed data requests
1239
+ # @param submission_id [String]
1240
+ # @param [Hash] opts the optional parameters
1241
+ # @return [Array<(PreviewPdfResponse, Integer, Hash)>] PreviewPdfResponse data, response status code and response headers
1242
+ def generate_preview_with_http_info(submission_id, opts = {})
1243
+ if @api_client.config.debugging
1244
+ @api_client.config.logger.debug 'Calling API: PDFApi.generate_preview ...'
1245
+ end
1246
+ # verify the required parameter 'submission_id' is set
1247
+ if @api_client.config.client_side_validation && submission_id.nil?
1248
+ fail ArgumentError, "Missing the required parameter 'submission_id' when calling PDFApi.generate_preview"
1249
+ end
1250
+ # resource path
1251
+ local_var_path = '/submissions/{submission_id}/generate_preview'.sub('{' + 'submission_id' + '}', CGI.escape(submission_id.to_s))
1252
+
1253
+ # query parameters
1254
+ query_params = opts[:query_params] || {}
1255
+
1256
+ # header parameters
1257
+ header_params = opts[:header_params] || {}
1258
+ # HTTP header 'Accept' (if needed)
1259
+ header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
1260
+
1261
+ # form parameters
1262
+ form_params = opts[:form_params] || {}
1263
+
1264
+ # http body (model)
1265
+ post_body = opts[:debug_body]
1266
+
1267
+ # return_type
1268
+ return_type = opts[:debug_return_type] || 'PreviewPdfResponse'
1269
+
1270
+ # auth_names
1271
+ auth_names = opts[:debug_auth_names] || ['api_token_basic']
1272
+
1273
+ new_options = opts.merge(
1274
+ :operation => :"PDFApi.generate_preview",
1275
+ :header_params => header_params,
1276
+ :query_params => query_params,
1277
+ :form_params => form_params,
1278
+ :body => post_body,
1279
+ :auth_names => auth_names,
1280
+ :return_type => return_type
1281
+ )
1282
+
1283
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
1284
+ if @api_client.config.debugging
1285
+ @api_client.config.logger.debug "API called: PDFApi#generate_preview\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1286
+ end
1287
+ return data, status_code, headers
1288
+ end
1289
+
897
1290
  # Check the status of a combined submission (merged PDFs)
898
- # @param combined_submission_id
1291
+ # @param combined_submission_id [String]
899
1292
  # @param [Hash] opts the optional parameters
900
1293
  # @return [CombinedSubmission]
901
1294
  def get_combined_submission(combined_submission_id, opts = {})
@@ -904,9 +1297,9 @@ module DocSpring
904
1297
  end
905
1298
 
906
1299
  # Check the status of a combined submission (merged PDFs)
907
- # @param combined_submission_id
1300
+ # @param combined_submission_id [String]
908
1301
  # @param [Hash] opts the optional parameters
909
- # @return [Array<(CombinedSubmission, Fixnum, Hash)>] CombinedSubmission data, response status code and response headers
1302
+ # @return [Array<(CombinedSubmission, Integer, Hash)>] CombinedSubmission data, response status code and response headers
910
1303
  def get_combined_submission_with_http_info(combined_submission_id, opts = {})
911
1304
  if @api_client.config.debugging
912
1305
  @api_client.config.logger.debug 'Calling API: PDFApi.get_combined_submission ...'
@@ -916,29 +1309,39 @@ module DocSpring
916
1309
  fail ArgumentError, "Missing the required parameter 'combined_submission_id' when calling PDFApi.get_combined_submission"
917
1310
  end
918
1311
  # resource path
919
- local_var_path = '/combined_submissions/{combined_submission_id}'.sub('{' + 'combined_submission_id' + '}', combined_submission_id.to_s)
1312
+ local_var_path = '/combined_submissions/{combined_submission_id}'.sub('{' + 'combined_submission_id' + '}', CGI.escape(combined_submission_id.to_s))
920
1313
 
921
1314
  # query parameters
922
- query_params = {}
1315
+ query_params = opts[:query_params] || {}
923
1316
 
924
1317
  # header parameters
925
- header_params = {}
1318
+ header_params = opts[:header_params] || {}
926
1319
  # HTTP header 'Accept' (if needed)
927
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
1320
+ header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
928
1321
 
929
1322
  # form parameters
930
- form_params = {}
1323
+ form_params = opts[:form_params] || {}
931
1324
 
932
1325
  # http body (model)
933
- post_body = nil
934
- auth_names = ['api_token_basic']
935
- data, status_code, headers = @api_client.call_api(:GET, local_var_path,
1326
+ post_body = opts[:debug_body]
1327
+
1328
+ # return_type
1329
+ return_type = opts[:debug_return_type] || 'CombinedSubmission'
1330
+
1331
+ # auth_names
1332
+ auth_names = opts[:debug_auth_names] || ['api_token_basic']
1333
+
1334
+ new_options = opts.merge(
1335
+ :operation => :"PDFApi.get_combined_submission",
936
1336
  :header_params => header_params,
937
1337
  :query_params => query_params,
938
1338
  :form_params => form_params,
939
1339
  :body => post_body,
940
1340
  :auth_names => auth_names,
941
- :return_type => 'CombinedSubmission')
1341
+ :return_type => return_type
1342
+ )
1343
+
1344
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
942
1345
  if @api_client.config.debugging
943
1346
  @api_client.config.logger.debug "API called: PDFApi#get_combined_submission\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
944
1347
  end
@@ -946,7 +1349,7 @@ module DocSpring
946
1349
  end
947
1350
 
948
1351
  # Look up a submission data request
949
- # @param data_request_id
1352
+ # @param data_request_id [String]
950
1353
  # @param [Hash] opts the optional parameters
951
1354
  # @return [SubmissionDataRequest]
952
1355
  def get_data_request(data_request_id, opts = {})
@@ -955,9 +1358,9 @@ module DocSpring
955
1358
  end
956
1359
 
957
1360
  # Look up a submission data request
958
- # @param data_request_id
1361
+ # @param data_request_id [String]
959
1362
  # @param [Hash] opts the optional parameters
960
- # @return [Array<(SubmissionDataRequest, Fixnum, Hash)>] SubmissionDataRequest data, response status code and response headers
1363
+ # @return [Array<(SubmissionDataRequest, Integer, Hash)>] SubmissionDataRequest data, response status code and response headers
961
1364
  def get_data_request_with_http_info(data_request_id, opts = {})
962
1365
  if @api_client.config.debugging
963
1366
  @api_client.config.logger.debug 'Calling API: PDFApi.get_data_request ...'
@@ -967,38 +1370,109 @@ module DocSpring
967
1370
  fail ArgumentError, "Missing the required parameter 'data_request_id' when calling PDFApi.get_data_request"
968
1371
  end
969
1372
  # resource path
970
- local_var_path = '/data_requests/{data_request_id}'.sub('{' + 'data_request_id' + '}', data_request_id.to_s)
1373
+ local_var_path = '/data_requests/{data_request_id}'.sub('{' + 'data_request_id' + '}', CGI.escape(data_request_id.to_s))
971
1374
 
972
1375
  # query parameters
973
- query_params = {}
1376
+ query_params = opts[:query_params] || {}
974
1377
 
975
1378
  # header parameters
976
- header_params = {}
1379
+ header_params = opts[:header_params] || {}
977
1380
  # HTTP header 'Accept' (if needed)
978
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
1381
+ header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
979
1382
 
980
1383
  # form parameters
981
- form_params = {}
1384
+ form_params = opts[:form_params] || {}
982
1385
 
983
1386
  # http body (model)
984
- post_body = nil
985
- auth_names = ['api_token_basic']
986
- data, status_code, headers = @api_client.call_api(:GET, local_var_path,
1387
+ post_body = opts[:debug_body]
1388
+
1389
+ # return_type
1390
+ return_type = opts[:debug_return_type] || 'SubmissionDataRequest'
1391
+
1392
+ # auth_names
1393
+ auth_names = opts[:debug_auth_names] || ['api_token_basic']
1394
+
1395
+ new_options = opts.merge(
1396
+ :operation => :"PDFApi.get_data_request",
987
1397
  :header_params => header_params,
988
1398
  :query_params => query_params,
989
1399
  :form_params => form_params,
990
1400
  :body => post_body,
991
1401
  :auth_names => auth_names,
992
- :return_type => 'SubmissionDataRequest')
1402
+ :return_type => return_type
1403
+ )
1404
+
1405
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
993
1406
  if @api_client.config.debugging
994
1407
  @api_client.config.logger.debug "API called: PDFApi#get_data_request\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
995
1408
  end
996
1409
  return data, status_code, headers
997
1410
  end
998
1411
 
1412
+ # Fetch the full template attributes
1413
+ # @param template_id [String]
1414
+ # @param [Hash] opts the optional parameters
1415
+ # @return [FullTemplate]
1416
+ def get_full_template(template_id, opts = {})
1417
+ data, _status_code, _headers = get_full_template_with_http_info(template_id, opts)
1418
+ data
1419
+ end
1420
+
1421
+ # Fetch the full template attributes
1422
+ # @param template_id [String]
1423
+ # @param [Hash] opts the optional parameters
1424
+ # @return [Array<(FullTemplate, Integer, Hash)>] FullTemplate data, response status code and response headers
1425
+ def get_full_template_with_http_info(template_id, opts = {})
1426
+ if @api_client.config.debugging
1427
+ @api_client.config.logger.debug 'Calling API: PDFApi.get_full_template ...'
1428
+ end
1429
+ # verify the required parameter 'template_id' is set
1430
+ if @api_client.config.client_side_validation && template_id.nil?
1431
+ fail ArgumentError, "Missing the required parameter 'template_id' when calling PDFApi.get_full_template"
1432
+ end
1433
+ # resource path
1434
+ local_var_path = '/templates/{template_id}?full=true'.sub('{' + 'template_id' + '}', CGI.escape(template_id.to_s))
1435
+
1436
+ # query parameters
1437
+ query_params = opts[:query_params] || {}
1438
+
1439
+ # header parameters
1440
+ header_params = opts[:header_params] || {}
1441
+ # HTTP header 'Accept' (if needed)
1442
+ header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
1443
+
1444
+ # form parameters
1445
+ form_params = opts[:form_params] || {}
1446
+
1447
+ # http body (model)
1448
+ post_body = opts[:debug_body]
1449
+
1450
+ # return_type
1451
+ return_type = opts[:debug_return_type] || 'FullTemplate'
1452
+
1453
+ # auth_names
1454
+ auth_names = opts[:debug_auth_names] || ['api_token_basic']
1455
+
1456
+ new_options = opts.merge(
1457
+ :operation => :"PDFApi.get_full_template",
1458
+ :header_params => header_params,
1459
+ :query_params => query_params,
1460
+ :form_params => form_params,
1461
+ :body => post_body,
1462
+ :auth_names => auth_names,
1463
+ :return_type => return_type
1464
+ )
1465
+
1466
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
1467
+ if @api_client.config.debugging
1468
+ @api_client.config.logger.debug "API called: PDFApi#get_full_template\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1469
+ end
1470
+ return data, status_code, headers
1471
+ end
1472
+
999
1473
  # Get a presigned URL so that you can upload a file to our AWS S3 bucket
1000
1474
  # @param [Hash] opts the optional parameters
1001
- # @return [Hash<String, Object>]
1475
+ # @return [UploadPresign]
1002
1476
  def get_presign_url(opts = {})
1003
1477
  data, _status_code, _headers = get_presign_url_with_http_info(opts)
1004
1478
  data
@@ -1006,7 +1480,7 @@ module DocSpring
1006
1480
 
1007
1481
  # Get a presigned URL so that you can upload a file to our AWS S3 bucket
1008
1482
  # @param [Hash] opts the optional parameters
1009
- # @return [Array<(Hash<String, Object>, Fixnum, Hash)>] Hash<String, Object> data, response status code and response headers
1483
+ # @return [Array<(UploadPresign, Integer, Hash)>] UploadPresign data, response status code and response headers
1010
1484
  def get_presign_url_with_http_info(opts = {})
1011
1485
  if @api_client.config.debugging
1012
1486
  @api_client.config.logger.debug 'Calling API: PDFApi.get_presign_url ...'
@@ -1015,26 +1489,36 @@ module DocSpring
1015
1489
  local_var_path = '/uploads/presign'
1016
1490
 
1017
1491
  # query parameters
1018
- query_params = {}
1492
+ query_params = opts[:query_params] || {}
1019
1493
 
1020
1494
  # header parameters
1021
- header_params = {}
1495
+ header_params = opts[:header_params] || {}
1022
1496
  # HTTP header 'Accept' (if needed)
1023
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
1497
+ header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
1024
1498
 
1025
1499
  # form parameters
1026
- form_params = {}
1500
+ form_params = opts[:form_params] || {}
1027
1501
 
1028
1502
  # http body (model)
1029
- post_body = nil
1030
- auth_names = ['api_token_basic']
1031
- data, status_code, headers = @api_client.call_api(:GET, local_var_path,
1503
+ post_body = opts[:debug_body]
1504
+
1505
+ # return_type
1506
+ return_type = opts[:debug_return_type] || 'UploadPresign'
1507
+
1508
+ # auth_names
1509
+ auth_names = opts[:debug_auth_names] || ['api_token_basic']
1510
+
1511
+ new_options = opts.merge(
1512
+ :operation => :"PDFApi.get_presign_url",
1032
1513
  :header_params => header_params,
1033
1514
  :query_params => query_params,
1034
1515
  :form_params => form_params,
1035
1516
  :body => post_body,
1036
1517
  :auth_names => auth_names,
1037
- :return_type => 'Hash<String, Object>')
1518
+ :return_type => return_type
1519
+ )
1520
+
1521
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
1038
1522
  if @api_client.config.debugging
1039
1523
  @api_client.config.logger.debug "API called: PDFApi#get_presign_url\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1040
1524
  end
@@ -1042,9 +1526,9 @@ module DocSpring
1042
1526
  end
1043
1527
 
1044
1528
  # Check the status of a PDF
1045
- # @param submission_id
1529
+ # @param submission_id [String]
1046
1530
  # @param [Hash] opts the optional parameters
1047
- # @option opts [BOOLEAN] :include_data
1531
+ # @option opts [Boolean] :include_data
1048
1532
  # @return [Submission]
1049
1533
  def get_submission(submission_id, opts = {})
1050
1534
  data, _status_code, _headers = get_submission_with_http_info(submission_id, opts)
@@ -1052,10 +1536,10 @@ module DocSpring
1052
1536
  end
1053
1537
 
1054
1538
  # Check the status of a PDF
1055
- # @param submission_id
1539
+ # @param submission_id [String]
1056
1540
  # @param [Hash] opts the optional parameters
1057
- # @option opts [BOOLEAN] :include_data
1058
- # @return [Array<(Submission, Fixnum, Hash)>] Submission data, response status code and response headers
1541
+ # @option opts [Boolean] :include_data
1542
+ # @return [Array<(Submission, Integer, Hash)>] Submission data, response status code and response headers
1059
1543
  def get_submission_with_http_info(submission_id, opts = {})
1060
1544
  if @api_client.config.debugging
1061
1545
  @api_client.config.logger.debug 'Calling API: PDFApi.get_submission ...'
@@ -1065,30 +1549,40 @@ module DocSpring
1065
1549
  fail ArgumentError, "Missing the required parameter 'submission_id' when calling PDFApi.get_submission"
1066
1550
  end
1067
1551
  # resource path
1068
- local_var_path = '/submissions/{submission_id}'.sub('{' + 'submission_id' + '}', submission_id.to_s)
1552
+ local_var_path = '/submissions/{submission_id}'.sub('{' + 'submission_id' + '}', CGI.escape(submission_id.to_s))
1069
1553
 
1070
1554
  # query parameters
1071
- query_params = {}
1555
+ query_params = opts[:query_params] || {}
1072
1556
  query_params[:'include_data'] = opts[:'include_data'] if !opts[:'include_data'].nil?
1073
1557
 
1074
1558
  # header parameters
1075
- header_params = {}
1559
+ header_params = opts[:header_params] || {}
1076
1560
  # HTTP header 'Accept' (if needed)
1077
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
1561
+ header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
1078
1562
 
1079
1563
  # form parameters
1080
- form_params = {}
1564
+ form_params = opts[:form_params] || {}
1081
1565
 
1082
1566
  # http body (model)
1083
- post_body = nil
1084
- auth_names = ['api_token_basic']
1085
- data, status_code, headers = @api_client.call_api(:GET, local_var_path,
1567
+ post_body = opts[:debug_body]
1568
+
1569
+ # return_type
1570
+ return_type = opts[:debug_return_type] || 'Submission'
1571
+
1572
+ # auth_names
1573
+ auth_names = opts[:debug_auth_names] || ['api_token_basic']
1574
+
1575
+ new_options = opts.merge(
1576
+ :operation => :"PDFApi.get_submission",
1086
1577
  :header_params => header_params,
1087
1578
  :query_params => query_params,
1088
1579
  :form_params => form_params,
1089
1580
  :body => post_body,
1090
1581
  :auth_names => auth_names,
1091
- :return_type => 'Submission')
1582
+ :return_type => return_type
1583
+ )
1584
+
1585
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
1092
1586
  if @api_client.config.debugging
1093
1587
  @api_client.config.logger.debug "API called: PDFApi#get_submission\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1094
1588
  end
@@ -1096,9 +1590,9 @@ module DocSpring
1096
1590
  end
1097
1591
 
1098
1592
  # Check the status of a submission batch job
1099
- # @param submission_batch_id
1593
+ # @param submission_batch_id [String]
1100
1594
  # @param [Hash] opts the optional parameters
1101
- # @option opts [BOOLEAN] :include_submissions
1595
+ # @option opts [Boolean] :include_submissions
1102
1596
  # @return [SubmissionBatch]
1103
1597
  def get_submission_batch(submission_batch_id, opts = {})
1104
1598
  data, _status_code, _headers = get_submission_batch_with_http_info(submission_batch_id, opts)
@@ -1106,10 +1600,10 @@ module DocSpring
1106
1600
  end
1107
1601
 
1108
1602
  # Check the status of a submission batch job
1109
- # @param submission_batch_id
1603
+ # @param submission_batch_id [String]
1110
1604
  # @param [Hash] opts the optional parameters
1111
- # @option opts [BOOLEAN] :include_submissions
1112
- # @return [Array<(SubmissionBatch, Fixnum, Hash)>] SubmissionBatch data, response status code and response headers
1605
+ # @option opts [Boolean] :include_submissions
1606
+ # @return [Array<(SubmissionBatch, Integer, Hash)>] SubmissionBatch data, response status code and response headers
1113
1607
  def get_submission_batch_with_http_info(submission_batch_id, opts = {})
1114
1608
  if @api_client.config.debugging
1115
1609
  @api_client.config.logger.debug 'Calling API: PDFApi.get_submission_batch ...'
@@ -1119,38 +1613,48 @@ module DocSpring
1119
1613
  fail ArgumentError, "Missing the required parameter 'submission_batch_id' when calling PDFApi.get_submission_batch"
1120
1614
  end
1121
1615
  # resource path
1122
- local_var_path = '/submissions/batches/{submission_batch_id}'.sub('{' + 'submission_batch_id' + '}', submission_batch_id.to_s)
1616
+ local_var_path = '/submissions/batches/{submission_batch_id}'.sub('{' + 'submission_batch_id' + '}', CGI.escape(submission_batch_id.to_s))
1123
1617
 
1124
1618
  # query parameters
1125
- query_params = {}
1619
+ query_params = opts[:query_params] || {}
1126
1620
  query_params[:'include_submissions'] = opts[:'include_submissions'] if !opts[:'include_submissions'].nil?
1127
1621
 
1128
1622
  # header parameters
1129
- header_params = {}
1623
+ header_params = opts[:header_params] || {}
1130
1624
  # HTTP header 'Accept' (if needed)
1131
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
1625
+ header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
1132
1626
 
1133
1627
  # form parameters
1134
- form_params = {}
1628
+ form_params = opts[:form_params] || {}
1135
1629
 
1136
1630
  # http body (model)
1137
- post_body = nil
1138
- auth_names = ['api_token_basic']
1139
- data, status_code, headers = @api_client.call_api(:GET, local_var_path,
1631
+ post_body = opts[:debug_body]
1632
+
1633
+ # return_type
1634
+ return_type = opts[:debug_return_type] || 'SubmissionBatch'
1635
+
1636
+ # auth_names
1637
+ auth_names = opts[:debug_auth_names] || ['api_token_basic']
1638
+
1639
+ new_options = opts.merge(
1640
+ :operation => :"PDFApi.get_submission_batch",
1140
1641
  :header_params => header_params,
1141
1642
  :query_params => query_params,
1142
1643
  :form_params => form_params,
1143
1644
  :body => post_body,
1144
1645
  :auth_names => auth_names,
1145
- :return_type => 'SubmissionBatch')
1646
+ :return_type => return_type
1647
+ )
1648
+
1649
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
1146
1650
  if @api_client.config.debugging
1147
1651
  @api_client.config.logger.debug "API called: PDFApi#get_submission_batch\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1148
1652
  end
1149
1653
  return data, status_code, headers
1150
1654
  end
1151
1655
 
1152
- # Get a single template
1153
- # @param template_id
1656
+ # Check the status of an uploaded template
1657
+ # @param template_id [String]
1154
1658
  # @param [Hash] opts the optional parameters
1155
1659
  # @return [Template]
1156
1660
  def get_template(template_id, opts = {})
@@ -1158,10 +1662,10 @@ module DocSpring
1158
1662
  data
1159
1663
  end
1160
1664
 
1161
- # Get a single template
1162
- # @param template_id
1665
+ # Check the status of an uploaded template
1666
+ # @param template_id [String]
1163
1667
  # @param [Hash] opts the optional parameters
1164
- # @return [Array<(Template, Fixnum, Hash)>] Template data, response status code and response headers
1668
+ # @return [Array<(Template, Integer, Hash)>] Template data, response status code and response headers
1165
1669
  def get_template_with_http_info(template_id, opts = {})
1166
1670
  if @api_client.config.debugging
1167
1671
  @api_client.config.logger.debug 'Calling API: PDFApi.get_template ...'
@@ -1171,29 +1675,39 @@ module DocSpring
1171
1675
  fail ArgumentError, "Missing the required parameter 'template_id' when calling PDFApi.get_template"
1172
1676
  end
1173
1677
  # resource path
1174
- local_var_path = '/templates/{template_id}'.sub('{' + 'template_id' + '}', template_id.to_s)
1678
+ local_var_path = '/templates/{template_id}'.sub('{' + 'template_id' + '}', CGI.escape(template_id.to_s))
1175
1679
 
1176
1680
  # query parameters
1177
- query_params = {}
1681
+ query_params = opts[:query_params] || {}
1178
1682
 
1179
1683
  # header parameters
1180
- header_params = {}
1684
+ header_params = opts[:header_params] || {}
1181
1685
  # HTTP header 'Accept' (if needed)
1182
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
1686
+ header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
1183
1687
 
1184
1688
  # form parameters
1185
- form_params = {}
1689
+ form_params = opts[:form_params] || {}
1186
1690
 
1187
1691
  # http body (model)
1188
- post_body = nil
1189
- auth_names = ['api_token_basic']
1190
- data, status_code, headers = @api_client.call_api(:GET, local_var_path,
1692
+ post_body = opts[:debug_body]
1693
+
1694
+ # return_type
1695
+ return_type = opts[:debug_return_type] || 'Template'
1696
+
1697
+ # auth_names
1698
+ auth_names = opts[:debug_auth_names] || ['api_token_basic']
1699
+
1700
+ new_options = opts.merge(
1701
+ :operation => :"PDFApi.get_template",
1191
1702
  :header_params => header_params,
1192
1703
  :query_params => query_params,
1193
1704
  :form_params => form_params,
1194
1705
  :body => post_body,
1195
1706
  :auth_names => auth_names,
1196
- :return_type => 'Template')
1707
+ :return_type => return_type
1708
+ )
1709
+
1710
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
1197
1711
  if @api_client.config.debugging
1198
1712
  @api_client.config.logger.debug "API called: PDFApi#get_template\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1199
1713
  end
@@ -1201,18 +1715,18 @@ module DocSpring
1201
1715
  end
1202
1716
 
1203
1717
  # Fetch the JSON schema for a template
1204
- # @param template_id
1718
+ # @param template_id [String]
1205
1719
  # @param [Hash] opts the optional parameters
1206
- # @return [Hash<String, Object>]
1720
+ # @return [TemplateSchema]
1207
1721
  def get_template_schema(template_id, opts = {})
1208
1722
  data, _status_code, _headers = get_template_schema_with_http_info(template_id, opts)
1209
1723
  data
1210
1724
  end
1211
1725
 
1212
1726
  # Fetch the JSON schema for a template
1213
- # @param template_id
1727
+ # @param template_id [String]
1214
1728
  # @param [Hash] opts the optional parameters
1215
- # @return [Array<(Hash<String, Object>, Fixnum, Hash)>] Hash<String, Object> data, response status code and response headers
1729
+ # @return [Array<(TemplateSchema, Integer, Hash)>] TemplateSchema data, response status code and response headers
1216
1730
  def get_template_schema_with_http_info(template_id, opts = {})
1217
1731
  if @api_client.config.debugging
1218
1732
  @api_client.config.logger.debug 'Calling API: PDFApi.get_template_schema ...'
@@ -1222,35 +1736,118 @@ module DocSpring
1222
1736
  fail ArgumentError, "Missing the required parameter 'template_id' when calling PDFApi.get_template_schema"
1223
1737
  end
1224
1738
  # resource path
1225
- local_var_path = '/templates/{template_id}/schema'.sub('{' + 'template_id' + '}', template_id.to_s)
1739
+ local_var_path = '/templates/{template_id}/schema'.sub('{' + 'template_id' + '}', CGI.escape(template_id.to_s))
1226
1740
 
1227
1741
  # query parameters
1228
- query_params = {}
1742
+ query_params = opts[:query_params] || {}
1229
1743
 
1230
1744
  # header parameters
1231
- header_params = {}
1745
+ header_params = opts[:header_params] || {}
1232
1746
  # HTTP header 'Accept' (if needed)
1233
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
1747
+ header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
1234
1748
 
1235
1749
  # form parameters
1236
- form_params = {}
1750
+ form_params = opts[:form_params] || {}
1237
1751
 
1238
1752
  # http body (model)
1239
- post_body = nil
1240
- auth_names = ['api_token_basic']
1241
- data, status_code, headers = @api_client.call_api(:GET, local_var_path,
1753
+ post_body = opts[:debug_body]
1754
+
1755
+ # return_type
1756
+ return_type = opts[:debug_return_type] || 'TemplateSchema'
1757
+
1758
+ # auth_names
1759
+ auth_names = opts[:debug_auth_names] || ['api_token_basic']
1760
+
1761
+ new_options = opts.merge(
1762
+ :operation => :"PDFApi.get_template_schema",
1242
1763
  :header_params => header_params,
1243
1764
  :query_params => query_params,
1244
1765
  :form_params => form_params,
1245
1766
  :body => post_body,
1246
1767
  :auth_names => auth_names,
1247
- :return_type => 'Hash<String, Object>')
1768
+ :return_type => return_type
1769
+ )
1770
+
1771
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
1248
1772
  if @api_client.config.debugging
1249
1773
  @api_client.config.logger.debug "API called: PDFApi#get_template_schema\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1250
1774
  end
1251
1775
  return data, status_code, headers
1252
1776
  end
1253
1777
 
1778
+ # Get a list of all combined submissions
1779
+ # @param [Hash] opts the optional parameters
1780
+ # @option opts [Integer] :page Default: 1
1781
+ # @option opts [Integer] :per_page Default: 50
1782
+ # @return [Array<CombinedSubmission>]
1783
+ def list_combined_submissions(opts = {})
1784
+ data, _status_code, _headers = list_combined_submissions_with_http_info(opts)
1785
+ data
1786
+ end
1787
+
1788
+ # Get a list of all combined submissions
1789
+ # @param [Hash] opts the optional parameters
1790
+ # @option opts [Integer] :page Default: 1
1791
+ # @option opts [Integer] :per_page Default: 50
1792
+ # @return [Array<(Array<CombinedSubmission>, Integer, Hash)>] Array<CombinedSubmission> data, response status code and response headers
1793
+ def list_combined_submissions_with_http_info(opts = {})
1794
+ if @api_client.config.debugging
1795
+ @api_client.config.logger.debug 'Calling API: PDFApi.list_combined_submissions ...'
1796
+ end
1797
+ if @api_client.config.client_side_validation && !opts[:'page'].nil? && opts[:'page'] < 1
1798
+ fail ArgumentError, 'invalid value for "opts[:"page"]" when calling PDFApi.list_combined_submissions, must be greater than or equal to 1.'
1799
+ end
1800
+
1801
+ if @api_client.config.client_side_validation && !opts[:'per_page'].nil? && opts[:'per_page'] > 50
1802
+ fail ArgumentError, 'invalid value for "opts[:"per_page"]" when calling PDFApi.list_combined_submissions, must be smaller than or equal to 50.'
1803
+ end
1804
+
1805
+ if @api_client.config.client_side_validation && !opts[:'per_page'].nil? && opts[:'per_page'] < 1
1806
+ fail ArgumentError, 'invalid value for "opts[:"per_page"]" when calling PDFApi.list_combined_submissions, must be greater than or equal to 1.'
1807
+ end
1808
+
1809
+ # resource path
1810
+ local_var_path = '/combined_submissions'
1811
+
1812
+ # query parameters
1813
+ query_params = opts[:query_params] || {}
1814
+ query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
1815
+ query_params[:'per_page'] = opts[:'per_page'] if !opts[:'per_page'].nil?
1816
+
1817
+ # header parameters
1818
+ header_params = opts[:header_params] || {}
1819
+ # HTTP header 'Accept' (if needed)
1820
+ header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
1821
+
1822
+ # form parameters
1823
+ form_params = opts[:form_params] || {}
1824
+
1825
+ # http body (model)
1826
+ post_body = opts[:debug_body]
1827
+
1828
+ # return_type
1829
+ return_type = opts[:debug_return_type] || 'Array<CombinedSubmission>'
1830
+
1831
+ # auth_names
1832
+ auth_names = opts[:debug_auth_names] || ['api_token_basic']
1833
+
1834
+ new_options = opts.merge(
1835
+ :operation => :"PDFApi.list_combined_submissions",
1836
+ :header_params => header_params,
1837
+ :query_params => query_params,
1838
+ :form_params => form_params,
1839
+ :body => post_body,
1840
+ :auth_names => auth_names,
1841
+ :return_type => return_type
1842
+ )
1843
+
1844
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
1845
+ if @api_client.config.debugging
1846
+ @api_client.config.logger.debug "API called: PDFApi#list_combined_submissions\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1847
+ end
1848
+ return data, status_code, headers
1849
+ end
1850
+
1254
1851
  # Get a list of all folders
1255
1852
  # @param [Hash] opts the optional parameters
1256
1853
  # @option opts [String] :parent_folder_id Filter By Folder Id
@@ -1263,7 +1860,7 @@ module DocSpring
1263
1860
  # Get a list of all folders
1264
1861
  # @param [Hash] opts the optional parameters
1265
1862
  # @option opts [String] :parent_folder_id Filter By Folder Id
1266
- # @return [Array<(Array<Folder>, Fixnum, Hash)>] Array<Folder> data, response status code and response headers
1863
+ # @return [Array<(Array<Folder>, Integer, Hash)>] Array<Folder> data, response status code and response headers
1267
1864
  def list_folders_with_http_info(opts = {})
1268
1865
  if @api_client.config.debugging
1269
1866
  @api_client.config.logger.debug 'Calling API: PDFApi.list_folders ...'
@@ -1272,33 +1869,195 @@ module DocSpring
1272
1869
  local_var_path = '/folders/'
1273
1870
 
1274
1871
  # query parameters
1275
- query_params = {}
1872
+ query_params = opts[:query_params] || {}
1276
1873
  query_params[:'parent_folder_id'] = opts[:'parent_folder_id'] if !opts[:'parent_folder_id'].nil?
1277
1874
 
1278
1875
  # header parameters
1279
- header_params = {}
1876
+ header_params = opts[:header_params] || {}
1280
1877
  # HTTP header 'Accept' (if needed)
1281
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
1878
+ header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
1282
1879
 
1283
1880
  # form parameters
1284
- form_params = {}
1881
+ form_params = opts[:form_params] || {}
1285
1882
 
1286
1883
  # http body (model)
1287
- post_body = nil
1288
- auth_names = ['api_token_basic']
1289
- data, status_code, headers = @api_client.call_api(:GET, local_var_path,
1884
+ post_body = opts[:debug_body]
1885
+
1886
+ # return_type
1887
+ return_type = opts[:debug_return_type] || 'Array<Folder>'
1888
+
1889
+ # auth_names
1890
+ auth_names = opts[:debug_auth_names] || ['api_token_basic']
1891
+
1892
+ new_options = opts.merge(
1893
+ :operation => :"PDFApi.list_folders",
1290
1894
  :header_params => header_params,
1291
1895
  :query_params => query_params,
1292
1896
  :form_params => form_params,
1293
1897
  :body => post_body,
1294
1898
  :auth_names => auth_names,
1295
- :return_type => 'Array<Folder>')
1899
+ :return_type => return_type
1900
+ )
1901
+
1902
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
1296
1903
  if @api_client.config.debugging
1297
1904
  @api_client.config.logger.debug "API called: PDFApi#list_folders\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1298
1905
  end
1299
1906
  return data, status_code, headers
1300
1907
  end
1301
1908
 
1909
+ # List all submissions
1910
+ # @param [Hash] opts the optional parameters
1911
+ # @option opts [String] :cursor
1912
+ # @option opts [Float] :limit
1913
+ # @option opts [String] :created_after
1914
+ # @option opts [String] :created_before
1915
+ # @option opts [String] :type
1916
+ # @option opts [Boolean] :include_data
1917
+ # @return [ListSubmissionsResponse]
1918
+ def list_submissions(opts = {})
1919
+ data, _status_code, _headers = list_submissions_with_http_info(opts)
1920
+ data
1921
+ end
1922
+
1923
+ # List all submissions
1924
+ # @param [Hash] opts the optional parameters
1925
+ # @option opts [String] :cursor
1926
+ # @option opts [Float] :limit
1927
+ # @option opts [String] :created_after
1928
+ # @option opts [String] :created_before
1929
+ # @option opts [String] :type
1930
+ # @option opts [Boolean] :include_data
1931
+ # @return [Array<(ListSubmissionsResponse, Integer, Hash)>] ListSubmissionsResponse data, response status code and response headers
1932
+ def list_submissions_with_http_info(opts = {})
1933
+ if @api_client.config.debugging
1934
+ @api_client.config.logger.debug 'Calling API: PDFApi.list_submissions ...'
1935
+ end
1936
+ # resource path
1937
+ local_var_path = '/submissions'
1938
+
1939
+ # query parameters
1940
+ query_params = opts[:query_params] || {}
1941
+ query_params[:'cursor'] = opts[:'cursor'] if !opts[:'cursor'].nil?
1942
+ query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
1943
+ query_params[:'created_after'] = opts[:'created_after'] if !opts[:'created_after'].nil?
1944
+ query_params[:'created_before'] = opts[:'created_before'] if !opts[:'created_before'].nil?
1945
+ query_params[:'type'] = opts[:'type'] if !opts[:'type'].nil?
1946
+ query_params[:'include_data'] = opts[:'include_data'] if !opts[:'include_data'].nil?
1947
+
1948
+ # header parameters
1949
+ header_params = opts[:header_params] || {}
1950
+ # HTTP header 'Accept' (if needed)
1951
+ header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
1952
+
1953
+ # form parameters
1954
+ form_params = opts[:form_params] || {}
1955
+
1956
+ # http body (model)
1957
+ post_body = opts[:debug_body]
1958
+
1959
+ # return_type
1960
+ return_type = opts[:debug_return_type] || 'ListSubmissionsResponse'
1961
+
1962
+ # auth_names
1963
+ auth_names = opts[:debug_auth_names] || ['api_token_basic']
1964
+
1965
+ new_options = opts.merge(
1966
+ :operation => :"PDFApi.list_submissions",
1967
+ :header_params => header_params,
1968
+ :query_params => query_params,
1969
+ :form_params => form_params,
1970
+ :body => post_body,
1971
+ :auth_names => auth_names,
1972
+ :return_type => return_type
1973
+ )
1974
+
1975
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
1976
+ if @api_client.config.debugging
1977
+ @api_client.config.logger.debug "API called: PDFApi#list_submissions\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1978
+ end
1979
+ return data, status_code, headers
1980
+ end
1981
+
1982
+ # List all submissions for a given template
1983
+ # @param template_id [String]
1984
+ # @param [Hash] opts the optional parameters
1985
+ # @option opts [String] :cursor
1986
+ # @option opts [Float] :limit
1987
+ # @option opts [String] :created_after
1988
+ # @option opts [String] :created_before
1989
+ # @option opts [String] :type
1990
+ # @option opts [Boolean] :include_data
1991
+ # @return [ListSubmissionsResponse]
1992
+ def list_template_submissions(template_id, opts = {})
1993
+ data, _status_code, _headers = list_template_submissions_with_http_info(template_id, opts)
1994
+ data
1995
+ end
1996
+
1997
+ # List all submissions for a given template
1998
+ # @param template_id [String]
1999
+ # @param [Hash] opts the optional parameters
2000
+ # @option opts [String] :cursor
2001
+ # @option opts [Float] :limit
2002
+ # @option opts [String] :created_after
2003
+ # @option opts [String] :created_before
2004
+ # @option opts [String] :type
2005
+ # @option opts [Boolean] :include_data
2006
+ # @return [Array<(ListSubmissionsResponse, Integer, Hash)>] ListSubmissionsResponse data, response status code and response headers
2007
+ def list_template_submissions_with_http_info(template_id, opts = {})
2008
+ if @api_client.config.debugging
2009
+ @api_client.config.logger.debug 'Calling API: PDFApi.list_template_submissions ...'
2010
+ end
2011
+ # verify the required parameter 'template_id' is set
2012
+ if @api_client.config.client_side_validation && template_id.nil?
2013
+ fail ArgumentError, "Missing the required parameter 'template_id' when calling PDFApi.list_template_submissions"
2014
+ end
2015
+ # resource path
2016
+ local_var_path = '/templates/{template_id}/submissions'.sub('{' + 'template_id' + '}', CGI.escape(template_id.to_s))
2017
+
2018
+ # query parameters
2019
+ query_params = opts[:query_params] || {}
2020
+ query_params[:'cursor'] = opts[:'cursor'] if !opts[:'cursor'].nil?
2021
+ query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
2022
+ query_params[:'created_after'] = opts[:'created_after'] if !opts[:'created_after'].nil?
2023
+ query_params[:'created_before'] = opts[:'created_before'] if !opts[:'created_before'].nil?
2024
+ query_params[:'type'] = opts[:'type'] if !opts[:'type'].nil?
2025
+ query_params[:'include_data'] = opts[:'include_data'] if !opts[:'include_data'].nil?
2026
+
2027
+ # header parameters
2028
+ header_params = opts[:header_params] || {}
2029
+ # HTTP header 'Accept' (if needed)
2030
+ header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
2031
+
2032
+ # form parameters
2033
+ form_params = opts[:form_params] || {}
2034
+
2035
+ # http body (model)
2036
+ post_body = opts[:debug_body]
2037
+
2038
+ # return_type
2039
+ return_type = opts[:debug_return_type] || 'ListSubmissionsResponse'
2040
+
2041
+ # auth_names
2042
+ auth_names = opts[:debug_auth_names] || ['api_token_basic']
2043
+
2044
+ new_options = opts.merge(
2045
+ :operation => :"PDFApi.list_template_submissions",
2046
+ :header_params => header_params,
2047
+ :query_params => query_params,
2048
+ :form_params => form_params,
2049
+ :body => post_body,
2050
+ :auth_names => auth_names,
2051
+ :return_type => return_type
2052
+ )
2053
+
2054
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
2055
+ if @api_client.config.debugging
2056
+ @api_client.config.logger.debug "API called: PDFApi#list_template_submissions\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
2057
+ end
2058
+ return data, status_code, headers
2059
+ end
2060
+
1302
2061
  # Get a list of all templates
1303
2062
  # @param [Hash] opts the optional parameters
1304
2063
  # @option opts [String] :query Search By Name
@@ -1317,7 +2076,7 @@ module DocSpring
1317
2076
  # @option opts [String] :parent_folder_id Filter By Folder Id
1318
2077
  # @option opts [Integer] :page Default: 1
1319
2078
  # @option opts [Integer] :per_page Default: 50
1320
- # @return [Array<(Array<Template>, Fixnum, Hash)>] Array<Template> data, response status code and response headers
2079
+ # @return [Array<(Array<Template>, Integer, Hash)>] Array<Template> data, response status code and response headers
1321
2080
  def list_templates_with_http_info(opts = {})
1322
2081
  if @api_client.config.debugging
1323
2082
  @api_client.config.logger.debug 'Calling API: PDFApi.list_templates ...'
@@ -1338,30 +2097,40 @@ module DocSpring
1338
2097
  local_var_path = '/templates'
1339
2098
 
1340
2099
  # query parameters
1341
- query_params = {}
2100
+ query_params = opts[:query_params] || {}
1342
2101
  query_params[:'query'] = opts[:'query'] if !opts[:'query'].nil?
1343
2102
  query_params[:'parent_folder_id'] = opts[:'parent_folder_id'] if !opts[:'parent_folder_id'].nil?
1344
2103
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
1345
2104
  query_params[:'per_page'] = opts[:'per_page'] if !opts[:'per_page'].nil?
1346
2105
 
1347
2106
  # header parameters
1348
- header_params = {}
2107
+ header_params = opts[:header_params] || {}
1349
2108
  # HTTP header 'Accept' (if needed)
1350
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
2109
+ header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
1351
2110
 
1352
2111
  # form parameters
1353
- form_params = {}
2112
+ form_params = opts[:form_params] || {}
1354
2113
 
1355
2114
  # http body (model)
1356
- post_body = nil
1357
- auth_names = ['api_token_basic']
1358
- data, status_code, headers = @api_client.call_api(:GET, local_var_path,
2115
+ post_body = opts[:debug_body]
2116
+
2117
+ # return_type
2118
+ return_type = opts[:debug_return_type] || 'Array<Template>'
2119
+
2120
+ # auth_names
2121
+ auth_names = opts[:debug_auth_names] || ['api_token_basic']
2122
+
2123
+ new_options = opts.merge(
2124
+ :operation => :"PDFApi.list_templates",
1359
2125
  :header_params => header_params,
1360
2126
  :query_params => query_params,
1361
2127
  :form_params => form_params,
1362
2128
  :body => post_body,
1363
2129
  :auth_names => auth_names,
1364
- :return_type => 'Array<Template>')
2130
+ :return_type => return_type
2131
+ )
2132
+
2133
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
1365
2134
  if @api_client.config.debugging
1366
2135
  @api_client.config.logger.debug "API called: PDFApi#list_templates\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1367
2136
  end
@@ -1369,21 +2138,21 @@ module DocSpring
1369
2138
  end
1370
2139
 
1371
2140
  # Move a folder
1372
- # @param folder_id
1373
- # @param move_folder_data
2141
+ # @param folder_id [String]
2142
+ # @param data [MoveFolderData]
1374
2143
  # @param [Hash] opts the optional parameters
1375
2144
  # @return [Folder]
1376
- def move_folder_to_folder(folder_id, move_folder_data, opts = {})
1377
- data, _status_code, _headers = move_folder_to_folder_with_http_info(folder_id, move_folder_data, opts)
2145
+ def move_folder_to_folder(folder_id, data, opts = {})
2146
+ data, _status_code, _headers = move_folder_to_folder_with_http_info(folder_id, data, opts)
1378
2147
  data
1379
2148
  end
1380
2149
 
1381
2150
  # Move a folder
1382
- # @param folder_id
1383
- # @param move_folder_data
2151
+ # @param folder_id [String]
2152
+ # @param data [MoveFolderData]
1384
2153
  # @param [Hash] opts the optional parameters
1385
- # @return [Array<(Folder, Fixnum, Hash)>] Folder data, response status code and response headers
1386
- def move_folder_to_folder_with_http_info(folder_id, move_folder_data, opts = {})
2154
+ # @return [Array<(Folder, Integer, Hash)>] Folder data, response status code and response headers
2155
+ def move_folder_to_folder_with_http_info(folder_id, data, opts = {})
1387
2156
  if @api_client.config.debugging
1388
2157
  @api_client.config.logger.debug 'Calling API: PDFApi.move_folder_to_folder ...'
1389
2158
  end
@@ -1391,36 +2160,49 @@ module DocSpring
1391
2160
  if @api_client.config.client_side_validation && folder_id.nil?
1392
2161
  fail ArgumentError, "Missing the required parameter 'folder_id' when calling PDFApi.move_folder_to_folder"
1393
2162
  end
1394
- # verify the required parameter 'move_folder_data' is set
1395
- if @api_client.config.client_side_validation && move_folder_data.nil?
1396
- fail ArgumentError, "Missing the required parameter 'move_folder_data' when calling PDFApi.move_folder_to_folder"
2163
+ # verify the required parameter 'data' is set
2164
+ if @api_client.config.client_side_validation && data.nil?
2165
+ fail ArgumentError, "Missing the required parameter 'data' when calling PDFApi.move_folder_to_folder"
1397
2166
  end
1398
2167
  # resource path
1399
- local_var_path = '/folders/{folder_id}/move'.sub('{' + 'folder_id' + '}', folder_id.to_s)
2168
+ local_var_path = '/folders/{folder_id}/move'.sub('{' + 'folder_id' + '}', CGI.escape(folder_id.to_s))
1400
2169
 
1401
2170
  # query parameters
1402
- query_params = {}
2171
+ query_params = opts[:query_params] || {}
1403
2172
 
1404
2173
  # header parameters
1405
- header_params = {}
2174
+ header_params = opts[:header_params] || {}
1406
2175
  # HTTP header 'Accept' (if needed)
1407
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
2176
+ header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
1408
2177
  # HTTP header 'Content-Type'
1409
- header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
2178
+ content_type = @api_client.select_header_content_type(['application/json'])
2179
+ if !content_type.nil?
2180
+ header_params['Content-Type'] = content_type
2181
+ end
1410
2182
 
1411
2183
  # form parameters
1412
- form_params = {}
2184
+ form_params = opts[:form_params] || {}
1413
2185
 
1414
2186
  # http body (model)
1415
- post_body = @api_client.object_to_http_body(move_folder_data)
1416
- auth_names = ['api_token_basic']
1417
- data, status_code, headers = @api_client.call_api(:POST, local_var_path,
2187
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(data)
2188
+
2189
+ # return_type
2190
+ return_type = opts[:debug_return_type] || 'Folder'
2191
+
2192
+ # auth_names
2193
+ auth_names = opts[:debug_auth_names] || ['api_token_basic']
2194
+
2195
+ new_options = opts.merge(
2196
+ :operation => :"PDFApi.move_folder_to_folder",
1418
2197
  :header_params => header_params,
1419
2198
  :query_params => query_params,
1420
2199
  :form_params => form_params,
1421
2200
  :body => post_body,
1422
2201
  :auth_names => auth_names,
1423
- :return_type => 'Folder')
2202
+ :return_type => return_type
2203
+ )
2204
+
2205
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
1424
2206
  if @api_client.config.debugging
1425
2207
  @api_client.config.logger.debug "API called: PDFApi#move_folder_to_folder\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1426
2208
  end
@@ -1428,21 +2210,21 @@ module DocSpring
1428
2210
  end
1429
2211
 
1430
2212
  # Move Template to folder
1431
- # @param template_id
1432
- # @param move_template_data
2213
+ # @param template_id [String]
2214
+ # @param data [MoveTemplateData]
1433
2215
  # @param [Hash] opts the optional parameters
1434
2216
  # @return [Template]
1435
- def move_template_to_folder(template_id, move_template_data, opts = {})
1436
- data, _status_code, _headers = move_template_to_folder_with_http_info(template_id, move_template_data, opts)
2217
+ def move_template_to_folder(template_id, data, opts = {})
2218
+ data, _status_code, _headers = move_template_to_folder_with_http_info(template_id, data, opts)
1437
2219
  data
1438
2220
  end
1439
2221
 
1440
2222
  # Move Template to folder
1441
- # @param template_id
1442
- # @param move_template_data
2223
+ # @param template_id [String]
2224
+ # @param data [MoveTemplateData]
1443
2225
  # @param [Hash] opts the optional parameters
1444
- # @return [Array<(Template, Fixnum, Hash)>] Template data, response status code and response headers
1445
- def move_template_to_folder_with_http_info(template_id, move_template_data, opts = {})
2226
+ # @return [Array<(Template, Integer, Hash)>] Template data, response status code and response headers
2227
+ def move_template_to_folder_with_http_info(template_id, data, opts = {})
1446
2228
  if @api_client.config.debugging
1447
2229
  @api_client.config.logger.debug 'Calling API: PDFApi.move_template_to_folder ...'
1448
2230
  end
@@ -1450,58 +2232,143 @@ module DocSpring
1450
2232
  if @api_client.config.client_side_validation && template_id.nil?
1451
2233
  fail ArgumentError, "Missing the required parameter 'template_id' when calling PDFApi.move_template_to_folder"
1452
2234
  end
1453
- # verify the required parameter 'move_template_data' is set
1454
- if @api_client.config.client_side_validation && move_template_data.nil?
1455
- fail ArgumentError, "Missing the required parameter 'move_template_data' when calling PDFApi.move_template_to_folder"
2235
+ # verify the required parameter 'data' is set
2236
+ if @api_client.config.client_side_validation && data.nil?
2237
+ fail ArgumentError, "Missing the required parameter 'data' when calling PDFApi.move_template_to_folder"
1456
2238
  end
1457
2239
  # resource path
1458
- local_var_path = '/templates/{template_id}/move'.sub('{' + 'template_id' + '}', template_id.to_s)
2240
+ local_var_path = '/templates/{template_id}/move'.sub('{' + 'template_id' + '}', CGI.escape(template_id.to_s))
1459
2241
 
1460
2242
  # query parameters
1461
- query_params = {}
2243
+ query_params = opts[:query_params] || {}
1462
2244
 
1463
2245
  # header parameters
1464
- header_params = {}
2246
+ header_params = opts[:header_params] || {}
1465
2247
  # HTTP header 'Accept' (if needed)
1466
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
2248
+ header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
1467
2249
  # HTTP header 'Content-Type'
1468
- header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
2250
+ content_type = @api_client.select_header_content_type(['application/json'])
2251
+ if !content_type.nil?
2252
+ header_params['Content-Type'] = content_type
2253
+ end
1469
2254
 
1470
2255
  # form parameters
1471
- form_params = {}
2256
+ form_params = opts[:form_params] || {}
1472
2257
 
1473
2258
  # http body (model)
1474
- post_body = @api_client.object_to_http_body(move_template_data)
1475
- auth_names = ['api_token_basic']
1476
- data, status_code, headers = @api_client.call_api(:POST, local_var_path,
2259
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(data)
2260
+
2261
+ # return_type
2262
+ return_type = opts[:debug_return_type] || 'Template'
2263
+
2264
+ # auth_names
2265
+ auth_names = opts[:debug_auth_names] || ['api_token_basic']
2266
+
2267
+ new_options = opts.merge(
2268
+ :operation => :"PDFApi.move_template_to_folder",
1477
2269
  :header_params => header_params,
1478
2270
  :query_params => query_params,
1479
2271
  :form_params => form_params,
1480
2272
  :body => post_body,
1481
2273
  :auth_names => auth_names,
1482
- :return_type => 'Template')
2274
+ :return_type => return_type
2275
+ )
2276
+
2277
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
1483
2278
  if @api_client.config.debugging
1484
2279
  @api_client.config.logger.debug "API called: PDFApi#move_template_to_folder\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1485
2280
  end
1486
2281
  return data, status_code, headers
1487
2282
  end
1488
2283
 
2284
+ # Publish a template version
2285
+ # @param template_id [String]
2286
+ # @param data [PublishVersionData]
2287
+ # @param [Hash] opts the optional parameters
2288
+ # @return [PublishTemplateVersionResponse]
2289
+ def publish_template_version(template_id, data, opts = {})
2290
+ data, _status_code, _headers = publish_template_version_with_http_info(template_id, data, opts)
2291
+ data
2292
+ end
2293
+
2294
+ # Publish a template version
2295
+ # @param template_id [String]
2296
+ # @param data [PublishVersionData]
2297
+ # @param [Hash] opts the optional parameters
2298
+ # @return [Array<(PublishTemplateVersionResponse, Integer, Hash)>] PublishTemplateVersionResponse data, response status code and response headers
2299
+ def publish_template_version_with_http_info(template_id, data, opts = {})
2300
+ if @api_client.config.debugging
2301
+ @api_client.config.logger.debug 'Calling API: PDFApi.publish_template_version ...'
2302
+ end
2303
+ # verify the required parameter 'template_id' is set
2304
+ if @api_client.config.client_side_validation && template_id.nil?
2305
+ fail ArgumentError, "Missing the required parameter 'template_id' when calling PDFApi.publish_template_version"
2306
+ end
2307
+ # verify the required parameter 'data' is set
2308
+ if @api_client.config.client_side_validation && data.nil?
2309
+ fail ArgumentError, "Missing the required parameter 'data' when calling PDFApi.publish_template_version"
2310
+ end
2311
+ # resource path
2312
+ local_var_path = '/templates/{template_id}/publish_version'.sub('{' + 'template_id' + '}', CGI.escape(template_id.to_s))
2313
+
2314
+ # query parameters
2315
+ query_params = opts[:query_params] || {}
2316
+
2317
+ # header parameters
2318
+ header_params = opts[:header_params] || {}
2319
+ # HTTP header 'Accept' (if needed)
2320
+ header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
2321
+ # HTTP header 'Content-Type'
2322
+ content_type = @api_client.select_header_content_type(['application/json'])
2323
+ if !content_type.nil?
2324
+ header_params['Content-Type'] = content_type
2325
+ end
2326
+
2327
+ # form parameters
2328
+ form_params = opts[:form_params] || {}
2329
+
2330
+ # http body (model)
2331
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(data)
2332
+
2333
+ # return_type
2334
+ return_type = opts[:debug_return_type] || 'PublishTemplateVersionResponse'
2335
+
2336
+ # auth_names
2337
+ auth_names = opts[:debug_auth_names] || ['api_token_basic']
2338
+
2339
+ new_options = opts.merge(
2340
+ :operation => :"PDFApi.publish_template_version",
2341
+ :header_params => header_params,
2342
+ :query_params => query_params,
2343
+ :form_params => form_params,
2344
+ :body => post_body,
2345
+ :auth_names => auth_names,
2346
+ :return_type => return_type
2347
+ )
2348
+
2349
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
2350
+ if @api_client.config.debugging
2351
+ @api_client.config.logger.debug "API called: PDFApi#publish_template_version\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
2352
+ end
2353
+ return data, status_code, headers
2354
+ end
2355
+
1489
2356
  # Rename a folder
1490
- # @param folder_id
1491
- # @param rename_folder_data
2357
+ # @param folder_id [String]
2358
+ # @param data [RenameFolderData]
1492
2359
  # @param [Hash] opts the optional parameters
1493
2360
  # @return [nil]
1494
- def rename_folder(folder_id, rename_folder_data, opts = {})
1495
- rename_folder_with_http_info(folder_id, rename_folder_data, opts)
2361
+ def rename_folder(folder_id, data, opts = {})
2362
+ rename_folder_with_http_info(folder_id, data, opts)
1496
2363
  nil
1497
2364
  end
1498
2365
 
1499
2366
  # Rename a folder
1500
- # @param folder_id
1501
- # @param rename_folder_data
2367
+ # @param folder_id [String]
2368
+ # @param data [RenameFolderData]
1502
2369
  # @param [Hash] opts the optional parameters
1503
- # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
1504
- def rename_folder_with_http_info(folder_id, rename_folder_data, opts = {})
2370
+ # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
2371
+ def rename_folder_with_http_info(folder_id, data, opts = {})
1505
2372
  if @api_client.config.debugging
1506
2373
  @api_client.config.logger.debug 'Calling API: PDFApi.rename_folder ...'
1507
2374
  end
@@ -1509,41 +2376,127 @@ module DocSpring
1509
2376
  if @api_client.config.client_side_validation && folder_id.nil?
1510
2377
  fail ArgumentError, "Missing the required parameter 'folder_id' when calling PDFApi.rename_folder"
1511
2378
  end
1512
- # verify the required parameter 'rename_folder_data' is set
1513
- if @api_client.config.client_side_validation && rename_folder_data.nil?
1514
- fail ArgumentError, "Missing the required parameter 'rename_folder_data' when calling PDFApi.rename_folder"
2379
+ # verify the required parameter 'data' is set
2380
+ if @api_client.config.client_side_validation && data.nil?
2381
+ fail ArgumentError, "Missing the required parameter 'data' when calling PDFApi.rename_folder"
1515
2382
  end
1516
2383
  # resource path
1517
- local_var_path = '/folders/{folder_id}/rename'.sub('{' + 'folder_id' + '}', folder_id.to_s)
2384
+ local_var_path = '/folders/{folder_id}/rename'.sub('{' + 'folder_id' + '}', CGI.escape(folder_id.to_s))
1518
2385
 
1519
2386
  # query parameters
1520
- query_params = {}
2387
+ query_params = opts[:query_params] || {}
1521
2388
 
1522
2389
  # header parameters
1523
- header_params = {}
2390
+ header_params = opts[:header_params] || {}
1524
2391
  # HTTP header 'Accept' (if needed)
1525
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
2392
+ header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
1526
2393
  # HTTP header 'Content-Type'
1527
- header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
2394
+ content_type = @api_client.select_header_content_type(['application/json'])
2395
+ if !content_type.nil?
2396
+ header_params['Content-Type'] = content_type
2397
+ end
1528
2398
 
1529
2399
  # form parameters
1530
- form_params = {}
2400
+ form_params = opts[:form_params] || {}
1531
2401
 
1532
2402
  # http body (model)
1533
- post_body = @api_client.object_to_http_body(rename_folder_data)
1534
- auth_names = ['api_token_basic']
1535
- data, status_code, headers = @api_client.call_api(:POST, local_var_path,
2403
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(data)
2404
+
2405
+ # return_type
2406
+ return_type = opts[:debug_return_type]
2407
+
2408
+ # auth_names
2409
+ auth_names = opts[:debug_auth_names] || ['api_token_basic']
2410
+
2411
+ new_options = opts.merge(
2412
+ :operation => :"PDFApi.rename_folder",
1536
2413
  :header_params => header_params,
1537
2414
  :query_params => query_params,
1538
2415
  :form_params => form_params,
1539
2416
  :body => post_body,
1540
- :auth_names => auth_names)
2417
+ :auth_names => auth_names,
2418
+ :return_type => return_type
2419
+ )
2420
+
2421
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
1541
2422
  if @api_client.config.debugging
1542
2423
  @api_client.config.logger.debug "API called: PDFApi#rename_folder\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1543
2424
  end
1544
2425
  return data, status_code, headers
1545
2426
  end
1546
2427
 
2428
+ # Restore a template version
2429
+ # @param template_id [String]
2430
+ # @param data [RestoreVersionData]
2431
+ # @param [Hash] opts the optional parameters
2432
+ # @return [RestoreTemplateVersionResponse]
2433
+ def restore_template_version(template_id, data, opts = {})
2434
+ data, _status_code, _headers = restore_template_version_with_http_info(template_id, data, opts)
2435
+ data
2436
+ end
2437
+
2438
+ # Restore a template version
2439
+ # @param template_id [String]
2440
+ # @param data [RestoreVersionData]
2441
+ # @param [Hash] opts the optional parameters
2442
+ # @return [Array<(RestoreTemplateVersionResponse, Integer, Hash)>] RestoreTemplateVersionResponse data, response status code and response headers
2443
+ def restore_template_version_with_http_info(template_id, data, opts = {})
2444
+ if @api_client.config.debugging
2445
+ @api_client.config.logger.debug 'Calling API: PDFApi.restore_template_version ...'
2446
+ end
2447
+ # verify the required parameter 'template_id' is set
2448
+ if @api_client.config.client_side_validation && template_id.nil?
2449
+ fail ArgumentError, "Missing the required parameter 'template_id' when calling PDFApi.restore_template_version"
2450
+ end
2451
+ # verify the required parameter 'data' is set
2452
+ if @api_client.config.client_side_validation && data.nil?
2453
+ fail ArgumentError, "Missing the required parameter 'data' when calling PDFApi.restore_template_version"
2454
+ end
2455
+ # resource path
2456
+ local_var_path = '/templates/{template_id}/restore_version'.sub('{' + 'template_id' + '}', CGI.escape(template_id.to_s))
2457
+
2458
+ # query parameters
2459
+ query_params = opts[:query_params] || {}
2460
+
2461
+ # header parameters
2462
+ header_params = opts[:header_params] || {}
2463
+ # HTTP header 'Accept' (if needed)
2464
+ header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
2465
+ # HTTP header 'Content-Type'
2466
+ content_type = @api_client.select_header_content_type(['application/json'])
2467
+ if !content_type.nil?
2468
+ header_params['Content-Type'] = content_type
2469
+ end
2470
+
2471
+ # form parameters
2472
+ form_params = opts[:form_params] || {}
2473
+
2474
+ # http body (model)
2475
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(data)
2476
+
2477
+ # return_type
2478
+ return_type = opts[:debug_return_type] || 'RestoreTemplateVersionResponse'
2479
+
2480
+ # auth_names
2481
+ auth_names = opts[:debug_auth_names] || ['api_token_basic']
2482
+
2483
+ new_options = opts.merge(
2484
+ :operation => :"PDFApi.restore_template_version",
2485
+ :header_params => header_params,
2486
+ :query_params => query_params,
2487
+ :form_params => form_params,
2488
+ :body => post_body,
2489
+ :auth_names => auth_names,
2490
+ :return_type => return_type
2491
+ )
2492
+
2493
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
2494
+ if @api_client.config.debugging
2495
+ @api_client.config.logger.debug "API called: PDFApi#restore_template_version\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
2496
+ end
2497
+ return data, status_code, headers
2498
+ end
2499
+
1547
2500
  # Test Authentication
1548
2501
  # @param [Hash] opts the optional parameters
1549
2502
  # @return [AuthenticationSuccessResponse]
@@ -1554,7 +2507,7 @@ module DocSpring
1554
2507
 
1555
2508
  # Test Authentication
1556
2509
  # @param [Hash] opts the optional parameters
1557
- # @return [Array<(AuthenticationSuccessResponse, Fixnum, Hash)>] AuthenticationSuccessResponse data, response status code and response headers
2510
+ # @return [Array<(AuthenticationSuccessResponse, Integer, Hash)>] AuthenticationSuccessResponse data, response status code and response headers
1558
2511
  def test_authentication_with_http_info(opts = {})
1559
2512
  if @api_client.config.debugging
1560
2513
  @api_client.config.logger.debug 'Calling API: PDFApi.test_authentication ...'
@@ -1563,26 +2516,36 @@ module DocSpring
1563
2516
  local_var_path = '/authentication'
1564
2517
 
1565
2518
  # query parameters
1566
- query_params = {}
2519
+ query_params = opts[:query_params] || {}
1567
2520
 
1568
2521
  # header parameters
1569
- header_params = {}
2522
+ header_params = opts[:header_params] || {}
1570
2523
  # HTTP header 'Accept' (if needed)
1571
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
2524
+ header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
1572
2525
 
1573
2526
  # form parameters
1574
- form_params = {}
2527
+ form_params = opts[:form_params] || {}
1575
2528
 
1576
2529
  # http body (model)
1577
- post_body = nil
1578
- auth_names = ['api_token_basic']
1579
- data, status_code, headers = @api_client.call_api(:GET, local_var_path,
2530
+ post_body = opts[:debug_body]
2531
+
2532
+ # return_type
2533
+ return_type = opts[:debug_return_type] || 'AuthenticationSuccessResponse'
2534
+
2535
+ # auth_names
2536
+ auth_names = opts[:debug_auth_names] || ['api_token_basic']
2537
+
2538
+ new_options = opts.merge(
2539
+ :operation => :"PDFApi.test_authentication",
1580
2540
  :header_params => header_params,
1581
2541
  :query_params => query_params,
1582
2542
  :form_params => form_params,
1583
2543
  :body => post_body,
1584
2544
  :auth_names => auth_names,
1585
- :return_type => 'AuthenticationSuccessResponse')
2545
+ :return_type => return_type
2546
+ )
2547
+
2548
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
1586
2549
  if @api_client.config.debugging
1587
2550
  @api_client.config.logger.debug "API called: PDFApi#test_authentication\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1588
2551
  end
@@ -1590,21 +2553,21 @@ module DocSpring
1590
2553
  end
1591
2554
 
1592
2555
  # Update a submission data request
1593
- # @param data_request_id
1594
- # @param update_submission_data_request_data
2556
+ # @param data_request_id [String]
2557
+ # @param data [UpdateSubmissionDataRequestData]
1595
2558
  # @param [Hash] opts the optional parameters
1596
2559
  # @return [UpdateDataRequestResponse]
1597
- def update_data_request(data_request_id, update_submission_data_request_data, opts = {})
1598
- data, _status_code, _headers = update_data_request_with_http_info(data_request_id, update_submission_data_request_data, opts)
2560
+ def update_data_request(data_request_id, data, opts = {})
2561
+ data, _status_code, _headers = update_data_request_with_http_info(data_request_id, data, opts)
1599
2562
  data
1600
2563
  end
1601
2564
 
1602
2565
  # Update a submission data request
1603
- # @param data_request_id
1604
- # @param update_submission_data_request_data
2566
+ # @param data_request_id [String]
2567
+ # @param data [UpdateSubmissionDataRequestData]
1605
2568
  # @param [Hash] opts the optional parameters
1606
- # @return [Array<(UpdateDataRequestResponse, Fixnum, Hash)>] UpdateDataRequestResponse data, response status code and response headers
1607
- def update_data_request_with_http_info(data_request_id, update_submission_data_request_data, opts = {})
2569
+ # @return [Array<(UpdateDataRequestResponse, Integer, Hash)>] UpdateDataRequestResponse data, response status code and response headers
2570
+ def update_data_request_with_http_info(data_request_id, data, opts = {})
1608
2571
  if @api_client.config.debugging
1609
2572
  @api_client.config.logger.debug 'Calling API: PDFApi.update_data_request ...'
1610
2573
  end
@@ -1612,36 +2575,49 @@ module DocSpring
1612
2575
  if @api_client.config.client_side_validation && data_request_id.nil?
1613
2576
  fail ArgumentError, "Missing the required parameter 'data_request_id' when calling PDFApi.update_data_request"
1614
2577
  end
1615
- # verify the required parameter 'update_submission_data_request_data' is set
1616
- if @api_client.config.client_side_validation && update_submission_data_request_data.nil?
1617
- fail ArgumentError, "Missing the required parameter 'update_submission_data_request_data' when calling PDFApi.update_data_request"
2578
+ # verify the required parameter 'data' is set
2579
+ if @api_client.config.client_side_validation && data.nil?
2580
+ fail ArgumentError, "Missing the required parameter 'data' when calling PDFApi.update_data_request"
1618
2581
  end
1619
2582
  # resource path
1620
- local_var_path = '/data_requests/{data_request_id}'.sub('{' + 'data_request_id' + '}', data_request_id.to_s)
2583
+ local_var_path = '/data_requests/{data_request_id}'.sub('{' + 'data_request_id' + '}', CGI.escape(data_request_id.to_s))
1621
2584
 
1622
2585
  # query parameters
1623
- query_params = {}
2586
+ query_params = opts[:query_params] || {}
1624
2587
 
1625
2588
  # header parameters
1626
- header_params = {}
2589
+ header_params = opts[:header_params] || {}
1627
2590
  # HTTP header 'Accept' (if needed)
1628
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
2591
+ header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
1629
2592
  # HTTP header 'Content-Type'
1630
- header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
2593
+ content_type = @api_client.select_header_content_type(['application/json'])
2594
+ if !content_type.nil?
2595
+ header_params['Content-Type'] = content_type
2596
+ end
1631
2597
 
1632
2598
  # form parameters
1633
- form_params = {}
2599
+ form_params = opts[:form_params] || {}
1634
2600
 
1635
2601
  # http body (model)
1636
- post_body = @api_client.object_to_http_body(update_submission_data_request_data)
1637
- auth_names = ['api_token_basic']
1638
- data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
2602
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(data)
2603
+
2604
+ # return_type
2605
+ return_type = opts[:debug_return_type] || 'UpdateDataRequestResponse'
2606
+
2607
+ # auth_names
2608
+ auth_names = opts[:debug_auth_names] || ['api_token_basic']
2609
+
2610
+ new_options = opts.merge(
2611
+ :operation => :"PDFApi.update_data_request",
1639
2612
  :header_params => header_params,
1640
2613
  :query_params => query_params,
1641
2614
  :form_params => form_params,
1642
2615
  :body => post_body,
1643
2616
  :auth_names => auth_names,
1644
- :return_type => 'UpdateDataRequestResponse')
2617
+ :return_type => return_type
2618
+ )
2619
+
2620
+ data, status_code, headers = @api_client.call_api(:PUT, local_var_path, new_options)
1645
2621
  if @api_client.config.debugging
1646
2622
  @api_client.config.logger.debug "API called: PDFApi#update_data_request\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1647
2623
  end
@@ -1649,21 +2625,21 @@ module DocSpring
1649
2625
  end
1650
2626
 
1651
2627
  # Update a Template
1652
- # @param template_id
1653
- # @param update_template_data
2628
+ # @param template_id [String]
2629
+ # @param data [UpdateTemplateData]
1654
2630
  # @param [Hash] opts the optional parameters
1655
2631
  # @return [UpdateTemplateResponse]
1656
- def update_template(template_id, update_template_data, opts = {})
1657
- data, _status_code, _headers = update_template_with_http_info(template_id, update_template_data, opts)
2632
+ def update_template(template_id, data, opts = {})
2633
+ data, _status_code, _headers = update_template_with_http_info(template_id, data, opts)
1658
2634
  data
1659
2635
  end
1660
2636
 
1661
2637
  # Update a Template
1662
- # @param template_id
1663
- # @param update_template_data
2638
+ # @param template_id [String]
2639
+ # @param data [UpdateTemplateData]
1664
2640
  # @param [Hash] opts the optional parameters
1665
- # @return [Array<(UpdateTemplateResponse, Fixnum, Hash)>] UpdateTemplateResponse data, response status code and response headers
1666
- def update_template_with_http_info(template_id, update_template_data, opts = {})
2641
+ # @return [Array<(UpdateTemplateResponse, Integer, Hash)>] UpdateTemplateResponse data, response status code and response headers
2642
+ def update_template_with_http_info(template_id, data, opts = {})
1667
2643
  if @api_client.config.debugging
1668
2644
  @api_client.config.logger.debug 'Calling API: PDFApi.update_template ...'
1669
2645
  end
@@ -1671,41 +2647,53 @@ module DocSpring
1671
2647
  if @api_client.config.client_side_validation && template_id.nil?
1672
2648
  fail ArgumentError, "Missing the required parameter 'template_id' when calling PDFApi.update_template"
1673
2649
  end
1674
- # verify the required parameter 'update_template_data' is set
1675
- if @api_client.config.client_side_validation && update_template_data.nil?
1676
- fail ArgumentError, "Missing the required parameter 'update_template_data' when calling PDFApi.update_template"
2650
+ # verify the required parameter 'data' is set
2651
+ if @api_client.config.client_side_validation && data.nil?
2652
+ fail ArgumentError, "Missing the required parameter 'data' when calling PDFApi.update_template"
1677
2653
  end
1678
2654
  # resource path
1679
- local_var_path = '/templates/{template_id}'.sub('{' + 'template_id' + '}', template_id.to_s)
2655
+ local_var_path = '/templates/{template_id}'.sub('{' + 'template_id' + '}', CGI.escape(template_id.to_s))
1680
2656
 
1681
2657
  # query parameters
1682
- query_params = {}
2658
+ query_params = opts[:query_params] || {}
1683
2659
 
1684
2660
  # header parameters
1685
- header_params = {}
2661
+ header_params = opts[:header_params] || {}
1686
2662
  # HTTP header 'Accept' (if needed)
1687
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
2663
+ header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
1688
2664
  # HTTP header 'Content-Type'
1689
- header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
2665
+ content_type = @api_client.select_header_content_type(['application/json'])
2666
+ if !content_type.nil?
2667
+ header_params['Content-Type'] = content_type
2668
+ end
1690
2669
 
1691
2670
  # form parameters
1692
- form_params = {}
2671
+ form_params = opts[:form_params] || {}
1693
2672
 
1694
2673
  # http body (model)
1695
- post_body = @api_client.object_to_http_body(update_template_data)
1696
- auth_names = ['api_token_basic']
1697
- data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
2674
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(data)
2675
+
2676
+ # return_type
2677
+ return_type = opts[:debug_return_type] || 'UpdateTemplateResponse'
2678
+
2679
+ # auth_names
2680
+ auth_names = opts[:debug_auth_names] || ['api_token_basic']
2681
+
2682
+ new_options = opts.merge(
2683
+ :operation => :"PDFApi.update_template",
1698
2684
  :header_params => header_params,
1699
2685
  :query_params => query_params,
1700
2686
  :form_params => form_params,
1701
2687
  :body => post_body,
1702
2688
  :auth_names => auth_names,
1703
- :return_type => 'UpdateTemplateResponse')
2689
+ :return_type => return_type
2690
+ )
2691
+
2692
+ data, status_code, headers = @api_client.call_api(:PUT, local_var_path, new_options)
1704
2693
  if @api_client.config.debugging
1705
2694
  @api_client.config.logger.debug "API called: PDFApi#update_template\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1706
2695
  end
1707
2696
  return data, status_code, headers
1708
2697
  end
1709
-
1710
2698
  end
1711
2699
  end