docspring 1.4.1 → 2.0.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (243) 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 +5 -0
  8. data/Gemfile +5 -1
  9. data/Gemfile.lock +85 -48
  10. data/README.md +43 -18
  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 -8
  16. data/docs/CombinedSubmission.md +37 -13
  17. data/docs/CombinedSubmissionAction.md +23 -8
  18. data/docs/CombinedSubmissionData.md +21 -7
  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 +17 -5
  45. data/docs/MoveFolderData.md +13 -3
  46. data/docs/MoveTemplateData.md +13 -3
  47. data/docs/PDFApi.md +1598 -523
  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 -10
  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 +1344 -539
  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 +65 -32
  89. data/lib/docspring/models/combined_submission.rb +165 -75
  90. data/lib/docspring/models/combined_submission_action.rb +83 -39
  91. data/lib/docspring/models/combined_submission_data.rb +63 -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/{template1.rb → full_template.rb} +476 -240
  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 +87 -39
  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 -50
  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/{template1_defaults.rb → template_defaults.rb} +77 -29
  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 +29 -12
  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 +427 -118
  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 +13 -18
  160. data/spec/models/combined_submission_action_spec.rb +16 -21
  161. data/spec/models/combined_submission_data_spec.rb +12 -17
  162. data/spec/models/combined_submission_spec.rb +42 -35
  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 +13 -18
  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 -30
  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 +108 -132
  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/Template1.md +0 -46
  228. data/docs/Template1Defaults.md +0 -10
  229. data/docs/TemplatestemplateIdaddFieldsFields.md +0 -92
  230. data/docs/UploadTemplateDataDocument.md +0 -10
  231. data/docs/UploadTemplateDataDocumentMetadata.md +0 -10
  232. data/lib/docspring/models/templatestemplate_idadd_fields_fields.rb +0 -1306
  233. data/spec/api_client_spec.rb +0 -226
  234. data/spec/configuration_spec.rb +0 -53
  235. data/spec/models/create_submission_data_request_token_response_token_spec.rb +0 -59
  236. data/spec/models/custom_file_spec.rb +0 -47
  237. data/spec/models/error_spec.rb +0 -51
  238. data/spec/models/folders_folder_spec.rb +0 -47
  239. data/spec/models/template1_defaults_spec.rb +0 -53
  240. data/spec/models/template1_spec.rb +0 -273
  241. data/spec/models/templatestemplate_idadd_fields_fields_spec.rb +0 -589
  242. data/spec/models/upload_template_data_document_metadata_spec.rb +0 -57
  243. data/spec/models/upload_template_data_document_spec.rb +0 -57
data/docs/PendingTemplate.md CHANGED
@@ -1,24 +1,50 @@
1
1
  # DocSpring::PendingTemplate
2
2
 
3
3
  ## Properties
