form_api 1.0.0 → 1.1.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.
- checksums.yaml +4 -4
- data/Gemfile.lock +3 -3
- data/README.md +11 -5
- data/docs/CreateSubmissionBatchResponse.md +1 -1
- data/docs/{CreateSubmissionResponse1.md → CreateSubmissionBatchSubmissionsResponse.md} +1 -1
- data/docs/CreateSubmissionBatchV1SubmissionsResponse.md +10 -0
- data/docs/CreateSubmissionDataRequestTokenResponse.md +10 -0
- data/docs/CreateSubmissionDataRequestTokenResponseToken.md +11 -0
- data/docs/CreateSubmissionResponse.md +1 -0
- data/docs/PDFApi.md +102 -2
- data/docs/SubmissionDataRequest.md +16 -0
- data/form_api.gemspec +2 -2
- data/lib/form_api.rb +5 -1
- data/lib/form_api/api/client.rb +3 -3
- data/lib/form_api/api/pdf_api.rb +105 -3
- data/lib/form_api/api_client.rb +19 -2
- data/lib/form_api/models/create_submission_batch_response.rb +1 -1
- data/lib/form_api/models/{create_submission_response1.rb → create_submission_batch_submissions_response.rb} +1 -1
- data/lib/form_api/models/create_submission_batch_v1_submissions_response.rb +237 -0
- data/lib/form_api/models/create_submission_data_request_token_response.rb +237 -0
- data/lib/form_api/models/create_submission_data_request_token_response_token.rb +210 -0
- data/lib/form_api/models/create_submission_response.rb +12 -1
- data/lib/form_api/models/submission.rb +2 -2
- data/lib/form_api/models/submission_data_request.rb +336 -0
- data/lib/form_api/version.rb +1 -1
- data/spec/api/{client_spec.rb → client_integration_spec.rb} +20 -0
- data/spec/api/{pdf_api_spec.rb → pdf_api_integration_spec.rb} +39 -0
- data/spec/api/pdf_api_spec_original.skipped.rb +207 -0
- data/spec/configuration_spec.rb +11 -0
- data/spec/models/{create_submission_response1_spec.rb → create_submission_batch_submissions_response_spec.rb} +6 -6
- data/spec/models/create_submission_batch_v1_submissions_response_spec.rb +57 -0
- data/spec/models/create_submission_data_request_token_response_spec.rb +57 -0
- data/spec/models/create_submission_data_request_token_response_token_spec.rb +59 -0
- data/spec/models/create_submission_response_spec.rb +6 -0
- data/spec/models/submission_data_request_spec.rb +93 -0
- data/spec/models/submission_spec.rb +1 -1
- data/spec/spec_helper.rb +3 -0
- metadata +31 -13
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA1:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 2d535019a0b75e174177b3a84f01de0ebae125ea
|
4
|
+
data.tar.gz: 1c7bca8c308f98bd23170dcf4a69f5a1a8e5b0c5
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 12f2c5c6b3b673a6a31f03aa470ea6b2f1c95eb313c4bf7cb0c1090998d0e7e6586db1ef216ff7b806282faa3933d87978200a914fca552bfe097f3a6415a77f
|
7
|
+
data.tar.gz: a51b1d6cfe5ee9934b44db7246a6e29e7020c15b0d76b1bf2048798d7cb29e2c840a9eb0460406735d5640b5b2d0d87e824cec929130982e9cac99ca1bf49c03
|
data/Gemfile.lock
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
PATH
|
2
2
|
remote: .
|
3
3
|
specs:
|
4
|
-
form_api (1.
|
4
|
+
form_api (1.1.0)
|
5
5
|
json (~> 2.1, >= 2.1.0)
|
6
6
|
typhoeus (~> 1.0, >= 1.0.1)
|
7
7
|
|
@@ -13,7 +13,7 @@ GEM
|
|
13
13
|
public_suffix (>= 2.0.2, < 4.0)
|
14
14
|
autotest (4.4.6)
|
15
15
|
ZenTest (>= 4.4.1)
|
16
|
-
autotest-fsevent (0.2.
|
16
|
+
autotest-fsevent (0.2.14)
|
17
17
|
sys-uname
|
18
18
|
autotest-growl (0.2.16)
|
19
19
|
autotest-rails-pure (4.1.2)
|
@@ -76,4 +76,4 @@ DEPENDENCIES
|
|
76
76
|
webmock (~> 1.24, >= 1.24.3)
|
77
77
|
|
78
78
|
BUNDLED WITH
|
79
|
-
1.16.
|
79
|
+
1.16.2
|
data/README.md
CHANGED
@@ -7,7 +7,7 @@ No description provided (generated by Openapi Generator https://github.com/opena
|
|
7
7
|
This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
|
8
8
|
|
9
9
|
- API version: v1
|
10
|
-
- Package version: 1.
|
10
|
+
- Package version: 1.1.0
|
11
11
|
- Build package: io.formapi.codegen.FormApiRubyClientCodegen
|
12
12
|
|
13
13
|
## Installation
|
@@ -23,15 +23,15 @@ gem build form_api.gemspec
|
|
23
23
|
Then either install the gem locally:
|
24
24
|
|
25
25
|
```shell
|
26
|
-
gem install ./form_api-1.
|
26
|
+
gem install ./form_api-1.1.0.gem
|
27
27
|
```
|
28
|
-
(for development, run `gem install --dev ./form_api-1.
|
28
|
+
(for development, run `gem install --dev ./form_api-1.1.0.gem` to install the development dependencies)
|
29
29
|
|
30
30
|
or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
|
31
31
|
|
32
32
|
Finally add this to the Gemfile:
|
33
33
|
|
34
|
-
gem 'form_api', '~> 1.
|
34
|
+
gem 'form_api', '~> 1.1.0'
|
35
35
|
|
36
36
|
### Install from Git
|
37
37
|
|
@@ -84,10 +84,12 @@ Class | Method | HTTP request | Description
|
|
84
84
|
*FormAPI::PDFApi* | [**batch_generate_pdf_v1**](docs/PDFApi.md#batch_generate_pdf_v1) | **POST** /templates/{template_id}/submissions/batch | Generates multiple PDFs
|
85
85
|
*FormAPI::PDFApi* | [**batch_generate_pdfs**](docs/PDFApi.md#batch_generate_pdfs) | **POST** /submissions/batches | Generates multiple PDFs
|
86
86
|
*FormAPI::PDFApi* | [**combine_submissions**](docs/PDFApi.md#combine_submissions) | **POST** /combined_submissions | Merge generated PDFs together
|
87
|
+
*FormAPI::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
|
87
88
|
*FormAPI::PDFApi* | [**expire_combined_submission**](docs/PDFApi.md#expire_combined_submission) | **DELETE** /combined_submissions/{combined_submission_id} | Expire a combined submission
|
88
89
|
*FormAPI::PDFApi* | [**expire_submission**](docs/PDFApi.md#expire_submission) | **DELETE** /submissions/{submission_id} | Expire a PDF submission
|
89
90
|
*FormAPI::PDFApi* | [**generate_pdf**](docs/PDFApi.md#generate_pdf) | **POST** /templates/{template_id}/submissions | Generates a new PDF
|
90
91
|
*FormAPI::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)
|
92
|
+
*FormAPI::PDFApi* | [**get_data_request**](docs/PDFApi.md#get_data_request) | **GET** /data_requests/{data_request_id} | Look up a submission data request
|
91
93
|
*FormAPI::PDFApi* | [**get_submission**](docs/PDFApi.md#get_submission) | **GET** /submissions/{submission_id} | Check the status of a PDF
|
92
94
|
*FormAPI::PDFApi* | [**get_submission_batch**](docs/PDFApi.md#get_submission_batch) | **GET** /submissions/batches/{submission_batch_id} | Check the status of a submission batch job
|
93
95
|
*FormAPI::PDFApi* | [**get_templates**](docs/PDFApi.md#get_templates) | **GET** /templates | Get a list of all templates
|
@@ -102,15 +104,19 @@ Class | Method | HTTP request | Description
|
|
102
104
|
- [FormAPI::CombinedSubmissionData](docs/CombinedSubmissionData.md)
|
103
105
|
- [FormAPI::CreateCombinedSubmissionResponse](docs/CreateCombinedSubmissionResponse.md)
|
104
106
|
- [FormAPI::CreateSubmissionBatchResponse](docs/CreateSubmissionBatchResponse.md)
|
107
|
+
- [FormAPI::CreateSubmissionBatchSubmissionsResponse](docs/CreateSubmissionBatchSubmissionsResponse.md)
|
108
|
+
- [FormAPI::CreateSubmissionBatchV1SubmissionsResponse](docs/CreateSubmissionBatchV1SubmissionsResponse.md)
|
105
109
|
- [FormAPI::CreateSubmissionData](docs/CreateSubmissionData.md)
|
106
110
|
- [FormAPI::CreateSubmissionDataBatchRequest](docs/CreateSubmissionDataBatchRequest.md)
|
111
|
+
- [FormAPI::CreateSubmissionDataRequestTokenResponse](docs/CreateSubmissionDataRequestTokenResponse.md)
|
112
|
+
- [FormAPI::CreateSubmissionDataRequestTokenResponseToken](docs/CreateSubmissionDataRequestTokenResponseToken.md)
|
107
113
|
- [FormAPI::CreateSubmissionResponse](docs/CreateSubmissionResponse.md)
|
108
|
-
- [FormAPI::CreateSubmissionResponse1](docs/CreateSubmissionResponse1.md)
|
109
114
|
- [FormAPI::Error](docs/Error.md)
|
110
115
|
- [FormAPI::InvalidRequest](docs/InvalidRequest.md)
|
111
116
|
- [FormAPI::Submission](docs/Submission.md)
|
112
117
|
- [FormAPI::SubmissionBatch](docs/SubmissionBatch.md)
|
113
118
|
- [FormAPI::SubmissionBatchData](docs/SubmissionBatchData.md)
|
119
|
+
- [FormAPI::SubmissionDataRequest](docs/SubmissionDataRequest.md)
|
114
120
|
- [FormAPI::Template](docs/Template.md)
|
115
121
|
|
116
122
|
|
@@ -4,7 +4,7 @@
|
|
4
4
|
Name | Type | Description | Notes
|
5
5
|
------------ | ------------- | ------------- | -------------
|
6
6
|
**submission_batch** | [**SubmissionBatch**](SubmissionBatch.md) | | [optional]
|
7
|
-
**submissions** | [**Array<
|
7
|
+
**submissions** | [**Array<CreateSubmissionBatchSubmissionsResponse>**](CreateSubmissionBatchSubmissionsResponse.md) | | [optional]
|
8
8
|
**error** | **String** | | [optional]
|
9
9
|
**errors** | **Array<String>** | | [optional]
|
10
10
|
**status** | **String** | | [optional]
|
@@ -0,0 +1,10 @@
|
|
1
|
+
# FormAPI::CreateSubmissionBatchV1SubmissionsResponse
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**submission** | [**Submission**](Submission.md) | | [optional]
|
7
|
+
**errors** | **Array<String>** | | [optional]
|
8
|
+
**status** | **String** | | [optional]
|
9
|
+
|
10
|
+
|
@@ -0,0 +1,10 @@
|
|
1
|
+
# FormAPI::CreateSubmissionDataRequestTokenResponse
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**errors** | **Array<String>** | | [optional]
|
7
|
+
**status** | **String** | | [optional]
|
8
|
+
**token** | [**CreateSubmissionDataRequestTokenResponseToken**](CreateSubmissionDataRequestTokenResponseToken.md) | | [optional]
|
9
|
+
|
10
|
+
|
@@ -0,0 +1,11 @@
|
|
1
|
+
# FormAPI::CreateSubmissionDataRequestTokenResponseToken
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**expires_at** | **String** | | [optional]
|
7
|
+
**id** | **String** | | [optional]
|
8
|
+
**secret** | **String** | | [optional]
|
9
|
+
**data_request_url** | **String** | | [optional]
|
10
|
+
|
11
|
+
|
@@ -5,6 +5,7 @@ Name | Type | Description | Notes
|
|
5
5
|
------------ | ------------- | ------------- | -------------
|
6
6
|
**submission** | [**Submission**](Submission.md) | | [optional]
|
7
7
|
**errors** | **Array<String>** | | [optional]
|
8
|
+
**data_requests** | [**Array<SubmissionDataRequest>**](SubmissionDataRequest.md) | | [optional]
|
8
9
|
**status** | **String** | | [optional]
|
9
10
|
|
10
11
|
|
data/docs/PDFApi.md
CHANGED
@@ -7,10 +7,12 @@ Method | HTTP request | Description
|
|
7
7
|
[**batch_generate_pdf_v1**](PDFApi.md#batch_generate_pdf_v1) | **POST** /templates/{template_id}/submissions/batch | Generates multiple PDFs
|
8
8
|
[**batch_generate_pdfs**](PDFApi.md#batch_generate_pdfs) | **POST** /submissions/batches | Generates multiple PDFs
|
9
9
|
[**combine_submissions**](PDFApi.md#combine_submissions) | **POST** /combined_submissions | Merge generated PDFs together
|
10
|
+
[**create_data_request_token**](PDFApi.md#create_data_request_token) | **POST** /data_requests/{data_request_id}/tokens | Creates a new data request token for form authentication
|
10
11
|
[**expire_combined_submission**](PDFApi.md#expire_combined_submission) | **DELETE** /combined_submissions/{combined_submission_id} | Expire a combined submission
|
11
12
|
[**expire_submission**](PDFApi.md#expire_submission) | **DELETE** /submissions/{submission_id} | Expire a PDF submission
|
12
13
|
[**generate_pdf**](PDFApi.md#generate_pdf) | **POST** /templates/{template_id}/submissions | Generates a new PDF
|
13
14
|
[**get_combined_submission**](PDFApi.md#get_combined_submission) | **GET** /combined_submissions/{combined_submission_id} | Check the status of a combined submission (merged PDFs)
|
15
|
+
[**get_data_request**](PDFApi.md#get_data_request) | **GET** /data_requests/{data_request_id} | Look up a submission data request
|
14
16
|
[**get_submission**](PDFApi.md#get_submission) | **GET** /submissions/{submission_id} | Check the status of a PDF
|
15
17
|
[**get_submission_batch**](PDFApi.md#get_submission_batch) | **GET** /submissions/batches/{submission_batch_id} | Check the status of a submission batch job
|
16
18
|
[**get_templates**](PDFApi.md#get_templates) | **GET** /templates | Get a list of all templates
|
@@ -18,7 +20,7 @@ Method | HTTP request | Description
|
|
18
20
|
|
19
21
|
|
20
22
|
# **batch_generate_pdf_v1**
|
21
|
-
> Array<
|
23
|
+
> Array<CreateSubmissionBatchV1SubmissionsResponse> batch_generate_pdf_v1(template_id, create_submission_data)
|
22
24
|
|
23
25
|
Generates multiple PDFs
|
24
26
|
|
@@ -55,7 +57,7 @@ Name | Type | Description | Notes
|
|
55
57
|
|
56
58
|
### Return type
|
57
59
|
|
58
|
-
[**Array<
|
60
|
+
[**Array<CreateSubmissionBatchV1SubmissionsResponse>**](CreateSubmissionBatchV1SubmissionsResponse.md)
|
59
61
|
|
60
62
|
### Authorization
|
61
63
|
|
@@ -166,6 +168,55 @@ Name | Type | Description | Notes
|
|
166
168
|
|
167
169
|
|
168
170
|
|
171
|
+
# **create_data_request_token**
|
172
|
+
> CreateSubmissionDataRequestTokenResponse create_data_request_token(data_request_id)
|
173
|
+
|
174
|
+
Creates a new data request token for form authentication
|
175
|
+
|
176
|
+
### Example
|
177
|
+
```ruby
|
178
|
+
# load the gem
|
179
|
+
require 'form_api'
|
180
|
+
# setup authorization
|
181
|
+
FormAPI.configure do |config|
|
182
|
+
# Configure HTTP basic authorization: api_token_basic
|
183
|
+
config.username = 'YOUR USERNAME'
|
184
|
+
config.password = 'YOUR PASSWORD'
|
185
|
+
end
|
186
|
+
|
187
|
+
api_instance = FormAPI::PDFApi.new
|
188
|
+
data_request_id = 'drq_000000000000000001' # String |
|
189
|
+
|
190
|
+
begin
|
191
|
+
#Creates a new data request token for form authentication
|
192
|
+
result = api_instance.create_data_request_token(data_request_id)
|
193
|
+
p result
|
194
|
+
rescue FormAPI::ApiError => e
|
195
|
+
puts "Exception when calling PDFApi->create_data_request_token: #{e}"
|
196
|
+
end
|
197
|
+
```
|
198
|
+
|
199
|
+
### Parameters
|
200
|
+
|
201
|
+
Name | Type | Description | Notes
|
202
|
+
------------- | ------------- | ------------- | -------------
|
203
|
+
**data_request_id** | **String**| |
|
204
|
+
|
205
|
+
### Return type
|
206
|
+
|
207
|
+
[**CreateSubmissionDataRequestTokenResponse**](CreateSubmissionDataRequestTokenResponse.md)
|
208
|
+
|
209
|
+
### Authorization
|
210
|
+
|
211
|
+
[api_token_basic](../README.md#api_token_basic)
|
212
|
+
|
213
|
+
### HTTP request headers
|
214
|
+
|
215
|
+
- **Content-Type**: Not defined
|
216
|
+
- **Accept**: application/json
|
217
|
+
|
218
|
+
|
219
|
+
|
169
220
|
# **expire_combined_submission**
|
170
221
|
> CombinedSubmission expire_combined_submission(combined_submission_id)
|
171
222
|
|
@@ -364,6 +415,55 @@ Name | Type | Description | Notes
|
|
364
415
|
|
365
416
|
|
366
417
|
|
418
|
+
# **get_data_request**
|
419
|
+
> SubmissionDataRequest get_data_request(data_request_id)
|
420
|
+
|
421
|
+
Look up a submission data request
|
422
|
+
|
423
|
+
### Example
|
424
|
+
```ruby
|
425
|
+
# load the gem
|
426
|
+
require 'form_api'
|
427
|
+
# setup authorization
|
428
|
+
FormAPI.configure do |config|
|
429
|
+
# Configure HTTP basic authorization: api_token_basic
|
430
|
+
config.username = 'YOUR USERNAME'
|
431
|
+
config.password = 'YOUR PASSWORD'
|
432
|
+
end
|
433
|
+
|
434
|
+
api_instance = FormAPI::PDFApi.new
|
435
|
+
data_request_id = 'drq_000000000000000001' # String |
|
436
|
+
|
437
|
+
begin
|
438
|
+
#Look up a submission data request
|
439
|
+
result = api_instance.get_data_request(data_request_id)
|
440
|
+
p result
|
441
|
+
rescue FormAPI::ApiError => e
|
442
|
+
puts "Exception when calling PDFApi->get_data_request: #{e}"
|
443
|
+
end
|
444
|
+
```
|
445
|
+
|
446
|
+
### Parameters
|
447
|
+
|
448
|
+
Name | Type | Description | Notes
|
449
|
+
------------- | ------------- | ------------- | -------------
|
450
|
+
**data_request_id** | **String**| |
|
451
|
+
|
452
|
+
### Return type
|
453
|
+
|
454
|
+
[**SubmissionDataRequest**](SubmissionDataRequest.md)
|
455
|
+
|
456
|
+
### Authorization
|
457
|
+
|
458
|
+
[api_token_basic](../README.md#api_token_basic)
|
459
|
+
|
460
|
+
### HTTP request headers
|
461
|
+
|
462
|
+
- **Content-Type**: Not defined
|
463
|
+
- **Accept**: application/json
|
464
|
+
|
465
|
+
|
466
|
+
|
367
467
|
# **get_submission**
|
368
468
|
> Submission get_submission(submission_id)
|
369
469
|
|
@@ -0,0 +1,16 @@
|
|
1
|
+
# FormAPI::SubmissionDataRequest
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**id** | **String** | |
|
7
|
+
**name** | **String** | |
|
8
|
+
**email** | **String** | |
|
9
|
+
**order** | **Float** | |
|
10
|
+
**fields** | **Array<String>** | |
|
11
|
+
**metadata** | **Object** | |
|
12
|
+
**state** | **String** | |
|
13
|
+
**viewed_at** | **String** | |
|
14
|
+
**completed_at** | **String** | |
|
15
|
+
|
16
|
+
|
data/form_api.gemspec
CHANGED
@@ -19,11 +19,11 @@ Gem::Specification.new do |s|
|
|
19
19
|
s.name = "form_api"
|
20
20
|
s.version = FormAPI::VERSION
|
21
21
|
s.platform = Gem::Platform::RUBY
|
22
|
-
s.authors = ["Form Applications Inc."]
|
22
|
+
s.authors = ["Form Applications, Inc."]
|
23
23
|
s.email = ["support@formapi.io"]
|
24
24
|
s.homepage = "https://github.com/FormAPI/formapi-ruby"
|
25
25
|
s.summary = "FormAPI API Client"
|
26
|
-
s.description = "Client library for the FormAPI PDF generation service"
|
26
|
+
s.description = "Client library for the FormAPI PDF generation and e-signature service"
|
27
27
|
s.license = 'MIT'
|
28
28
|
s.required_ruby_version = ">= 1.9"
|
29
29
|
|
data/lib/form_api.rb
CHANGED
@@ -23,15 +23,19 @@ require 'form_api/models/combined_submission'
|
|
23
23
|
require 'form_api/models/combined_submission_data'
|
24
24
|
require 'form_api/models/create_combined_submission_response'
|
25
25
|
require 'form_api/models/create_submission_batch_response'
|
26
|
+
require 'form_api/models/create_submission_batch_submissions_response'
|
27
|
+
require 'form_api/models/create_submission_batch_v1_submissions_response'
|
26
28
|
require 'form_api/models/create_submission_data'
|
27
29
|
require 'form_api/models/create_submission_data_batch_request'
|
30
|
+
require 'form_api/models/create_submission_data_request_token_response'
|
31
|
+
require 'form_api/models/create_submission_data_request_token_response_token'
|
28
32
|
require 'form_api/models/create_submission_response'
|
29
|
-
require 'form_api/models/create_submission_response1'
|
30
33
|
require 'form_api/models/error'
|
31
34
|
require 'form_api/models/invalid_request'
|
32
35
|
require 'form_api/models/submission'
|
33
36
|
require 'form_api/models/submission_batch'
|
34
37
|
require 'form_api/models/submission_batch_data'
|
38
|
+
require 'form_api/models/submission_data_request'
|
35
39
|
require 'form_api/models/template'
|
36
40
|
|
37
41
|
# APIs
|
data/lib/form_api/api/client.rb
CHANGED
@@ -60,7 +60,7 @@ module FormAPI
|
|
60
60
|
return response unless options[:wait]
|
61
61
|
|
62
62
|
batch = response.submission_batch
|
63
|
-
|
63
|
+
submission_responses = response.submissions
|
64
64
|
timeout = options[:timeout] || 600
|
65
65
|
start_time = Time.now
|
66
66
|
|
@@ -83,7 +83,7 @@ module FormAPI
|
|
83
83
|
next h unless sub && sub.id
|
84
84
|
h[sub.id] = sub
|
85
85
|
end
|
86
|
-
|
86
|
+
submission_responses.each do |sub|
|
87
87
|
# If there's no submission it's already an error.
|
88
88
|
next unless sub.submission
|
89
89
|
updated_sub = updated_submissions_hash[sub.submission.id]
|
@@ -99,7 +99,7 @@ module FormAPI
|
|
99
99
|
CreateSubmissionBatchResponse.new(
|
100
100
|
status: batch.state == 'processed' ? 'success' : 'error',
|
101
101
|
submission_batch: batch,
|
102
|
-
submissions:
|
102
|
+
submissions: submission_responses
|
103
103
|
)
|
104
104
|
end
|
105
105
|
|
data/lib/form_api/api/pdf_api.rb
CHANGED
@@ -23,7 +23,7 @@ module FormAPI
|
|
23
23
|
# @param template_id
|
24
24
|
# @param create_submission_data
|
25
25
|
# @param [Hash] opts the optional parameters
|
26
|
-
# @return [Array<
|
26
|
+
# @return [Array<CreateSubmissionBatchV1SubmissionsResponse>]
|
27
27
|
def batch_generate_pdf_v1(template_id, create_submission_data, opts = {})
|
28
28
|
data, _status_code, _headers = batch_generate_pdf_v1_with_http_info(template_id, create_submission_data, opts)
|
29
29
|
data
|
@@ -33,7 +33,7 @@ module FormAPI
|
|
33
33
|
# @param template_id
|
34
34
|
# @param create_submission_data
|
35
35
|
# @param [Hash] opts the optional parameters
|
36
|
-
# @return [Array<(Array<
|
36
|
+
# @return [Array<(Array<CreateSubmissionBatchV1SubmissionsResponse>, Fixnum, Hash)>] Array<CreateSubmissionBatchV1SubmissionsResponse> data, response status code and response headers
|
37
37
|
def batch_generate_pdf_v1_with_http_info(template_id, create_submission_data, opts = {})
|
38
38
|
if @api_client.config.debugging
|
39
39
|
@api_client.config.logger.debug 'Calling API: PDFApi.batch_generate_pdf_v1 ...'
|
@@ -71,7 +71,7 @@ module FormAPI
|
|
71
71
|
:form_params => form_params,
|
72
72
|
:body => post_body,
|
73
73
|
:auth_names => auth_names,
|
74
|
-
:return_type => 'Array<
|
74
|
+
:return_type => 'Array<CreateSubmissionBatchV1SubmissionsResponse>')
|
75
75
|
if @api_client.config.debugging
|
76
76
|
@api_client.config.logger.debug "API called: PDFApi#batch_generate_pdf_v1\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
77
77
|
end
|
@@ -184,6 +184,57 @@ module FormAPI
|
|
184
184
|
return data, status_code, headers
|
185
185
|
end
|
186
186
|
|
187
|
+
# Creates a new data request token for form authentication
|
188
|
+
# @param data_request_id
|
189
|
+
# @param [Hash] opts the optional parameters
|
190
|
+
# @return [CreateSubmissionDataRequestTokenResponse]
|
191
|
+
def create_data_request_token(data_request_id, opts = {})
|
192
|
+
data, _status_code, _headers = create_data_request_token_with_http_info(data_request_id, opts)
|
193
|
+
data
|
194
|
+
end
|
195
|
+
|
196
|
+
# Creates a new data request token for form authentication
|
197
|
+
# @param data_request_id
|
198
|
+
# @param [Hash] opts the optional parameters
|
199
|
+
# @return [Array<(CreateSubmissionDataRequestTokenResponse, Fixnum, Hash)>] CreateSubmissionDataRequestTokenResponse data, response status code and response headers
|
200
|
+
def create_data_request_token_with_http_info(data_request_id, opts = {})
|
201
|
+
if @api_client.config.debugging
|
202
|
+
@api_client.config.logger.debug 'Calling API: PDFApi.create_data_request_token ...'
|
203
|
+
end
|
204
|
+
# verify the required parameter 'data_request_id' is set
|
205
|
+
if @api_client.config.client_side_validation && data_request_id.nil?
|
206
|
+
fail ArgumentError, "Missing the required parameter 'data_request_id' when calling PDFApi.create_data_request_token"
|
207
|
+
end
|
208
|
+
# resource path
|
209
|
+
local_var_path = '/data_requests/{data_request_id}/tokens'.sub('{' + 'data_request_id' + '}', data_request_id.to_s)
|
210
|
+
|
211
|
+
# query parameters
|
212
|
+
query_params = {}
|
213
|
+
|
214
|
+
# header parameters
|
215
|
+
header_params = {}
|
216
|
+
# HTTP header 'Accept' (if needed)
|
217
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
218
|
+
|
219
|
+
# form parameters
|
220
|
+
form_params = {}
|
221
|
+
|
222
|
+
# http body (model)
|
223
|
+
post_body = nil
|
224
|
+
auth_names = ['api_token_basic']
|
225
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path,
|
226
|
+
:header_params => header_params,
|
227
|
+
:query_params => query_params,
|
228
|
+
:form_params => form_params,
|
229
|
+
:body => post_body,
|
230
|
+
:auth_names => auth_names,
|
231
|
+
:return_type => 'CreateSubmissionDataRequestTokenResponse')
|
232
|
+
if @api_client.config.debugging
|
233
|
+
@api_client.config.logger.debug "API called: PDFApi#create_data_request_token\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
234
|
+
end
|
235
|
+
return data, status_code, headers
|
236
|
+
end
|
237
|
+
|
187
238
|
# Expire a combined submission
|
188
239
|
# @param combined_submission_id
|
189
240
|
# @param [Hash] opts the optional parameters
|
@@ -396,6 +447,57 @@ module FormAPI
|
|
396
447
|
return data, status_code, headers
|
397
448
|
end
|
398
449
|
|
450
|
+
# Look up a submission data request
|
451
|
+
# @param data_request_id
|
452
|
+
# @param [Hash] opts the optional parameters
|
453
|
+
# @return [SubmissionDataRequest]
|
454
|
+
def get_data_request(data_request_id, opts = {})
|
455
|
+
data, _status_code, _headers = get_data_request_with_http_info(data_request_id, opts)
|
456
|
+
data
|
457
|
+
end
|
458
|
+
|
459
|
+
# Look up a submission data request
|
460
|
+
# @param data_request_id
|
461
|
+
# @param [Hash] opts the optional parameters
|
462
|
+
# @return [Array<(SubmissionDataRequest, Fixnum, Hash)>] SubmissionDataRequest data, response status code and response headers
|
463
|
+
def get_data_request_with_http_info(data_request_id, opts = {})
|
464
|
+
if @api_client.config.debugging
|
465
|
+
@api_client.config.logger.debug 'Calling API: PDFApi.get_data_request ...'
|
466
|
+
end
|
467
|
+
# verify the required parameter 'data_request_id' is set
|
468
|
+
if @api_client.config.client_side_validation && data_request_id.nil?
|
469
|
+
fail ArgumentError, "Missing the required parameter 'data_request_id' when calling PDFApi.get_data_request"
|
470
|
+
end
|
471
|
+
# resource path
|
472
|
+
local_var_path = '/data_requests/{data_request_id}'.sub('{' + 'data_request_id' + '}', data_request_id.to_s)
|
473
|
+
|
474
|
+
# query parameters
|
475
|
+
query_params = {}
|
476
|
+
|
477
|
+
# header parameters
|
478
|
+
header_params = {}
|
479
|
+
# HTTP header 'Accept' (if needed)
|
480
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
481
|
+
|
482
|
+
# form parameters
|
483
|
+
form_params = {}
|
484
|
+
|
485
|
+
# http body (model)
|
486
|
+
post_body = nil
|
487
|
+
auth_names = ['api_token_basic']
|
488
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path,
|
489
|
+
:header_params => header_params,
|
490
|
+
:query_params => query_params,
|
491
|
+
:form_params => form_params,
|
492
|
+
:body => post_body,
|
493
|
+
:auth_names => auth_names,
|
494
|
+
:return_type => 'SubmissionDataRequest')
|
495
|
+
if @api_client.config.debugging
|
496
|
+
@api_client.config.logger.debug "API called: PDFApi#get_data_request\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
497
|
+
end
|
498
|
+
return data, status_code, headers
|
499
|
+
end
|
500
|
+
|
399
501
|
# Check the status of a PDF
|
400
502
|
# @param submission_id
|
401
503
|
# @param [Hash] opts the optional parameters
|