docspring 1.4.0 → 2.0.0

Sign up to get free protection for your applications and to get access to all the features.
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
data/docs/Template.md CHANGED
@@ -1,27 +1,56 @@
1
1
  # DocSpring::Template
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
- **permanent_document_url** | **String** | | [optional]
20
- **template_type** | **String** | | [optional]
21
- **id** | **String** | | [optional]
22
- **page_dimensions** | **Array<Array<Float>>** | | [optional]
23
- **locked** | **BOOLEAN** | | [optional]
24
- **redirect_url** | **String** | | [optional]
25
- **document_url** | **String** | | [optional]
26
4
 
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **name** | **String** | | |
8
+ | **description** | **String** | | |
9
+ | **public_web_form** | **Boolean** | | |
10
+ | **public_submissions** | **Boolean** | | |
11
+ | **expire_submissions** | **Boolean** | | |
12
+ | **expire_after** | **Float** | | |
13
+ | **expiration_interval** | **String** | | |
14
+ | **allow_additional_properties** | **Boolean** | | |
15
+ | **editable_submissions** | **Boolean** | | |
16
+ | **locked** | **Boolean** | | |
17
+ | **webhook_url** | **String** | | |
18
+ | **slack_webhook_url** | **String** | | |
19
+ | **redirect_url** | **String** | | |
20
+ | **id** | **String** | | |
21
+ | **template_type** | **String** | | |
22
+ | **page_dimensions** | **Array<Array<Float>>** | | |
23
+ | **document_url** | **String** | | |
24
+ | **permanent_document_url** | **String** | | |
25
+ | **path** | **String** | | |
26
+ | **parent_folder_id** | **String** | | |
27
+
28
+ ## Example
29
+
30
+ ```ruby
31
+ require 'docspring'
32
+
33
+ instance = DocSpring::Template.new(
34
+ name: null,
35
+ description: null,
36
+ public_web_form: null,
37
+ public_submissions: null,
38
+ expire_submissions: null,
39
+ expire_after: null,
40
+ expiration_interval: null,
41
+ allow_additional_properties: null,
42
+ editable_submissions: null,
43
+ locked: null,
44
+ webhook_url: null,
45
+ slack_webhook_url: null,
46
+ redirect_url: null,
47
+ id: null,
48
+ template_type: null,
49
+ page_dimensions: null,
50
+ document_url: null,
51
+ permanent_document_url: null,
52
+ path: null,
53
+ parent_folder_id: null
54
+ )
55
+ ```
27
56
 
data/docs/TemplateData.md CHANGED
@@ -1,23 +1,54 @@
1
1
  # DocSpring::TemplateData
2
2
 
3
3
  ## Properties