4
- Name | Type | Description | Notes
5
- ------------ | ------------- | ------------- | -------------
6
- **expiration_interval** | **String** | | [optional]
7
- **webhook_url** | **String** | | [optional]
8
- **parent_folder_id** | **String** | | [optional]
9
- **expire_after** | **Float** | | [optional]
10
- **allow_additional_properties** | **BOOLEAN** | | [optional]
11
- **description** | **String** | | [optional]
12
- **public_submissions** | **BOOLEAN** | | [optional]
13
- **slack_webhook_url** | **String** | | [optional]
14
- **path** | **String** | | [optional]
15
- **public_web_form** | **BOOLEAN** | | [optional]
16
- **editable_submissions** | **BOOLEAN** | | [optional]
17
- **expire_submissions** | **BOOLEAN** | | [optional]
18
- **name** | **String** | | [optional]
19
- **template_type** | **String** | | [optional]
20
- **id** | **String** | | [optional]
21
- **locked** | **BOOLEAN** | | [optional]
22
- **redirect_url** | **String** | | [optional]
23
4
 
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **id** | **String** | | |
8
+ | **name** | **String** | | |
9
+ | **description** | **String** | | |
10
+ | **template_type** | **String** | | |
11
+ | **public_web_form** | **Boolean** | | |
12
+ | **public_submissions** | **Boolean** | | |
13
+ | **expire_submissions** | **Boolean** | | |
14
+ | **expire_after** | **Float** | | [optional] |
15
+ | **locked** | **Boolean** | | |
16
+ | **expiration_interval** | **String** | | [optional] |
17
+ | **allow_additional_properties** | **Boolean** | | |
18
+ | **editable_submissions** | **Boolean** | | |
19
+ | **webhook_url** | **String** | | |
20
+ | **slack_webhook_url** | **String** | | |
21
+ | **redirect_url** | **String** | | |
22
+ | **path** | **String** | | [optional] |
23
+ | **parent_folder_id** | **String** | | [optional] |
24
+
25
+ ## Example
26
+
27
+ ```ruby
28
+ require 'docspring'
29
+
30
+ instance = DocSpring::PendingTemplate.new(
31
+ id: null,
32
+ name: null,
33
+ description: null,
34
+ template_type: null,
35
+ public_web_form: null,
36
+ public_submissions: null,
37
+ expire_submissions: null,
38
+ expire_after: null,
39
+ locked: null,
40
+ expiration_interval: null,
41
+ allow_additional_properties: null,
42
+ editable_submissions: null,
43
+ webhook_url: null,
44
+ slack_webhook_url: null,
45
+ redirect_url: null,
46
+ path: null,
47
+ parent_folder_id: null
48
+ )
49
+ ```
24
50
 
data/docs/PreviewPdfResponse.md ADDED
@@ -0,0 +1,20 @@
1
+ # DocSpring::PreviewPdfResponse
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **status** | **String** | | |
8
+ | **error** | **String** | | [optional] |
9
+
10
+ ## Example
11
+
12
+ ```ruby
13
+ require 'docspring'
14
+
15
+ instance = DocSpring::PreviewPdfResponse.new(
16
+ status: null,
17
+ error: null
18
+ )
19
+ ```
20
+
data/docs/PublishTemplateVersion404Response.md ADDED
@@ -0,0 +1,20 @@
1
+ # DocSpring::PublishTemplateVersion404Response
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **status** | **String** | | |
8
+ | **error** | **String** | | |
9
+
10
+ ## Example
11
+
12
+ ```ruby
13
+ require 'docspring'
14
+
15
+ instance = DocSpring::PublishTemplateVersion404Response.new(
16
+ status: null,
17
+ error: null
18
+ )
19
+ ```
20
+
data/docs/PublishTemplateVersion422Response.md ADDED
@@ -0,0 +1,20 @@
1
+ # DocSpring::PublishTemplateVersion422Response
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **status** | **String** | | |
8
+ | **errors** | **Array<String>** | | |
9
+
10
+ ## Example
11
+
12
+ ```ruby
13
+ require 'docspring'
14
+
15
+ instance = DocSpring::PublishTemplateVersion422Response.new(
16
+ status: null,
17
+ errors: null
18
+ )
19
+ ```
20
+
data/docs/PublishTemplateVersionResponse.md ADDED
@@ -0,0 +1,20 @@
1
+ # DocSpring::PublishTemplateVersionResponse
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **status** | **String** | | |
8
+ | **result** | [**PublishTemplateVersionResponseResult**](PublishTemplateVersionResponseResult.md) | | |
9
+
10
+ ## Example
11
+
12
+ ```ruby
13
+ require 'docspring'
14
+
15
+ instance = DocSpring::PublishTemplateVersionResponse.new(
16
+ status: null,
17
+ result: null
18
+ )
19
+ ```
20
+
data/docs/PublishTemplateVersionResponseResult.md ADDED
@@ -0,0 +1,24 @@
1
+ # DocSpring::PublishTemplateVersionResponseResult
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **version** | **String** | | |
8
+ | **description** | **String** | | [optional] |
9
+ | **published_at** | **String** | | |
10
+ | **published_by_id** | **String** | | |
11
+
12
+ ## Example
13
+
14
+ ```ruby
15
+ require 'docspring'
16
+
17
+ instance = DocSpring::PublishTemplateVersionResponseResult.new(
18
+ version: null,
19
+ description: null,
20
+ published_at: null,
21
+ published_by_id: null
22
+ )
23
+ ```
24
+
data/docs/PublishVersionData.md ADDED
@@ -0,0 +1,20 @@
1
+ # DocSpring::PublishVersionData
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **description** | **String** | | [optional] |
8
+ | **version_type** | **String** | | |
9
+
10
+ ## Example
11
+
12
+ ```ruby
13
+ require 'docspring'
14
+
15
+ instance = DocSpring::PublishVersionData.new(
16
+ description: null,
17
+ version_type: null
18
+ )
19
+ ```
20
+
data/docs/RenameFolderData.md CHANGED
@@ -1,8 +1,18 @@
1
1
  # DocSpring::RenameFolderData
