form_api 1.3.0 → 1.4.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (68) hide show
  1. checksums.yaml +5 -5
  2. data/.swagger-codegen-ignore +31 -0
  3. data/.swagger-codegen/VERSION +1 -0
  4. data/.swagger-revision +1 -0
  5. data/.travis.yml +8 -0
  6. data/Gemfile.lock +3 -2
  7. data/LICENSE +7 -0
  8. data/README.md +10 -6
  9. data/docs/PDFApi.md +152 -0
  10. data/form_api.gemspec +3 -2
  11. data/lib/form_api.rb +3 -2
  12. data/lib/form_api/api/pdf_api.rb +165 -2
  13. data/lib/form_api/api_client.rb +2 -2
  14. data/lib/form_api/api_error.rb +2 -2
  15. data/lib/form_api/configuration.rb +2 -2
  16. data/lib/form_api/models/authentication_error.rb +2 -2
  17. data/lib/form_api/models/authentication_success_response.rb +2 -2
  18. data/lib/form_api/models/combined_submission.rb +2 -2
  19. data/lib/form_api/models/combined_submission_data.rb +2 -2
  20. data/lib/form_api/models/create_combined_submission_response.rb +2 -2
  21. data/lib/form_api/models/create_submission_batch_response.rb +2 -2
  22. data/lib/form_api/models/create_submission_batch_submissions_response.rb +2 -2
  23. data/lib/form_api/models/create_submission_data.rb +2 -2
  24. data/lib/form_api/models/create_submission_data_batch_request.rb +2 -2
  25. data/lib/form_api/models/create_submission_data_batch_v1.rb +2 -2
  26. data/lib/form_api/models/create_submission_data_request_data.rb +2 -2
  27. data/lib/form_api/models/create_submission_data_request_token_response.rb +2 -2
  28. data/lib/form_api/models/create_submission_data_request_token_response_token.rb +2 -2
  29. data/lib/form_api/models/create_submission_response.rb +2 -2
  30. data/lib/form_api/models/error.rb +2 -2
  31. data/lib/form_api/models/invalid_request.rb +2 -2
  32. data/lib/form_api/models/submission.rb +2 -2
  33. data/lib/form_api/models/submission_batch.rb +2 -2
  34. data/lib/form_api/models/submission_batch_data.rb +2 -2
  35. data/lib/form_api/models/submission_data_request.rb +2 -2
  36. data/lib/form_api/models/template.rb +2 -2
  37. data/lib/form_api/models/update_data_request_response.rb +2 -2
  38. data/lib/form_api/models/update_submission_data_request_data.rb +2 -2
  39. data/lib/form_api/version.rb +3 -3
  40. data/spec/api/pdf_api_integration_spec.rb +2 -2
  41. data/spec/api/pdf_api_spec_original.skipped.rb +40 -2
  42. data/spec/api_client_spec.rb +2 -2
  43. data/spec/configuration_spec.rb +2 -2
  44. data/spec/models/authentication_error_spec.rb +2 -2
  45. data/spec/models/authentication_success_response_spec.rb +2 -2
  46. data/spec/models/combined_submission_data_spec.rb +2 -2
  47. data/spec/models/combined_submission_spec.rb +2 -2
  48. data/spec/models/create_combined_submission_response_spec.rb +2 -2
  49. data/spec/models/create_submission_batch_response_spec.rb +2 -2
  50. data/spec/models/create_submission_batch_submissions_response_spec.rb +2 -2
  51. data/spec/models/create_submission_data_batch_request_spec.rb +2 -2
  52. data/spec/models/create_submission_data_batch_v1_spec.rb +2 -2
  53. data/spec/models/create_submission_data_request_data_spec.rb +2 -2
  54. data/spec/models/create_submission_data_request_token_response_spec.rb +2 -2
  55. data/spec/models/create_submission_data_request_token_response_token_spec.rb +2 -2
  56. data/spec/models/create_submission_data_spec.rb +2 -2
  57. data/spec/models/create_submission_response_spec.rb +2 -2
  58. data/spec/models/error_spec.rb +2 -2
  59. data/spec/models/invalid_request_spec.rb +2 -2
  60. data/spec/models/submission_batch_data_spec.rb +2 -2
  61. data/spec/models/submission_batch_spec.rb +2 -2
  62. data/spec/models/submission_data_request_spec.rb +2 -2
  63. data/spec/models/submission_spec.rb +2 -2
  64. data/spec/models/template_spec.rb +2 -2
  65. data/spec/models/update_data_request_response_spec.rb +2 -2
  66. data/spec/models/update_submission_data_request_data_spec.rb +2 -2
  67. data/spec/spec_helper.rb +2 -2
  68. metadata +28 -3
