docspring 1.0.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (150) hide show
  1. checksums.yaml +7 -0
  2. data/.gitignore +39 -0
  3. data/.openapi-generator-ignore +23 -0
  4. data/.openapi-generator/VERSION +1 -0
  5. data/.rspec +2 -0
  6. data/.rubocop.yml +154 -0
  7. data/.swagger-codegen-ignore +31 -0
  8. data/.swagger-codegen/VERSION +1 -0
  9. data/.swagger-revision +1 -0
  10. data/.travis.yml +8 -0
  11. data/CHANGELOG.md +48 -0
  12. data/Gemfile +8 -0
  13. data/Gemfile.lock +80 -0
  14. data/LICENSE +7 -0
  15. data/README.md +162 -0
  16. data/Rakefile +10 -0
  17. data/docs/AuthenticationError.md +9 -0
  18. data/docs/AuthenticationSuccessResponse.md +8 -0
  19. data/docs/CombinePdfsData.md +12 -0
  20. data/docs/CombinedSubmission.md +16 -0
  21. data/docs/CombinedSubmissionAction.md +13 -0
  22. data/docs/CombinedSubmissionData.md +11 -0
  23. data/docs/CreateCombinedSubmissionResponse.md +10 -0
  24. data/docs/CreateCustomFileData.md +8 -0
  25. data/docs/CreateCustomFileResponse.md +10 -0
  26. data/docs/CreateFolderData.md +8 -0
  27. data/docs/CreateSubmissionBatchResponse.md +12 -0
  28. data/docs/CreateSubmissionBatchSubmissionsResponse.md +10 -0
  29. data/docs/CreateSubmissionDataRequestData.md +20 -0
  30. data/docs/CreateSubmissionDataRequestTokenResponse.md +10 -0
  31. data/docs/CreateSubmissionDataRequestTokenResponseToken.md +11 -0
  32. data/docs/CreateSubmissionResponse.md +10 -0
  33. data/docs/CreateTemplateData.md +8 -0
  34. data/docs/CustomFile.md +9 -0
  35. data/docs/Error.md +9 -0
  36. data/docs/Folder.md +11 -0
  37. data/docs/FoldersFolder.md +9 -0
  38. data/docs/InvalidRequest.md +9 -0
  39. data/docs/MoveFolderData.md +8 -0
  40. data/docs/MoveTemplateData.md +8 -0
  41. data/docs/PDFApi.md +1385 -0
  42. data/docs/PendingTemplate.md +22 -0
  43. data/docs/RenameFolderData.md +8 -0
  44. data/docs/Submission.md +21 -0
  45. data/docs/SubmissionAction.md +13 -0
  46. data/docs/SubmissionBatch.md +16 -0
  47. data/docs/SubmissionBatchData.md +11 -0
  48. data/docs/SubmissionData.md +13 -0
  49. data/docs/SubmissionDataBatchRequest.md +13 -0
  50. data/docs/SubmissionDataRequest.md +24 -0
  51. data/docs/Template.md +25 -0
  52. data/docs/Templatesv2Template.md +19 -0
  53. data/docs/Templatesv2TemplateDocument.md +10 -0
  54. data/docs/Templatesv2TemplateDocumentMetadata.md +10 -0
  55. data/docs/UpdateDataRequestResponse.md +10 -0
  56. data/docs/UpdateSubmissionDataRequestData.md +20 -0
  57. data/docspring.gemspec +47 -0
  58. data/git_push.sh +55 -0
  59. data/lib/docspring.rb +82 -0
  60. data/lib/docspring/api/client.rb +174 -0
  61. data/lib/docspring/api/pdf_api.rb +1481 -0
  62. data/lib/docspring/api_client.rb +406 -0
  63. data/lib/docspring/api_error.rb +38 -0
  64. data/lib/docspring/configuration.rb +230 -0
  65. data/lib/docspring/models/authentication_error.rb +231 -0
  66. data/lib/docspring/models/authentication_success_response.rb +217 -0
  67. data/lib/docspring/models/combine_pdfs_data.rb +226 -0
  68. data/lib/docspring/models/combined_submission.rb +295 -0
  69. data/lib/docspring/models/combined_submission_action.rb +316 -0
  70. data/lib/docspring/models/combined_submission_data.rb +217 -0
  71. data/lib/docspring/models/create_combined_submission_response.rb +237 -0
  72. data/lib/docspring/models/create_custom_file_data.rb +207 -0
  73. data/lib/docspring/models/create_custom_file_response.rb +237 -0
  74. data/lib/docspring/models/create_folder_data.rb +188 -0
  75. data/lib/docspring/models/create_submission_batch_response.rb +257 -0
  76. data/lib/docspring/models/create_submission_batch_submissions_response.rb +237 -0
  77. data/lib/docspring/models/create_submission_data_request_data.rb +339 -0
  78. data/lib/docspring/models/create_submission_data_request_token_response.rb +237 -0
  79. data/lib/docspring/models/create_submission_data_request_token_response_token.rb +210 -0
  80. data/lib/docspring/models/create_submission_response.rb +237 -0
  81. data/lib/docspring/models/create_template_data.rb +188 -0
  82. data/lib/docspring/models/custom_file.rb +192 -0
  83. data/lib/docspring/models/error.rb +236 -0
  84. data/lib/docspring/models/folder.rb +210 -0
  85. data/lib/docspring/models/folders_folder.rb +192 -0
  86. data/lib/docspring/models/invalid_request.rb +238 -0
  87. data/lib/docspring/models/move_folder_data.rb +183 -0
  88. data/lib/docspring/models/move_template_data.rb +183 -0
  89. data/lib/docspring/models/pending_template.rb +343 -0
  90. data/lib/docspring/models/rename_folder_data.rb +188 -0
  91. data/lib/docspring/models/submission.rb +358 -0
  92. data/lib/docspring/models/submission_action.rb +316 -0
  93. data/lib/docspring/models/submission_batch.rb +291 -0
  94. data/lib/docspring/models/submission_batch_data.rb +217 -0
  95. data/lib/docspring/models/submission_data.rb +235 -0
  96. data/lib/docspring/models/submission_data_batch_request.rb +228 -0
  97. data/lib/docspring/models/submission_data_request.rb +422 -0
  98. data/lib/docspring/models/template.rb +372 -0
  99. data/lib/docspring/models/templatesv2_template.rb +316 -0
  100. data/lib/docspring/models/templatesv2_template_document.rb +235 -0
  101. data/lib/docspring/models/templatesv2_template_document_metadata.rb +235 -0
  102. data/lib/docspring/models/update_data_request_response.rb +237 -0
  103. data/lib/docspring/models/update_submission_data_request_data.rb +339 -0
  104. data/lib/docspring/version.rb +15 -0
  105. data/spec/api/client_integration_spec.rb +259 -0
  106. data/spec/api/pdf_api_integration_spec.rb +377 -0
  107. data/spec/api/pdf_api_spec_original.skipped.rb +397 -0
  108. data/spec/api_client_spec.rb +226 -0
  109. data/spec/configuration_spec.rb +53 -0
  110. data/spec/models/authentication_error_spec.rb +51 -0
  111. data/spec/models/authentication_success_response_spec.rb +45 -0
  112. data/spec/models/combine_pdfs_data_spec.rb +65 -0
  113. data/spec/models/combined_submission_action_spec.rb +83 -0
  114. data/spec/models/combined_submission_data_spec.rb +59 -0
  115. data/spec/models/combined_submission_spec.rb +93 -0
  116. data/spec/models/create_combined_submission_response_spec.rb +57 -0
  117. data/spec/models/create_custom_file_data_spec.rb +41 -0
  118. data/spec/models/create_custom_file_response_spec.rb +57 -0
  119. data/spec/models/create_folder_data_spec.rb +41 -0
  120. data/spec/models/create_submission_batch_response_spec.rb +69 -0
  121. data/spec/models/create_submission_batch_submissions_response_spec.rb +57 -0
  122. data/spec/models/create_submission_data_request_data_spec.rb +121 -0
  123. data/spec/models/create_submission_data_request_token_response_spec.rb +57 -0
  124. data/spec/models/create_submission_data_request_token_response_token_spec.rb +59 -0
  125. data/spec/models/create_submission_response_spec.rb +57 -0
  126. data/spec/models/create_template_data_spec.rb +41 -0
  127. data/spec/models/custom_file_spec.rb +47 -0
  128. data/spec/models/error_spec.rb +51 -0
  129. data/spec/models/folder_spec.rb +59 -0
  130. data/spec/models/folders_folder_spec.rb +47 -0
  131. data/spec/models/invalid_request_spec.rb +51 -0
  132. data/spec/models/move_folder_data_spec.rb +41 -0
  133. data/spec/models/move_template_data_spec.rb +41 -0
  134. data/spec/models/pending_template_spec.rb +129 -0
  135. data/spec/models/rename_folder_data_spec.rb +41 -0
  136. data/spec/models/submission_action_spec.rb +83 -0
  137. data/spec/models/submission_batch_data_spec.rb +59 -0
  138. data/spec/models/submission_batch_spec.rb +93 -0
  139. data/spec/models/submission_data_batch_request_spec.rb +71 -0
  140. data/spec/models/submission_data_request_spec.rb +149 -0
  141. data/spec/models/submission_data_spec.rb +71 -0
  142. data/spec/models/submission_spec.rb +123 -0
  143. data/spec/models/template_spec.rb +147 -0
  144. data/spec/models/templatesv2_template_document_metadata_spec.rb +57 -0
  145. data/spec/models/templatesv2_template_document_spec.rb +57 -0
  146. data/spec/models/templatesv2_template_spec.rb +111 -0
  147. data/spec/models/update_data_request_response_spec.rb +57 -0
  148. data/spec/models/update_submission_data_request_data_spec.rb +121 -0
  149. data/spec/spec_helper.rb +117 -0
  150. metadata +430 -0