2
2
 
3
3
  ## Properties
4
- Name | Type | Description | Notes
5
- ------------ | ------------- | ------------- | -------------
6
- **name** | **String** | |
7
4
 
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **name** | **String** | | |
8
+
9
+ ## Example
10
+
11
+ ```ruby
12
+ require 'docspring'
13
+
14
+ instance = DocSpring::RenameFolderData.new(
15
+ name: null
16
+ )
17
+ ```
8
18
 
data/docs/RestoreTemplateVersionResponse.md ADDED
@@ -0,0 +1,18 @@
1
+ # DocSpring::RestoreTemplateVersionResponse
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **status** | **String** | | |
8
+
9
+ ## Example
10
+
11
+ ```ruby
12
+ require 'docspring'
13
+
14
+ instance = DocSpring::RestoreTemplateVersionResponse.new(
15
+ status: null
16
+ )
17
+ ```
18
+
data/docs/RestoreVersionData.md ADDED
@@ -0,0 +1,18 @@
1
+ # DocSpring::RestoreVersionData
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **version** | **String** | | |
8
+
9
+ ## Example
10
+
11
+ ```ruby
12
+ require 'docspring'
13
+
14
+ instance = DocSpring::RestoreVersionData.new(
15
+ version: null
16
+ )
17
+ ```
18
+
data/docs/Submission.md CHANGED
@@ -1,26 +1,54 @@
1
1
  # DocSpring::Submission
2
2
 
3
3
  ## Properties
4
- Name | Type | Description | Notes
5
- ------------ | ------------- | ------------- | -------------
6
- **id** | **String** | |
7
- **template_id** | **String** | | [optional]
8
- **test** | **BOOLEAN** | |
9
- **editable** | **BOOLEAN** | | [optional]
10
- **expired** | **BOOLEAN** | |
11
- **expires_at** | **String** | | [optional]
12
- **processed_at** | **String** | | [optional]
13
- **state** | **String** | |
14
- **data** | **Object** | | [optional]
15
- **metadata** | **Object** | | [optional]
16
- **truncated_text** | **Object** | | [optional]
17
- **pdf_hash** | **String** | | [optional]
18
- **download_url** | **String** | | [optional]
19
- **permanent_download_url** | **String** | | [optional]
20
- **batch_id** | **String** | | [optional]
21
- **data_requests** | [**Array<SubmissionDataRequest>**](SubmissionDataRequest.md) | | [optional]
22
- **actions** | [**Array<SubmissionAction>**](SubmissionAction.md) | | [optional]
23
- **source** | **String** | | [optional]
24
- **referrer** | **String** | | [optional]
25
4
 
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **id** | **String** | | |
8
+ | **template_id** | **String** | | [optional] |
9
+ | **test** | **Boolean** | | |
10
+ | **editable** | **Boolean** | | [optional] |
11
+ | **expired** | **Boolean** | | |
12
+ | **expires_at** | **String** | | [optional] |
13
+ | **processed_at** | **String** | | [optional] |
14
+ | **state** | **String** | | |
15
+ | **data** | **Object** | | [optional] |
16
+ | **metadata** | **Object** | | [optional] |
17
+ | **truncated_text** | **Object** | | [optional] |
18
+ | **pdf_hash** | **String** | | [optional] |
19
+ | **download_url** | **String** | | [optional] |
20
+ | **permanent_download_url** | **String** | | [optional] |
21
+ | **batch_id** | **String** | | [optional] |
22
+ | **data_requests** | [**Array<SubmissionDataRequest>**](SubmissionDataRequest.md) | | [optional] |
23
+ | **actions** | [**Array<SubmissionAction>**](SubmissionAction.md) | | [optional] |
24
+ | **source** | **String** | | [optional] |
25
+ | **referrer** | **String** | | [optional] |
26
+
27
+ ## Example
28
+
29
+ ```ruby
30
+ require 'docspring'
31
+
32
+ instance = DocSpring::Submission.new(
33
+ id: null,
34
+ template_id: null,
35
+ test: null,
36
+ editable: null,
37
+ expired: null,
38
+ expires_at: null,
39
+ processed_at: null,
40
+ state: null,
41
+ data: null,
42
+ metadata: null,
43
+ truncated_text: null,
44
+ pdf_hash: null,
45
+ download_url: null,
46
+ permanent_download_url: null,
47
+ batch_id: null,
48
+ data_requests: null,
49
+ actions: null,
50
+ source: null,
51
+ referrer: null
52
+ )
53
+ ```
26
54
 