@@ -1,7 +1,7 @@
1
1
  =begin
2
- #API V1
2
+ #API v1
3
3
 
4
- #No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
4
+ #FormAPI is a service that helps you fill out and sign PDF templates.
5
5
 
6
6
  OpenAPI spec version: v1
7
7
 
@@ -1,7 +1,7 @@
1
1
  =begin
2
- #API V1
2
+ #API v1
3
3
 
4
- #No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
4
+ #FormAPI is a service that helps you fill out and sign PDF templates.
5
5
 
6
6
  OpenAPI spec version: v1
7
7
 
@@ -1,7 +1,7 @@
1
1
  =begin
2
- #API V1
2
+ #API v1
3
3
 
4
- #No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
4
+ #FormAPI is a service that helps you fill out and sign PDF templates.
5
5
 
6
6
  OpenAPI spec version: v1
7
7
 
@@ -1,7 +1,7 @@
1
1
  =begin
2
- #API V1
2
+ #API v1
3
3
 
4
- #No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
4
+ #FormAPI is a service that helps you fill out and sign PDF templates.
5
5
 
6
6
  OpenAPI spec version: v1
7
7
 
@@ -1,7 +1,7 @@
1
1
  =begin
2
- #API V1
2
+ #API v1
3
3
 
4
- #No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
4
+ #FormAPI is a service that helps you fill out and sign PDF templates.
5
5
 
6
6
  OpenAPI spec version: v1
7
7
 
@@ -1,7 +1,7 @@
1
1
  =begin
2
- #API V1
2
+ #API v1
3
3
 
4
- #No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
4
+ #FormAPI is a service that helps you fill out and sign PDF templates.
5
5
 
6
6
  OpenAPI spec version: v1
7
7
 
@@ -1,7 +1,7 @@
1
1
  =begin
2
- #API V1
2
+ #API v1
3
3
 
4
- #No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
4
+ #FormAPI is a service that helps you fill out and sign PDF templates.
5
5
 
6
6
  OpenAPI spec version: v1
7
7
 
@@ -1,7 +1,7 @@
1
1
  =begin
2
- #API V1
2
+ #API v1
3
3
 
4
- #No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
4
+ #FormAPI is a service that helps you fill out and sign PDF templates.
5
5
 
6
6
  OpenAPI spec version: v1
7
7
 
@@ -1,7 +1,7 @@
1
1
  =begin
2
- #API V1
2
+ #API v1
3
3
 
4
- #No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
4
+ #FormAPI is a service that helps you fill out and sign PDF templates.
5
5
 
6
6
  OpenAPI spec version: v1
7
7
 
@@ -1,7 +1,7 @@
1
1
  =begin
2
- #API V1
2
+ #API v1
3
3
 
4
- #No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
4
+ #FormAPI is a service that helps you fill out and sign PDF templates.
5
5
 
6
6
  OpenAPI spec version: v1
7
7
 
@@ -1,7 +1,7 @@
1
1
  =begin
2
- #API V1
2
+ #API v1
3
3
 
4
- #No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
4
+ #FormAPI is a service that helps you fill out and sign PDF templates.
5
5
 
6
6
  OpenAPI spec version: v1
7
7
 
@@ -1,7 +1,7 @@
1
1
  =begin
2
- #API V1
2
+ #API v1
3
3
 
4
- #No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
4
+ #FormAPI is a service that helps you fill out and sign PDF templates.
5
5
 
6
6
  OpenAPI spec version: v1
7
7
 
@@ -1,7 +1,7 @@
1
1
  =begin
2
- #API V1
2
+ #API v1
3
3
 
4
- #No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
4
+ #FormAPI is a service that helps you fill out and sign PDF templates.
5
5
 
6
6
  OpenAPI spec version: v1
7
7
 
@@ -1,7 +1,7 @@
1
1
  =begin
2
- #API V1
2
+ #API v1
3
3
 
4
- #No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
4
+ #FormAPI is a service that helps you fill out and sign PDF templates.
5
5
 
6
6
  OpenAPI spec version: v1
7
7
 
@@ -1,7 +1,7 @@
1
1
  =begin
2
- #API V1
2
+ #API v1
3
3
 
4
- #No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
4
+ #FormAPI is a service that helps you fill out and sign PDF templates.
5
5
 
6
6
  OpenAPI spec version: v1