4
- Name | Type | Description | Notes
5
- ------------ | ------------- | ------------- | -------------
6
- **expiration_interval** | **String** | | [optional]
7
- **webhook_url** | **String** | | [optional]
8
- **scss** | **String** | | [optional]
9
- **allow_additional_properties** | **BOOLEAN** | | [optional]
10
- **expire_after** | **Float** | | [optional]
11
- **description** | **String** | | [optional]
12
- **public_submissions** | **BOOLEAN** | | [optional]
13
- **slack_webhook_url** | **String** | | [optional]
14
- **header_html** | **String** | | [optional]
15
- **public_web_form** | **BOOLEAN** | | [optional]
16
- **editable_submissions** | **BOOLEAN** | | [optional]
17
- **expire_submissions** | **BOOLEAN** | | [optional]
18
- **name** | **String** | | [optional]
19
- **footer_html** | **String** | | [optional]
20
- **html** | **String** | | [optional]
21
- **redirect_url** | **String** | | [optional]
22
4
 
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **add_data_request_submission_id_footers** | **Boolean** | | [optional] |
8
+ | **allow_additional_properties** | **Boolean** | | [optional] |
9
+ | **description** | **String** | | [optional] |
10
+ | **editable_submissions** | **Boolean** | | [optional] |
11
+ | **expiration_interval** | **String** | | [optional] |
12
+ | **expire_after** | **Float** | | [optional] |
13
+ | **expire_submissions** | **Boolean** | | [optional] |
14
+ | **footer_html** | **String** | | [optional] |
15
+ | **header_html** | **String** | | [optional] |
16
+ | **html** | **String** | | [optional] |
17
+ | **merge_audit_trail_pdf** | **Boolean** | | [optional] |
18
+ | **name** | **String** | | [optional] |
19
+ | **public_submissions** | **Boolean** | | [optional] |
20
+ | **public_web_form** | **Boolean** | | [optional] |
21
+ | **redirect_url** | **String** | | [optional] |
22
+ | **scss** | **String** | | [optional] |
23
+ | **slack_webhook_url** | **String** | | [optional] |
24
+ | **webhook_options** | [**HtmlTemplateDataWebhookOptions**](HtmlTemplateDataWebhookOptions.md) | | [optional] |
25
+ | **webhook_url** | **String** | | [optional] |
26
+
27
+ ## Example
28
+
29
+ ```ruby
30
+ require 'docspring'
31
+
32
+ instance = DocSpring::TemplateData.new(
33
+ add_data_request_submission_id_footers: null,
34
+ allow_additional_properties: null,
35
+ description: null,
36
+ editable_submissions: null,
37
+ expiration_interval: null,
38
+ expire_after: null,
39
+ expire_submissions: null,
40
+ footer_html: null,
41
+ header_html: null,
42
+ html: null,
43
+ merge_audit_trail_pdf: null,
44
+ name: null,
45
+ public_submissions: null,
46
+ public_web_form: null,
47
+ redirect_url: null,
48
+ scss: null,
49
+ slack_webhook_url: null,
50
+ webhook_options: null,
51
+ webhook_url: null
52
+ )
53
+ ```
23
54
 
data/docs/TemplateDefaults.md ADDED
@@ -0,0 +1,22 @@
1
+ # DocSpring::TemplateDefaults
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **color** | **String** | | |
8
+ | **font_size** | **Float** | | |
9
+ | **typeface** | **String** | | |
10
+
11
+ ## Example
12
+
13
+ ```ruby
14
+ require 'docspring'
15
+
16
+ instance = DocSpring::TemplateDefaults.new(
17
+ color: null,
18
+ font_size: null,
19
+ typeface: null
20
+ )
21
+ ```
22
+
data/docs/TemplateDocument.md ADDED
@@ -0,0 +1,22 @@
1
+ # DocSpring::TemplateDocument
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **id** | **String** | | |
8
+ | **metadata** | [**TemplateDocumentMetadata**](TemplateDocumentMetadata.md) | | |
9
+ | **storage** | **String** | | |
10
+
11
+ ## Example
12
+
13
+ ```ruby
14
+ require 'docspring'
15
+
16
+ instance = DocSpring::TemplateDocument.new(
17
+ id: null,
18
+ metadata: null,
19
+ storage: null
20
+ )
21
+ ```
22
+
data/docs/TemplateDocumentMetadata.md ADDED
@@ -0,0 +1,22 @@
1
+ # DocSpring::TemplateDocumentMetadata
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **filename** | **String** | | |
8
+ | **mime_type** | **String** | | |
9
+ | **size** | **Integer** | | |
10
+
11
+ ## Example
12
+
13
+ ```ruby
14
+ require 'docspring'
15
+
16
+ instance = DocSpring::TemplateDocumentMetadata.new(
17
+ filename: null,
18
+ mime_type: null,
19
+ size: null
20
+ )
21
+ ```
22
+
data/docs/TemplateSchema.md ADDED
@@ -0,0 +1,34 @@
1
+ # DocSpring::TemplateSchema
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **schema** | **String** | | [optional] |
8
+ | **id** | **String** | | [optional] |
9
+ | **title** | **String** | | [optional] |
10
+ | **description** | **String** | | [optional] |
11
+ | **definitions** | **Object** | | [optional] |
12
+ | **type** | **String** | | [optional] |
13
+ | **properties** | **Object** | | [optional] |
14
+ | **additional_properties** | **Boolean** | | [optional] |
15
+ | **required** | **Array<String>** | | [optional] |
16
+
17
+ ## Example
18
+
19
+ ```ruby
20
+ require 'docspring'
21
+
22
+ instance = DocSpring::TemplateSchema.new(
23
+ schema: null,
24
+ id: null,
25
+ title: null,
26
+ description: null,
27
+ definitions: null,
28
+ type: null,
29
+ properties: null,
30
+ additional_properties: null,
31
+ required: null
32
+ )
33
+ ```
34
+
data/docs/UpdateDataRequestResponse.md CHANGED
@@ -1,10 +1,22 @@
1
1
  # DocSpring::UpdateDataRequestResponse