data/docs/SubmissionAction.md CHANGED
@@ -1,13 +1,28 @@
1
1
  # DocSpring::SubmissionAction
2
2
 
3
3
  ## Properties
4
- Name | Type | Description | Notes
5
- ------------ | ------------- | ------------- | -------------
6
- **id** | **String** | |
7
- **integration_id** | **String** | |
8
- **state** | **String** | |
9
- **action_category** | **String** | |
10
- **action_type** | **String** | |
11
- **result_data** | **Object** | |
12
4
 
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **id** | **String** | | |
8
+ | **integration_id** | **String** | | |
9
+ | **state** | **String** | | |
10
+ | **action_category** | **String** | | |
11
+ | **action_type** | **String** | | |
12
+ | **result_data** | **Object** | | |
13
+
14
+ ## Example
15
+
16
+ ```ruby
17
+ require 'docspring'
18
+
19
+ instance = DocSpring::SubmissionAction.new(
20
+ id: null,
21
+ integration_id: null,
22
+ state: null,
23
+ action_category: null,
24
+ action_type: null,
25
+ result_data: null
26
+ )
27
+ ```
13
28
 
data/docs/SubmissionBatch.md CHANGED
@@ -1,16 +1,34 @@
1
1
  # DocSpring::SubmissionBatch
2
2
 
3
3
  ## Properties
4
- Name | Type | Description | Notes
5
- ------------ | ------------- | ------------- | -------------
6
- **pending_count** | **Integer** | | [optional]
7
- **completion_percentage** | **Integer** | | [optional]
8
- **metadata** | **Object** | | [optional]
9
- **total_count** | **Integer** | | [optional]
10
- **submissions** | [**Array<Submission>**](Submission.md) | | [optional]
11
- **processed_at** | **String** | | [optional]
12
- **id** | **String** | | [optional]
13
- **state** | **String** | | [optional]
14
- **error_count** | **Integer** | | [optional]
15
4
 
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **id** | **String** | | |
8
+ | **total_count** | **Integer** | | |
9
+ | **pending_count** | **Integer** | | |
10
+ | **error_count** | **Integer** | | |
11
+ | **completion_percentage** | **Integer** | | |
12
+ | **state** | **String** | | |
13
+ | **processed_at** | **String** | | |
14
+ | **metadata** | **Object** | | |
15
+ | **submissions** | [**Array<Submission>**](Submission.md) | | [optional] |
16
+
17
+ ## Example
18
+
19
+ ```ruby
20
+ require 'docspring'
21
+
22
+ instance = DocSpring::SubmissionBatch.new(
23
+ id: null,
24
+ total_count: null,
25
+ pending_count: null,
26
+ error_count: null,
27
+ completion_percentage: null,
28
+ state: null,
29
+ processed_at: null,
30
+ metadata: null,
31
+ submissions: null
32
+ )
33
+ ```
16
34
 
data/docs/SubmissionBatchData.md CHANGED
@@ -1,11 +1,26 @@
1
1
  # DocSpring::SubmissionBatchData
2
2
 
3
3
  ## Properties