@@ -0,0 +1,7 @@
1
+ ---
2
+ SHA256:
3
+ metadata.gz: cee0ce15eabd610765888e637b1e86d2e597844224f000b91889e866b0a5a851
4
+ data.tar.gz: 5de24c41293961ac2fe26e0f3b863440aab35e6043f7cce350276515d94e2443
5
+ SHA512:
6
+ metadata.gz: a26e65e0212f2b7175e4b43aa3e896302419d0f00fc376cb545dd586492ef1355b3a30c1cdab948a57f52932281ad8311f568d5ba622b08bb679d58b094bb9ee
7
+ data.tar.gz: 80d79e2142642d96b72846ef6aaf22591b8ac393b5b0bf49884987e98672705bc312a2133d853335dfe6b2caf1dbffe0ae2108d140013b3db0697a6f5bb641d4
@@ -0,0 +1,39 @@
1
+ # Generated by: https://openapi-generator.tech
2
+ #
3
+
4
+ *.gem
5
+ *.rbc
6
+ /.config
7
+ /coverage/
8
+ /InstalledFiles
9
+ /pkg/
10
+ /spec/reports/
11
+ /spec/examples.txt
12
+ /test/tmp/
13
+ /test/version_tmp/
14
+ /tmp/
15
+
16
+ ## Specific to RubyMotion:
17
+ .dat*
18
+ .repl_history
19
+ build/
20
+
21
+ ## Documentation cache and generated files:
22
+ /.yardoc/
23
+ /_yardoc/
24
+ /doc/
25
+ /rdoc/
26
+
27
+ ## Environment normalization:
28
+ /.bundle/
29
+ /vendor/bundle
30
+ /lib/bundler/man/
31
+
32
+ # for a library or gem, you might want to ignore these files since the code is
33
+ # intended to run in multiple environments; otherwise, check them in:
34
+ # Gemfile.lock
35
+ # .ruby-version
36
+ # .ruby-gemset
37
+
38
+ # unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
39
+ .rvmrc
@@ -0,0 +1,23 @@
1
+ # OpenAPI Generator Ignore
2
+ # Generated by openapi-generator https://github.com/openapitools/openapi-generator
3
+
4
+ # Use this file to prevent files from being overwritten by the generator.
5
+ # The patterns follow closely to .gitignore or .dockerignore.
6
+
7
+ # As an example, the C# client generator defines ApiClient.cs.
8
+ # You can make changes and tell OpenAPI Generator to ignore just this file by uncommenting the following line:
9
+ #ApiClient.cs
10
+
11
+ # You can match any string of characters against a directory, file or extension with a single asterisk (*):
12
+ #foo/*/qux
13
+ # The above matches foo/bar/qux and foo/baz/qux, but not foo/bar/baz/qux
14
+
15
+ # You can recursively match patterns against a directory, file or extension with a double asterisk (**):
16
+ #foo/**/qux
17
+ # This matches foo/bar/qux, foo/baz/qux, and foo/bar/baz/qux
18
+
19
+ # You can also negate patterns with an exclamation (!).
20
+ # For example, you can ignore all files in a docs folder with the file extension .md:
21
+ #docs/*.md
22
+ # Then explicitly reverse the ignore rule for a single file:
23
+ #!docs/README.md
@@ -0,0 +1 @@
1
+ 3.3.0-SNAPSHOT
data/.rspec ADDED
@@ -0,0 +1,2 @@
1
+ --color
2
+ --require spec_helper
@@ -0,0 +1,154 @@
1
+ # This file is based on https://github.com/rails/rails/blob/master/.rubocop.yml (MIT license)
2
+ # Automatically generated by OpenAPI Generator (https://openapi-generator.tech)
3
+ AllCops:
4
+ TargetRubyVersion: 2.2
5
+ # RuboCop has a bunch of cops enabled by default. This setting tells RuboCop
6
+ # to ignore them, so only the ones explicitly set in this file are enabled.
7
+ DisabledByDefault: true
8
+ Exclude:
9
+ - '**/templates/**/*'
10
+ - '**/vendor/**/*'
11
+ - 'actionpack/lib/action_dispatch/journey/parser.rb'
12
+
13
+ # Prefer &&/|| over and/or.
14
+ Style/AndOr:
15
+ Enabled: true
16
+
17
+ # Do not use braces for hash literals when they are the last argument of a
18
+ # method call.
19
+ Style/BracesAroundHashParameters:
20
+ Enabled: true
21
+ EnforcedStyle: context_dependent
22
+
23
+ # Align `when` with `case`.
24
+ Layout/CaseIndentation:
25
+ Enabled: true
26
+
27
+ # Align comments with method definitions.
28
+ Layout/CommentIndentation:
29
+ Enabled: true
30
+
31
+ Layout/ElseAlignment:
32
+ Enabled: true
33
+
34
+ Layout/EmptyLineAfterMagicComment:
35
+ Enabled: true
36
+
37
+ # In a regular class definition, no empty lines around the body.
38
+ Layout/EmptyLinesAroundClassBody:
39
+ Enabled: true
40
+
41
+ # In a regular method definition, no empty lines around the body.
42
+ Layout/EmptyLinesAroundMethodBody:
43
+ Enabled: true
44
+
45
+ # In a regular module definition, no empty lines around the body.
46
+ Layout/EmptyLinesAroundModuleBody:
47
+ Enabled: true
48
+
49
+ Layout/FirstParameterIndentation:
50
+ Enabled: true
51
+
52
+ # Use Ruby >= 1.9 syntax for hashes. Prefer { a: :b } over { :a => :b }.
53
+ Style/HashSyntax:
54
+ Enabled: false
55
+
56
+ # Method definitions after `private` or `protected` isolated calls need one
57
+ # extra level of indentation.
58
+ Layout/IndentationConsistency:
59
+ Enabled: true
60
+ EnforcedStyle: rails
61
+
62
+ # Two spaces, no tabs (for indentation).
63
+ Layout/IndentationWidth:
64
+ Enabled: true
65
+
66
+ Layout/LeadingCommentSpace:
67
+ Enabled: true
68
+
69
+ Layout/SpaceAfterColon:
70
+ Enabled: true
71
+
72
+ Layout/SpaceAfterComma:
73
+ Enabled: true
74
+
75
+ Layout/SpaceAroundEqualsInParameterDefault:
76
+ Enabled: true
77
+
78
+ Layout/SpaceAroundKeyword:
79
+ Enabled: true
80
+
81
+ Layout/SpaceAroundOperators:
82
+ Enabled: true
83
+
84
+ Layout/SpaceBeforeComma:
85
+ Enabled: true
86
+
87
+ Layout/SpaceBeforeFirstArg:
88
+ Enabled: true
89
+
90
+ Style/DefWithParentheses:
91
+ Enabled: true
92
+
93
+ # Defining a method with parameters needs parentheses.
94
+ Style/MethodDefParentheses:
95
+ Enabled: true
96
+
97
+ Style/FrozenStringLiteralComment:
98
+ Enabled: false
99
+ EnforcedStyle: always
100
+
101
+ # Use `foo {}` not `foo{}`.
102
+ Layout/SpaceBeforeBlockBraces:
103
+ Enabled: true
104
+
105
+ # Use `foo { bar }` not `foo {bar}`.
106
+ Layout/SpaceInsideBlockBraces:
107
+ Enabled: true
108
+
109
+ # Use `{ a: 1 }` not `{a:1}`.
110
+ Layout/SpaceInsideHashLiteralBraces:
111
+ Enabled: true
112
+
113
+ Layout/SpaceInsideParens:
114
+ Enabled: true
115
+
116
+ # Check quotes usage according to lint rule below.
117
+ #Style/StringLiterals:
118
+ # Enabled: true
119
+ # EnforcedStyle: single_quotes
120
+
121
+ # Detect hard tabs, no hard tabs.
122
+ Layout/Tab:
123
+ Enabled: true
124
+
125
+ # Blank lines should not have any spaces.
126
+ Layout/TrailingBlankLines:
127
+ Enabled: true
128
+
129
+ # No trailing whitespace.
130
+ Layout/TrailingWhitespace:
131
+ Enabled: false
132
+
133
+ # Use quotes for string literals when they are enough.
134
+ Style/UnneededPercentQ:
135
+ Enabled: true
136
+
137
+ # Align `end` with the matching keyword or starting expression except for
138
+ # assignments, where it should be aligned with the LHS.
139
+ Layout/EndAlignment:
140
+ Enabled: true
141
+ EnforcedStyleAlignWith: variable
142
+ AutoCorrect: true
143
+
144
+ # Use my_method(my_arg) not my_method( my_arg ) or my_method my_arg.
145
+ Lint/RequireParentheses:
146
+ Enabled: true
147
+
148
+ Style/RedundantReturn:
149
+ Enabled: true
150
+ AllowMultipleReturnValues: true
151
+
152
+ Style/Semicolon:
153
+ Enabled: true
154
+ AllowAsExpressionSeparator: true
@@ -0,0 +1,31 @@
1
+ # Swagger Codegen Ignore
2
+ # Generated by swagger-codegen https://github.com/swagger-api/swagger-codegen
3
+
4
+ # Use this file to prevent files from being overwritten by the generator.
5
+ # The patterns follow closely to .gitignore or .dockerignore.
6
+
7
+ # As an example, the C# client generator defines ApiClient.cs.
8
+ # You can make changes and tell Swagger Codgen to ignore just this file by uncommenting the following line:
9
+ #ApiClient.cs
10
+
11
+ # You can match any string of characters against a directory, file or extension with a single asterisk (*):
12
+ #foo/*/qux
13
+ # The above matches foo/bar/qux and foo/baz/qux, but not foo/bar/baz/qux
14
+
15
+ # You can recursively match patterns against a directory, file or extension with a double asterisk (**):
16
+ #foo/**/qux
17
+ # This matches foo/bar/qux, foo/baz/qux, and foo/bar/baz/qux
18
+
19
+ # You can also negate patterns with an exclamation (!).
20
+ # For example, you can ignore all files in a docs folder with the file extension .md:
21
+ #docs/*.md
22
+ # Then explicitly reverse the ignore rule for a single file:
23
+ #!docs/README.md
24
+
25
+ README.md
26
+ CHANGELOG.md
27
+ git_push.sh
28
+ docs/
29
+ .gitignore
30
+ LICENSE
31
+ Rakefile
@@ -0,0 +1 @@
1
+ 2.3.0-SNAPSHOT
@@ -0,0 +1 @@
1
+ 28a5b74dbf313529a2fc697d46e9ed870cfd6a30
@@ -0,0 +1,8 @@
1
+ language: ruby
2
+ rvm:
3
+ - 2.4.2
4
+ - 2.1.10
5
+ - 1.9.3
6
+
7
+ before_install:
8
+ - gem update bundler
@@ -0,0 +1,48 @@
1
+ ### 1.12.0 [October 10, 2019]
2
+
3
+ - Add permanent_download_url attribute to Submission model
4
+
5
+ ### 1.11.0 [October 9, 2019]
6
+
7
+ - Add parent folder ID and path params to GET template response
8
+ - Add parent folder ID param when creating a new template, so you can upload a template into a folder
9
+
10
+ ### 1.10.0 [Aug 7, 2019]
11
+ * Added Create Folder, List Folder, Move to Folder endpoints
12
+
13
+ ### 1.9.1 [August 2, 2019]
14
+
15
+ - Relax json dependency to support older versions (>= 1.8)
16
+
17
+ ### 1.9.0 [June 22, 2019]
18
+
19
+ - **BREAKING CHANGE** Renamed "Get Templates" endpoint to "List Templates". Added a search query parameter.
20
+
21
+ ### 1.8.0 [April 11, 2019]
22
+
23
+ - Added support for editable PDFS (editable: true)
24
+
25
+ ### 1.7.0 [December 23, 2018]
26
+
27
+ - Added CustomFiles, and combinePdf call to support many different types of source PDFs. Renamed a few models
28
+
29
+ ### 1.6.0 [December 18, 2018]
30
+
31
+ - Updated API host to api.formapi.io
32
+
33
+ ### 1.5.0 [December 13, 2018]
34
+
35
+ - Fix model name for newly created Templates (PendingTemplate)
36
+ - Added "actions" to submission and combined_submission responses. Includes information about custom S3 uploads
37
+
38
+ ### 1.4.1 [December 2, 2018]
39
+
40
+ - Fixed crash in 1.4.0, did not include all of the necessary files
41
+
42
+ ### 1.4.0 [December 1, 2018]
43
+
44
+ - Added Create Template, Get Template, and Get Template Schema endpoints
45
+
46
+ ### 1.3.0 [November 4, 2018]
47
+
48
+ - Initial changelog
data/Gemfile ADDED
@@ -0,0 +1,8 @@
1
+ source 'https://rubygems.org'
2
+
3
+ gemspec
4
+
5
+ group :development, :test do
6
+ gem 'rake', '~> 12.0.0'
7
+ gem 'pry-byebug'
8
+ end
@@ -0,0 +1,80 @@
1
+ PATH
2
+ remote: .
3
+ specs:
4
+ docspring (1.0.0)
5
+ ffi (~> 1.0, >= 1.9.24)
6
+ json (>= 1.8)
7
+ typhoeus (~> 1.0, >= 1.0.1)
8
+
9
+ GEM
10
+ remote: https://rubygems.org/
11
+ specs:
12
+ ZenTest (4.12.0)
13
+ addressable (2.5.2)
14
+ public_suffix (>= 2.0.2, < 4.0)
15
+ autotest (4.4.6)
16
+ ZenTest (>= 4.4.1)
17
+ autotest-fsevent (0.2.14)
18
+ sys-uname
19
+ autotest-growl (0.2.16)
20
+ autotest-rails-pure (4.1.2)
21
+ byebug (10.0.2)
22
+ coderay (1.1.2)
23
+ crack (0.4.3)
24
+ safe_yaml (~> 1.0.0)
25
+ diff-lcs (1.3)
26
+ ethon (0.11.0)
27
+ ffi (>= 1.3.0)
28
+ ffi (1.9.25)
29
+ hashdiff (0.3.7)
30
+ json (2.1.0)
31
+ method_source (0.9.0)
32
+ pry (0.11.3)
33
+ coderay (~> 1.1.0)
34
+ method_source (~> 0.9.0)
35
+ pry-byebug (3.6.0)
36
+ byebug (~> 10.0)
37
+ pry (~> 0.10)
38
+ public_suffix (3.0.3)
39
+ rake (12.0.0)
40
+ rspec (3.8.0)
41
+ rspec-core (~> 3.8.0)
42
+ rspec-expectations (~> 3.8.0)
43
+ rspec-mocks (~> 3.8.0)
44
+ rspec-core (3.8.0)
45
+ rspec-support (~> 3.8.0)
46
+ rspec-expectations (3.8.1)
47
+ diff-lcs (>= 1.2.0, < 2.0)
48
+ rspec-support (~> 3.8.0)
49
+ rspec-mocks (3.8.0)
50
+ diff-lcs (>= 1.2.0, < 2.0)
51
+ rspec-support (~> 3.8.0)
52
+ rspec-support (3.8.0)
53
+ safe_yaml (1.0.4)
54
+ sys-uname (1.0.3)
55
+ ffi (>= 1.0.0)
56
+ typhoeus (1.3.0)
57
+ ethon (>= 0.9.0)
58
+ vcr (3.0.3)
59
+ webmock (1.24.6)
60
+ addressable (>= 2.3.6)
61
+ crack (>= 0.3.2)
62
+ hashdiff
63
+
64
+ PLATFORMS
65
+ ruby
66
+
67
+ DEPENDENCIES
68
+ autotest (~> 4.4, >= 4.4.6)
69
+ autotest-fsevent (~> 0.2, >= 0.2.12)
70
+ autotest-growl (~> 0.2, >= 0.2.16)
71
+ autotest-rails-pure (~> 4.1, >= 4.1.2)
72
+ docspring!
73
+ pry-byebug
74
+ rake (~> 12.0.0)
75
+ rspec (~> 3.6, >= 3.6.0)
76
+ vcr (~> 3.0, >= 3.0.1)
77
+ webmock (~> 1.24, >= 1.24.3)
78
+
79
+ BUNDLED WITH
80
+ 2.0.2
data/LICENSE ADDED
@@ -0,0 +1,7 @@
1
+ Copyright © 2018 Form Applications Inc.
2
+
3
+ Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
4
+
5
+ The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
6
+
7
+ THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
@@ -0,0 +1,162 @@
1
+ # docspring
2
+
3
+ DocSpring - the Ruby gem for the API v1
4
+
5
+ DocSpring is a service that helps you fill out and sign PDF templates.
6
+
7
+ This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
8
+
9
+ - API version: v1
10
+ - Package version: 1.0.0
11
+ - Build package: com.docspring.codegen.DocSpringRubyClientCodegen
12
+
13
+ ## Installation
14
+
15
+ ### Build a gem
16
+
17
+ To build the Ruby code into a gem:
18
+
19
+ ```shell
20
+ gem build docspring.gemspec
21
+ ```
22
+
23
+ Then either install the gem locally:
24
+
25
+ ```shell
26
+ gem install ./docspring-1.0.0.gem
27
+ ```
28
+ (for development, run `gem install --dev ./docspring-1.0.0.gem` to install the development dependencies)
29
+
30
+ or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
31
+
32
+ Finally add this to the Gemfile:
33
+
34
+ gem 'docspring', '~> 1.0.0'
35
+
36
+ ### Install from Git
37
+
38
+ If the Ruby gem is hosted at a git repository: https://github.com/GIT_USER_ID/GIT_REPO_ID, then add the following in the Gemfile:
39
+
40
+ gem 'docspring', :git => 'https://github.com/GIT_USER_ID/GIT_REPO_ID.git'
41
+
42
+ ### Include the Ruby code directly
43
+
44
+ Include the Ruby code directly using `-I` as follows:
45
+
46
+ ```shell
47
+ ruby -Ilib script.rb
48
+ ```
49
+
50
+ ## Getting Started
51
+
52
+ Please follow the [installation](#installation) procedure and then run the following code:
53
+ ```ruby
54
+ # Load the gem
55
+ require 'docspring'
56
+
57
+ # Setup authorization
58
+ DocSpring.configure do |config|
59
+ # Configure HTTP basic authorization: api_token_basic
60
+ config.username = 'YOUR USERNAME'
61
+ config.password = 'YOUR PASSWORD'
62
+ end
63
+
64
+ api_instance = DocSpring::PDFApi.new
65
+ template_id = 'tpl_000000000000000001' # String |
66
+ request_body = nil # Array<Object> |
67
+
68
+ begin
69
+ #Generates multiple PDFs
70
+ result = api_instance.batch_generate_pdf_v1(template_id, request_body)
71
+ p result
72
+ rescue DocSpring::ApiError => e
73
+ puts "Exception when calling PDFApi->batch_generate_pdf_v1: #{e}"
74
+ end
75
+
76
+ ```
77
+
78
+ ## Documentation for API Endpoints
79
+
80
+ All URIs are relative to *https://api.docspring.com/api/v1*
81
+
82
+ Class | Method | HTTP request | Description
83
+ ------------ | ------------- | ------------- | -------------
84
+ *DocSpring::PDFApi* | [**batch_generate_pdf_v1**](docs/PDFApi.md#batch_generate_pdf_v1) | **POST** /templates/{template_id}/submissions/batch | Generates multiple PDFs
85
+ *DocSpring::PDFApi* | [**batch_generate_pdfs**](docs/PDFApi.md#batch_generate_pdfs) | **POST** /submissions/batches | Generates multiple PDFs
86
+ *DocSpring::PDFApi* | [**combine_pdfs**](docs/PDFApi.md#combine_pdfs) | **POST** /combined_submissions?v&#x3D;2 | Merge submission PDFs, template PDFs, or custom files
87
+ *DocSpring::PDFApi* | [**combine_submissions**](docs/PDFApi.md#combine_submissions) | **POST** /combined_submissions | Merge generated PDFs together
88
+ *DocSpring::PDFApi* | [**create_custom_file_from_upload**](docs/PDFApi.md#create_custom_file_from_upload) | **POST** /custom_files | Create a new custom file from a cached presign upload
89
+ *DocSpring::PDFApi* | [**create_data_request_token**](docs/PDFApi.md#create_data_request_token) | **POST** /data_requests/{data_request_id}/tokens | Creates a new data request token for form authentication
90
+ *DocSpring::PDFApi* | [**create_folder**](docs/PDFApi.md#create_folder) | **POST** /folders/ | Create a folder
91
+ *DocSpring::PDFApi* | [**create_template**](docs/PDFApi.md#create_template) | **POST** /templates | Upload a new PDF template with a file upload
92
+ *DocSpring::PDFApi* | [**create_template_from_upload**](docs/PDFApi.md#create_template_from_upload) | **POST** /templates?v&#x3D;2 | Create a new PDF template from a cached presign upload
93
+ *DocSpring::PDFApi* | [**delete_folder**](docs/PDFApi.md#delete_folder) | **DELETE** /folders/{folder_id} | Delete a folder
94
+ *DocSpring::PDFApi* | [**expire_combined_submission**](docs/PDFApi.md#expire_combined_submission) | **DELETE** /combined_submissions/{combined_submission_id} | Expire a combined submission
95
+ *DocSpring::PDFApi* | [**expire_submission**](docs/PDFApi.md#expire_submission) | **DELETE** /submissions/{submission_id} | Expire a PDF submission
96
+ *DocSpring::PDFApi* | [**generate_pdf**](docs/PDFApi.md#generate_pdf) | **POST** /templates/{template_id}/submissions | Generates a new PDF
97
+ *DocSpring::PDFApi* | [**get_combined_submission**](docs/PDFApi.md#get_combined_submission) | **GET** /combined_submissions/{combined_submission_id} | Check the status of a combined submission (merged PDFs)
98
+ *DocSpring::PDFApi* | [**get_data_request**](docs/PDFApi.md#get_data_request) | **GET** /data_requests/{data_request_id} | Look up a submission data request
99
+ *DocSpring::PDFApi* | [**get_presign_url**](docs/PDFApi.md#get_presign_url) | **GET** /uploads/presign | Get a presigned URL so that you can upload a file to our AWS S3 bucket
100
+ *DocSpring::PDFApi* | [**get_submission**](docs/PDFApi.md#get_submission) | **GET** /submissions/{submission_id} | Check the status of a PDF
101
+ *DocSpring::PDFApi* | [**get_submission_batch**](docs/PDFApi.md#get_submission_batch) | **GET** /submissions/batches/{submission_batch_id} | Check the status of a submission batch job
102
+ *DocSpring::PDFApi* | [**get_template**](docs/PDFApi.md#get_template) | **GET** /templates/{template_id} | Get a single template
103
+ *DocSpring::PDFApi* | [**get_template_schema**](docs/PDFApi.md#get_template_schema) | **GET** /templates/{template_id}/schema | Fetch the JSON schema for a template
104
+ *DocSpring::PDFApi* | [**list_folders**](docs/PDFApi.md#list_folders) | **GET** /folders/ | Get a list of all folders
105
+ *DocSpring::PDFApi* | [**list_templates**](docs/PDFApi.md#list_templates) | **GET** /templates | Get a list of all templates
106
+ *DocSpring::PDFApi* | [**move_folder_to_folder**](docs/PDFApi.md#move_folder_to_folder) | **POST** /folders/{folder_id}/move | Move a folder
107
+ *DocSpring::PDFApi* | [**move_template_to_folder**](docs/PDFApi.md#move_template_to_folder) | **POST** /templates/{template_id}/move | Move Template to folder
108
+ *DocSpring::PDFApi* | [**rename_folder**](docs/PDFApi.md#rename_folder) | **POST** /folders/{folder_id}/rename | Rename a folder
109
+ *DocSpring::PDFApi* | [**test_authentication**](docs/PDFApi.md#test_authentication) | **GET** /authentication | Test Authentication
110
+ *DocSpring::PDFApi* | [**update_data_request**](docs/PDFApi.md#update_data_request) | **PUT** /data_requests/{data_request_id} | Update a submission data request
111
+
112
+
113
+ ## Documentation for Models
114
+
115
+ - [DocSpring::AuthenticationError](docs/AuthenticationError.md)
116
+ - [DocSpring::AuthenticationSuccessResponse](docs/AuthenticationSuccessResponse.md)
117
+ - [DocSpring::CombinePdfsData](docs/CombinePdfsData.md)
118
+ - [DocSpring::CombinedSubmission](docs/CombinedSubmission.md)
119
+ - [DocSpring::CombinedSubmissionAction](docs/CombinedSubmissionAction.md)
120
+ - [DocSpring::CombinedSubmissionData](docs/CombinedSubmissionData.md)
121
+ - [DocSpring::CreateCombinedSubmissionResponse](docs/CreateCombinedSubmissionResponse.md)
122
+ - [DocSpring::CreateCustomFileData](docs/CreateCustomFileData.md)
123
+ - [DocSpring::CreateCustomFileResponse](docs/CreateCustomFileResponse.md)
124
+ - [DocSpring::CreateFolderData](docs/CreateFolderData.md)
125
+ - [DocSpring::CreateSubmissionBatchResponse](docs/CreateSubmissionBatchResponse.md)
126
+ - [DocSpring::CreateSubmissionBatchSubmissionsResponse](docs/CreateSubmissionBatchSubmissionsResponse.md)
127
+ - [DocSpring::CreateSubmissionDataRequestData](docs/CreateSubmissionDataRequestData.md)
128
+ - [DocSpring::CreateSubmissionDataRequestTokenResponse](docs/CreateSubmissionDataRequestTokenResponse.md)
129
+ - [DocSpring::CreateSubmissionDataRequestTokenResponseToken](docs/CreateSubmissionDataRequestTokenResponseToken.md)
130
+ - [DocSpring::CreateSubmissionResponse](docs/CreateSubmissionResponse.md)
131
+ - [DocSpring::CreateTemplateData](docs/CreateTemplateData.md)
132
+ - [DocSpring::CustomFile](docs/CustomFile.md)
133
+ - [DocSpring::Error](docs/Error.md)
134
+ - [DocSpring::Folder](docs/Folder.md)
135
+ - [DocSpring::FoldersFolder](docs/FoldersFolder.md)
136
+ - [DocSpring::InvalidRequest](docs/InvalidRequest.md)
137
+ - [DocSpring::MoveFolderData](docs/MoveFolderData.md)
138
+ - [DocSpring::MoveTemplateData](docs/MoveTemplateData.md)
139
+ - [DocSpring::PendingTemplate](docs/PendingTemplate.md)
140
+ - [DocSpring::RenameFolderData](docs/RenameFolderData.md)
141
+ - [DocSpring::Submission](docs/Submission.md)
142
+ - [DocSpring::SubmissionAction](docs/SubmissionAction.md)
143
+ - [DocSpring::SubmissionBatch](docs/SubmissionBatch.md)
144
+ - [DocSpring::SubmissionBatchData](docs/SubmissionBatchData.md)
145
+ - [DocSpring::SubmissionData](docs/SubmissionData.md)
146
+ - [DocSpring::SubmissionDataBatchRequest](docs/SubmissionDataBatchRequest.md)
147
+ - [DocSpring::SubmissionDataRequest](docs/SubmissionDataRequest.md)
148
+ - [DocSpring::Template](docs/Template.md)
149
+ - [DocSpring::Templatesv2Template](docs/Templatesv2Template.md)
150
+ - [DocSpring::Templatesv2TemplateDocument](docs/Templatesv2TemplateDocument.md)
151
+ - [DocSpring::Templatesv2TemplateDocumentMetadata](docs/Templatesv2TemplateDocumentMetadata.md)
152
+ - [DocSpring::UpdateDataRequestResponse](docs/UpdateDataRequestResponse.md)
153
+ - [DocSpring::UpdateSubmissionDataRequestData](docs/UpdateSubmissionDataRequestData.md)
154
+
155
+
156
+ ## Documentation for Authorization
157
+
158
+
159
+ ### api_token_basic
160
+
161
+ - **Type**: HTTP basic authentication
162
+