2
2
 
3
3
  ## Properties
4
- Name | Type | Description | Notes
5
- ------------ | ------------- | ------------- | -------------
6
- **data_request** | [**SubmissionDataRequest**](SubmissionDataRequest.md) | | [optional]
7
- **errors** | **Array<String>** | | [optional]
8
- **status** | **String** | | [optional]
9
4
 
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **status** | **String** | | |
8
+ | **errors** | **Array<String>** | | [optional] |
9
+ | **data_request** | [**SubmissionDataRequest**](SubmissionDataRequest.md) | | |
10
+
11
+ ## Example
12
+
13
+ ```ruby
14
+ require 'docspring'
15
+
16
+ instance = DocSpring::UpdateDataRequestResponse.new(
17
+ status: null,
18
+ errors: null,
19
+ data_request: null
20
+ )
21
+ ```
10
22
 
data/docs/UpdateSubmissionDataRequestData.md CHANGED
@@ -1,20 +1,42 @@
1
1
  # DocSpring::UpdateSubmissionDataRequestData
2
2
 
3
3
  ## Properties
4
- Name | Type | Description | Notes
5
- ------------ | ------------- | ------------- | -------------
6
- **auth_phone_number_hash** | **String** | | [optional]
7
- **auth_provider** | **String** | | [optional]
8
- **auth_second_factor_type** | **String** | | [optional]
9
- **auth_session_id_hash** | **String** | | [optional]
10
- **auth_session_started_at** | **String** | | [optional]
11
- **auth_type** | **String** | | [optional]
12
- **auth_user_id_hash** | **String** | | [optional]
13
- **auth_username_hash** | **String** | | [optional]
14
- **email** | **String** | | [optional]
15
- **fields** | **Array<String>** | | [optional]
16
- **metadata** | **Object** | | [optional]
17
- **name** | **String** | | [optional]
18
- **order** | **Integer** | | [optional]
19
4
 
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **auth_phone_number_hash** | **String** | | [optional] |
8
+ | **auth_provider** | **String** | | [optional] |
9
+ | **auth_second_factor_type** | **String** | | [optional] |
10
+ | **auth_session_id_hash** | **String** | | [optional] |
11
+ | **auth_session_started_at** | **String** | | [optional] |
12
+ | **auth_type** | **String** | | [optional] |
13
+ | **auth_user_id_hash** | **String** | | [optional] |
14
+ | **auth_username_hash** | **String** | | [optional] |
15
+ | **email** | **String** | | [optional] |
16
+ | **fields** | **Array<String>** | | [optional] |
17
+ | **metadata** | **Object** | | [optional] |
18
+ | **name** | **String** | | [optional] |
19
+ | **order** | **Integer** | | [optional] |
20
+
21
+ ## Example
22
+
23
+ ```ruby
24
+ require 'docspring'
25
+
26
+ instance = DocSpring::UpdateSubmissionDataRequestData.new(
27
+ auth_phone_number_hash: null,
28
+ auth_provider: null,
29
+ auth_second_factor_type: null,
30
+ auth_session_id_hash: null,
31
+ auth_session_started_at: null,
32
+ auth_type: null,
33
+ auth_user_id_hash: null,
34
+ auth_username_hash: null,
35
+ email: null,
36
+ fields: null,
37
+ metadata: null,
38
+ name: null,
39
+ order: null
40
+ )
41
+ ```
20
42
 