4
- Name | Type | Description | Notes
5
- ------------ | ------------- | ------------- | -------------
6
- **metadata** | **Object** | | [optional]
7
- **submissions** | [**Array<SubmissionDataBatchRequest>**](SubmissionDataBatchRequest.md) | |
8
- **template_id** | **String** | | [optional]
9
- **test** | **BOOLEAN** | | [optional]
10
4
 
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **metadata** | **Object** | | [optional] |
8
+ | **submissions** | [**Array<SubmissionDataBatchRequest>**](SubmissionDataBatchRequest.md) | | |
9
+ | **template_id** | **String** | | [optional] |
10
+ | **template_version** | **String** | | [optional] |
11
+ | **test** | **Boolean** | | [optional] |
12
+
13
+ ## Example
14
+
15
+ ```ruby
16
+ require 'docspring'
17
+
18
+ instance = DocSpring::SubmissionBatchData.new(
19
+ metadata: null,
20
+ submissions: null,
21
+ template_id: null,
22
+ template_version: null,
23
+ test: null
24
+ )
25
+ ```
11
26
 
data/docs/SubmissionData.md CHANGED
@@ -1,15 +1,28 @@
1
1
  # DocSpring::SubmissionData
2
2
 
3
3
  ## Properties
4
- Name | Type | Description | Notes
5
- ------------ | ------------- | ------------- | -------------
6
- **css** | **String** | | [optional]
7
- **data** | **Object** | |
8
- **data_requests** | [**Array<CreateSubmissionDataRequestData>**](CreateSubmissionDataRequestData.md) | | [optional]
9
- **field_overrides** | **Object** | | [optional]
10
- **html** | **String** | | [optional]
11
- **metadata** | **Object** | | [optional]
12
- **password** | **String** | | [optional]
13
- **test** | **BOOLEAN** | | [optional]
14
4
 
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **css** | **String** | | [optional] |
8
+ | **data** | **Object** | | |
9
+ | **data_requests** | [**Array<CreateSubmissionDataRequestData>**](CreateSubmissionDataRequestData.md) | | [optional] |
10
+ | **html** | **String** | | [optional] |
11
+ | **metadata** | **Object** | | [optional] |
12
+ | **test** | **Boolean** | | [optional] |
13
+
14
+ ## Example
15
+
16
+ ```ruby
17
+ require 'docspring'
18
+
19
+ instance = DocSpring::SubmissionData.new(
20
+ css: null,
21
+ data: null,
22
+ data_requests: null,
23
+ html: null,
24
+ metadata: null,
25
+ test: null
26
+ )
27
+ ```
15
28
 
data/docs/SubmissionDataBatchRequest.md CHANGED
@@ -1,13 +1,30 @@
1
1
  # DocSpring::SubmissionDataBatchRequest
2
2
 
3
3
  ## Properties
4
- Name | Type | Description | Notes
5
- ------------ | ------------- | ------------- | -------------
6
- **css** | **String** | | [optional]
7
- **metadata** | **Object** | | [optional]
8
- **data** | **Object** | | [optional]
9
- **test** | **BOOLEAN** | | [optional]
10
- **html** | **String** | | [optional]
11
- **template_id** | **String** | | [optional]
12
4
 
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **css** | **String** | | [optional] |
8
+ | **data** | **Object** | | |
9
+ | **html** | **String** | | [optional] |
10
+ | **metadata** | **Object** | | [optional] |
11
+ | **template_id** | **String** | | |
12
+ | **template_version** | **String** | | [optional] |
13
+ | **test** | **Boolean** | | [optional] |
14
+
15
+ ## Example
16
+
17
+ ```ruby
18
+ require 'docspring'
19
+
20
+ instance = DocSpring::SubmissionDataBatchRequest.new(
21
+ css: null,
22
+ data: null,
23
+ html: null,
24
+ metadata: null,
25
+ template_id: null,
26
+ template_version: null,
27
+ test: null
28
+ )
29
+ ```
13
30
 
data/docs/SubmissionDataRequest.md CHANGED
@@ -1,27 +1,58 @@
1
1
  # DocSpring::SubmissionDataRequest