7
7
 
@@ -1,7 +1,7 @@
1
1
  =begin
2
- #API V1
2
+ #API v1
3
3
 
4
- #No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
4
+ #FormAPI is a service that helps you fill out and sign PDF templates.
5
5
 
6
6
  OpenAPI spec version: v1
7
7
 
@@ -1,7 +1,7 @@
1
1
  =begin
2
- #API V1
2
+ #API v1
3
3
 
4
- #No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
4
+ #FormAPI is a service that helps you fill out and sign PDF templates.
5
5
 
6
6
  OpenAPI spec version: v1
7
7
 
@@ -1,7 +1,7 @@
1
1
  =begin
2
- #API V1
2
+ #API v1
3
3
 
4
- #No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
4
+ #FormAPI is a service that helps you fill out and sign PDF templates.
5
5
 
6
6
  OpenAPI spec version: v1
7
7
 
@@ -1,7 +1,7 @@
1
1
  =begin
2
- #API V1
2
+ #API v1
3
3
 
4
- #No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
4
+ #FormAPI is a service that helps you fill out and sign PDF templates.
5
5
 
6
6
  OpenAPI spec version: v1
7
7
 
@@ -1,7 +1,7 @@
1
1
  =begin
2
- #API V1
2
+ #API v1
3
3
 
4
- #No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
4
+ #FormAPI is a service that helps you fill out and sign PDF templates.
5
5
 
6
6
  OpenAPI spec version: v1
7
7
 
@@ -1,7 +1,7 @@
1
1
  =begin
2
- #API V1
2
+ #API v1
3
3
 
4
- #No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
4
+ #FormAPI is a service that helps you fill out and sign PDF templates.
5
5
 
6
6
  OpenAPI spec version: v1
7
7
 
@@ -1,7 +1,7 @@
1
1
  =begin
2
- #API V1
2
+ #API v1
3
3
 
4
- #No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
4
+ #FormAPI is a service that helps you fill out and sign PDF templates.
5
5
 
6
6
  OpenAPI spec version: v1
7
7
 
@@ -1,7 +1,7 @@
1
1
  =begin
2
- #API V1
2
+ #API v1
3
3
 
4
- #No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
4
+ #FormAPI is a service that helps you fill out and sign PDF templates.
5
5
 
6
6
  OpenAPI spec version: v1
7
7
 
@@ -1,7 +1,7 @@
1
1
  =begin
2
- #API V1
2
+ #API v1
3
3
 
4
- #No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
4
+ #FormAPI is a service that helps you fill out and sign PDF templates.
5
5
 
6
6
  OpenAPI spec version: v1
7
7
 
@@ -1,7 +1,7 @@
1
1
  =begin
2
- #API V1
2
+ #API v1
3
3
 
4
- #No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
4
+ #FormAPI is a service that helps you fill out and sign PDF templates.
5
5
 
6
6
  OpenAPI spec version: v1
7
7
 
@@ -1,7 +1,7 @@
1
1
  =begin
2
- #API V1
2
+ #API v1
3
3
 
4
- #No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
4
+ #FormAPI is a service that helps you fill out and sign PDF templates.
5
5
 
6
6
  OpenAPI spec version: v1
7
7
 
@@ -1,7 +1,7 @@
1
1
  =begin
2
- #API V1
2
+ #API v1
3
3
 
4
- #No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
4
+ #FormAPI is a service that helps you fill out and sign PDF templates.
5
5
 
6
6
  OpenAPI spec version: v1
7
7
 
@@ -11,5 +11,5 @@ OpenAPI Generator version: 3.3.0-SNAPSHOT
11
11
  =end
12
12
 
13
13
  module FormAPI
14
- VERSION = '1.3.0'
14
+ VERSION = '1.4.0'
15
15
  end
@@ -284,7 +284,7 @@ describe 'PDFApi' do
284
284
  # @param data_request_id
285
285
  # @param [Hash] opts the optional parameters
286
286
  # @return [SubmissionDataRequest]
287
- describe 'get_data_request test' do
287
+ describe 'update_data_request test' do
288
288
  it 'should work' do
289
289
  data_request_id = 'drq_000000000000000001' # String |