data/docs/UpdateTemplateData.md CHANGED
@@ -1,8 +1,18 @@
1
1
  # DocSpring::UpdateTemplateData
2
2
 
3
3
  ## Properties
4
- Name | Type | Description | Notes
5
- ------------ | ------------- | ------------- | -------------
6
- **template** | [**TemplateData**](TemplateData.md) | |
7
4
 
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **template** | [**TemplateData**](TemplateData.md) | | |
8
+
9
+ ## Example
10
+
11
+ ```ruby
12
+ require 'docspring'
13
+
14
+ instance = DocSpring::UpdateTemplateData.new(
15
+ template: null
16
+ )
17
+ ```
8
18
 
data/docs/UpdateTemplateResponse.md CHANGED
@@ -1,9 +1,20 @@
1
1
  # DocSpring::UpdateTemplateResponse
2
2
 
3
3
  ## Properties
4
- Name | Type | Description | Notes
5
- ------------ | ------------- | ------------- | -------------
6
- **errors** | **Array<String>** | | [optional]
7
- **status** | **String** | | [optional]
8
4
 
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **status** | **String** | | |
8
+ | **errors** | **Array<String>** | | [optional] |
9
+
10
+ ## Example
11
+
12
+ ```ruby
13
+ require 'docspring'
14
+
15
+ instance = DocSpring::UpdateTemplateResponse.new(
16
+ status: null,
17
+ errors: null
18
+ )
19
+ ```
9
20
 
data/docs/UploadPresign.md ADDED
@@ -0,0 +1,24 @@
1
+ # DocSpring::UploadPresign
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **fields** | **Object** | | |
8
+ | **headers** | **Object** | | |
9
+ | **url** | **String** | | |
10
+ | **method** | **String** | | [optional] |
11
+
12
+ ## Example
13
+
14
+ ```ruby
15
+ require 'docspring'
16
+
17
+ instance = DocSpring::UploadPresign.new(
18
+ fields: null,
19
+ headers: null,
20
+ url: null,
21
+ method: null
22
+ )
23
+ ```
24
+
data/docs/UploadTemplateData.md CHANGED
@@ -1,25 +1,58 @@
1
1
  # DocSpring::UploadTemplateData
2
2
 
3
3
  ## Properties