2
2
 
3
3
  ## Properties
4
- Name | Type | Description | Notes
5
- ------------ | ------------- | ------------- | -------------
6
- **id** | **String** | |
7
- **name** | **String** | |
8
- **email** | **String** | |
9
- **order** | **Integer** | |
10
- **sort_order** | **Integer** | |
11
- **fields** | **Array<String>** | |
12
- **metadata** | **Object** | |
13
- **state** | **String** | |
14
- **viewed_at** | **String** | | [optional]
15
- **completed_at** | **String** | | [optional]
16
- **auth_type** | **String** | | [optional]
17
- **auth_second_factor_type** | **String** | | [optional]
18
- **auth_provider** | **String** | | [optional]
19
- **auth_session_started_at** | **String** | | [optional]
20
- **auth_session_id_hash** | **String** | | [optional]
21
- **auth_user_id_hash** | **String** | | [optional]
22
- **auth_username_hash** | **String** | | [optional]
23
- **auth_phone_number_hash** | **String** | | [optional]
24
- **ip_address** | **String** | | [optional]
25
- **user_agent** | **String** | | [optional]
26
4
 
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **id** | **String** | | |
8
+ | **submission_id** | **String** | | [optional] |
9
+ | **name** | **String** | | |
10
+ | **email** | **String** | | |
11
+ | **order** | **Integer** | | |
12
+ | **sort_order** | **Integer** | | |
13
+ | **fields** | **Array<String>** | | |
14
+ | **metadata** | **Object** | | |
15
+ | **state** | **String** | | |
16
+ | **viewed_at** | **String** | | [optional] |
17
+ | **completed_at** | **String** | | [optional] |
18
+ | **auth_type** | **String** | | [optional] |
19
+ | **auth_second_factor_type** | **String** | | [optional] |
20
+ | **auth_provider** | **String** | | [optional] |
21
+ | **auth_session_started_at** | **String** | | [optional] |
22
+ | **auth_session_id_hash** | **String** | | [optional] |
23
+ | **auth_user_id_hash** | **String** | | [optional] |
24
+ | **auth_username_hash** | **String** | | [optional] |
25
+ | **auth_phone_number_hash** | **String** | | [optional] |
26
+ | **ip_address** | **String** | | [optional] |
27
+ | **user_agent** | **String** | | [optional] |
28
+
29
+ ## Example
30
+
31
+ ```ruby
32
+ require 'docspring'
33
+
34
+ instance = DocSpring::SubmissionDataRequest.new(
35
+ id: null,
36
+ submission_id: null,
37
+ name: null,
38
+ email: null,
39
+ order: null,
40
+ sort_order: null,
41
+ fields: null,
42
+ metadata: null,
43
+ state: null,
44
+ viewed_at: null,
45
+ completed_at: null,
46
+ auth_type: null,
47
+ auth_second_factor_type: null,
48
+ auth_provider: null,
49
+ auth_session_started_at: null,
50
+ auth_session_id_hash: null,
51
+ auth_user_id_hash: null,
52
+ auth_username_hash: null,
53
+ auth_phone_number_hash: null,
54
+ ip_address: null,
55
+ user_agent: null
56
+ )
57
+ ```
27
58
 
data/docs/SubmissionDataRequestEvent.md ADDED
@@ -0,0 +1,30 @@
1
+ # DocSpring::SubmissionDataRequestEvent
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **id** | **String** | | |
8
+ | **submission_id** | **String** | | |
9
+ | **submission_data_request_id** | **String** | | |
10
+ | **event_type** | **String** | | |
11
+ | **message_type** | **String** | | |
12
+ | **message_recipient** | **String** | | |
13
+ | **occurred_at** | **String** | | |
14
+
15
+ ## Example
16
+
17
+ ```ruby
18
+ require 'docspring'
19
+
20
+ instance = DocSpring::SubmissionDataRequestEvent.new(
21
+ id: null,
22
+ submission_id: null,
23
+ submission_data_request_id: null,
24
+ event_type: null,
25
+ message_type: null,
26
+ message_recipient: null,
27
+ occurred_at: null
28
+ )
29
+ ```
30
+