290
290
  response = api_instance.update_data_request(
@@ -301,7 +301,7 @@ describe 'PDFApi' do
301
301
  expect(response.status).to eq 'success'
302
302
  data_request = response.data_request
303
303
  expect(data_request.id).to start_with 'drq_'
304
- # Not allowed to update order, name, email, etc.
304
+ # Not allowed to update order, name, email, fields
305
305
  expect(data_request.order).to eq 1
306
306
  expect(data_request.name).to eq 'John Doe'
307
307
  expect(data_request.email).to eq 'jdoe@example.com'
@@ -1,7 +1,7 @@
1
1
  =begin
2
- #API V1
2
+ #API v1
3
3
 
4
- #No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
4
+ #FormAPI is a service that helps you fill out and sign PDF templates.
5
5
 
6
6
  OpenAPI spec version: v1
7
7
 
@@ -88,6 +88,20 @@ describe 'PDFApi' do
88
88
  expect(result).to_not be_nil
89
89
  end
90
90
  end
91
+ # integration tests for create_template
92
+ # Upload a new PDF template
93
+ # @param template_document
94
+ # @param template_name
95
+ # @param [Hash] opts the optional parameters
96
+ # @return [Template1]
97
+ describe 'create_template test' do
98
+ it 'should work' do
99
+ template_document = File.new('/path/to/file') # File |
100
+ template_name = 'template_name_example' # String |
101
+ result = api_instance.create_template(template_document, template_name)
102
+ expect(result).to_not be_nil
103
+ end
104
+ end
91
105
  # integration tests for expire_combined_submission
92
106
  # Expire a combined submission
93
107
  # @param combined_submission_id
@@ -178,6 +192,30 @@ describe 'PDFApi' do
178
192
  expect(result).to_not be_nil
179
193
  end
180
194
  end
195
+ # integration tests for get_template
196
+ # Check the status of an uploaded template
197
+ # @param template_id
198
+ # @param [Hash] opts the optional parameters
199
+ # @return [Template]
200
+ describe 'get_template test' do
201
+ it 'should work' do
202
+ template_id = 'tpl_000000000000000001' # String |
203
+ result = api_instance.get_template(template_id)
204
+ expect(result).to_not be_nil
205
+ end
206
+ end
207
+ # integration tests for get_template_schema
208
+ # Fetch the JSON schema for a template
209
+ # @param template_id
210
+ # @param [Hash] opts the optional parameters
211
+ # @return [Hash<String, Object>]
212
+ describe 'get_template_schema test' do
213
+ it 'should work' do
214
+ template_id = 'tpl_000000000000000001' # String |
215
+ result = api_instance.get_template_schema(template_id)
216
+ expect(result).to_not be_nil
217
+ end
218
+ end
181
219
  # integration tests for get_templates
182
220
  # Get a list of all templates
183
221
  # @param [Hash] opts the optional parameters
@@ -1,7 +1,7 @@
1
1
  =begin
2
- #API V1
2
+ #API v1
3
3
 
4
- #No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
4
+ #FormAPI is a service that helps you fill out and sign PDF templates.
5
5
 
6
6
  OpenAPI spec version: v1
7
7
 
@@ -1,7 +1,7 @@
1
1
  =begin
2
- #API V1
2
+ #API v1
3
3
 
4
- #No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
4
+ #FormAPI is a service that helps you fill out and sign PDF templates.
5
5
 
6
6
  OpenAPI spec version: v1
7
7
 
@@ -1,7 +1,7 @@
1
1
  =begin
2
- #API V1
2
+ #API v1
3
3
 
4
- #No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
4
+ #FormAPI is a service that helps you fill out and sign PDF templates.
5
5
 
6
6
  OpenAPI spec version: v1
7
7
 
@@ -1,7 +1,7 @@
1
1
  =begin
2
- #API V1
2
+ #API v1
3
3
 
4
- #No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
4
+ #FormAPI is a service that helps you fill out and sign PDF templates.
5
5
 
6
6
  OpenAPI spec version: v1
7
7
 
@@ -1,7 +1,7 @@
1
1
  =begin
2
- #API V1
2
+ #API v1
3
3
 
4
- #No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
4
+ #FormAPI is a service that helps you fill out and sign PDF templates.
5
5
 
6
6
  OpenAPI spec version: v1
7
7
 
@@ -1,7 +1,7 @@
1
1
  =begin
2
- #API V1
2
+ #API v1
3
3
 
4
- #No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
4
+ #FormAPI is a service that helps you fill out and sign PDF templates.
5
5
 
6
6
  OpenAPI spec version: v1
7
7
 
@@ -1,7 +1,7 @@
1
1
  =begin
2
- #API V1
2
+ #API v1
3
3
 
4
- #No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
4
+ #FormAPI is a service that helps you fill out and sign PDF templates.
5
5
 
6
6
  OpenAPI spec version: v1
7
7