4
- Name | Type | Description | Notes
5
- ------------ | ------------- | ------------- | -------------
6
- **expiration_interval** | **String** | | [optional]
7
- **webhook_url** | **String** | | [optional]
8
- **scss** | **String** | | [optional]
9
- **allow_additional_properties** | **BOOLEAN** | | [optional]
10
- **document** | [**UploadTemplateDataDocument**](UploadTemplateDataDocument.md) | | [optional]
11
- **expire_after** | **Float** | | [optional]
12
- **description** | **String** | | [optional]
13
- **public_submissions** | **BOOLEAN** | | [optional]
14
- **slack_webhook_url** | **String** | | [optional]
15
- **header_html** | **String** | | [optional]
16
- **public_web_form** | **BOOLEAN** | | [optional]
17
- **editable_submissions** | **BOOLEAN** | | [optional]
18
- **expire_submissions** | **BOOLEAN** | | [optional]
19
- **name** | **String** | | [optional]
20
- **footer_html** | **String** | | [optional]
21
- **html** | **String** | | [optional]
22
- **template_type** | **String** | | [optional]
23
- **redirect_url** | **String** | | [optional]
24
4
 
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **add_data_request_submission_id_footers** | **Boolean** | | [optional] |
8
+ | **allow_additional_properties** | **Boolean** | | [optional] |
9
+ | **description** | **String** | | [optional] |
10
+ | **document** | [**TemplateDocument**](TemplateDocument.md) | | [optional] |
11
+ | **editable_submissions** | **Boolean** | | [optional] |
12
+ | **expiration_interval** | **String** | | [optional] |
13
+ | **expire_after** | **Float** | | [optional] |
14
+ | **expire_submissions** | **Boolean** | | [optional] |
15
+ | **footer_html** | **String** | | [optional] |
16
+ | **header_html** | **String** | | [optional] |
17
+ | **html** | **String** | | [optional] |
18
+ | **merge_audit_trail_pdf** | **Boolean** | | [optional] |
19
+ | **name** | **String** | | |
20
+ | **public_submissions** | **Boolean** | | [optional] |
21
+ | **public_web_form** | **Boolean** | | [optional] |
22
+ | **redirect_url** | **String** | | [optional] |
23
+ | **scss** | **String** | | [optional] |
24
+ | **slack_webhook_url** | **String** | | [optional] |
25
+ | **template_type** | **String** | | [optional] |
26
+ | **webhook_options** | [**HtmlTemplateDataWebhookOptions**](HtmlTemplateDataWebhookOptions.md) | | [optional] |
27
+ | **webhook_url** | **String** | | [optional] |
28
+
29
+ ## Example
30
+
31
+ ```ruby
32
+ require 'docspring'
33
+
34
+ instance = DocSpring::UploadTemplateData.new(
35
+ add_data_request_submission_id_footers: null,
36
+ allow_additional_properties: null,
37
+ description: null,
38
+ document: null,
39
+ editable_submissions: null,
40
+ expiration_interval: null,
41
+ expire_after: null,
42
+ expire_submissions: null,
43
+ footer_html: null,
44
+ header_html: null,
45
+ html: null,
46
+ merge_audit_trail_pdf: null,
47
+ name: null,
48
+ public_submissions: null,
49
+ public_web_form: null,
50
+ redirect_url: null,
51
+ scss: null,
52
+ slack_webhook_url: null,
53
+ template_type: null,
54
+ webhook_options: null,
55
+ webhook_url: null
56
+ )
57
+ ```
25
58
 
data/docspring.gemspec CHANGED
@@ -5,10 +5,10 @@
5
5
 
6
6
  #DocSpring is a service that helps you fill out and sign PDF templates.
7
7
 
8
- OpenAPI spec version: v1
8
+ The version of the OpenAPI document: v1
9
9
 
10
10
  Generated by: https://openapi-generator.tech
11
- OpenAPI Generator version: 3.3.0
11
+ Generator version: 7.11.0
12
12
 
13
13
  =end
14
14
 
@@ -24,23 +24,26 @@ Gem::Specification.new do |s|
24
24
  s.homepage = "https://github.com/DocSpring/docspring-ruby"
25
25
  s.summary = "DocSpring API Client"
26
26
  s.description = "Client library for the DocSpring PDF generation and e-signature service"
27
- s.license = 'MIT'
28
- s.required_ruby_version = ">= 1.9"
27
+ s.license = "MIT"
28
+ s.required_ruby_version = ">= 2.7"
29
+ s.metadata = {}
29
30
 
30
31
  s.add_runtime_dependency 'typhoeus', '~> 1.0', '>= 1.0.1'
31
- s.add_runtime_dependency 'ffi', '~> 1.0', '>= 1.9.24'
32
- s.add_runtime_dependency 'json', '>= 1.8'
33
32
 
34
- s.add_development_dependency 'rspec', '~> 3.6', '>= 3.6.0'
33
+ # <--------------- BEGIN DOCSPRING CUSTOMIZATION ----------------->
34
+ # Description: Add json as a runtime dependency, and vcr and webmock as development dependencies
35
+ s.add_runtime_dependency 'json', '>= 1.8'
35
36
  s.add_development_dependency 'vcr', '~> 3.0', '>= 3.0.1'
36
37
  s.add_development_dependency 'webmock', '~> 1.24', '>= 1.24.3'
37
- s.add_development_dependency 'autotest', '~> 4.4', '>= 4.4.6'
38
- s.add_development_dependency 'autotest-rails-pure', '~> 4.1', '>= 4.1.2'
39
- s.add_development_dependency 'autotest-growl', '~> 0.2', '>= 0.2.16'
38
+ # <--------------- END DOCSPRING CUSTOMIZATION ----------------->
39
+
40
+ s.add_development_dependency 'rspec', '~> 3.6', '>= 3.6.0'
40
41
 
41
- # Use git ls-files to ignore anything in .gitignore
42
+ # <--------------- BEGIN DOCSPRING CUSTOMIZATION ----------------->
43
+ # Description: Use git ls-files instead of find to ignore anything in .gitignore
42
44
  s.files = `git ls-files`.split("\n").uniq.sort.select{|f| !f.empty? }
43
45
  s.test_files = `git ls-files spec test`.split("\n")
46
+ # <--------------- END DOCSPRING CUSTOMIZATION ----------------->
44
47
  s.executables = []
45
48
  s.require_paths = ["lib"]
46
49
  end
data/git_push.sh CHANGED
@@ -1,14 +1,17 @@
1
1
  #!/bin/sh
2
- #
3
- # Generated by: https://openapi-generator.tech
4
- #
5
2
  # ref: https://help.github.com/articles/adding-an-existing-project-to-github-using-the-command-line/
6
3
  #
7
- # Usage example: /bin/sh ./git_push.sh wing328 openapi-pestore-perl "minor update"
4
+ # Usage example: /bin/sh ./git_push.sh wing328 openapi-petstore-perl "minor update" "gitlab.com"
8
5
 
9
6
  git_user_id=$1
10
7
  git_repo_id=$2
11
8
  release_note=$3
9
+ git_host=$4
10
+
11
+ if [ "$git_host" = "" ]; then
12
+ git_host="github.com"
13
+ echo "[INFO] No command line input provided. Set \$git_host to $git_host"
14
+ fi
12
15
 
13
16
  if [ "$git_user_id" = "" ]; then
14
17
  git_user_id="GIT_USER_ID"
@@ -35,14 +38,14 @@ git add .
35
38
  git commit -m "$release_note"
36
39
 
37
40
  # Sets the new remote
38
- git_remote=`git remote`
41
+ git_remote=$(git remote)
39
42
  if [ "$git_remote" = "" ]; then # git remote not defined
40
43
 
41
44
  if [ "$GIT_TOKEN" = "" ]; then
42
45
  echo "[INFO] \$GIT_TOKEN (environment variable) is not set. Using the git credential in your environment."
43
- git remote add origin https://github.com/${git_user_id}/${git_repo_id}.git
46
+ git remote add origin https://${git_host}/${git_user_id}/${git_repo_id}.git
44
47
  else
45
- git remote add origin https://${git_user_id}:${GIT_TOKEN}@github.com/${git_user_id}/${git_repo_id}.git
48
+ git remote add origin https://${git_user_id}:"${GIT_TOKEN}"@${git_host}/${git_user_id}/${git_repo_id}.git
46
49
  fi
47
50
 
48
51
  fi
@@ -50,6 +53,5 @@ fi
50
53
  git pull origin master
51
54
 
52
55
  # Pushes (Forces) the changes in the local repository up to the remote repository
53
- echo "Git pushing to https://github.com/${git_user_id}/${git_repo_id}.git"
56
+ echo "Git pushing to https://${git_host}/${git_user_id}/${git_repo_id}.git"
54
57
  git push origin master 2>&1 | grep -v 'To https'
55
-