form_api 0.2.0 → 1.0.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (94) hide show
  1. checksums.yaml +4 -4
  2. data/.gitignore +1 -1
  3. data/{.swagger-codegen-ignore → .openapi-generator-ignore} +3 -3
  4. data/.openapi-generator/VERSION +1 -0
  5. data/.rubocop.yml +154 -0
  6. data/Gemfile.lock +15 -16
  7. data/README.md +30 -28
  8. data/Rakefile +2 -0
  9. data/docs/{InlineResponse422.md → AuthenticationError.md} +3 -3
  10. data/docs/{InlineResponse401.md → AuthenticationSuccessResponse.md} +2 -2
  11. data/docs/CombinedSubmission.md +14 -0
  12. data/docs/CombinedSubmissionData.md +11 -0
  13. data/docs/CreateCombinedSubmissionResponse.md +10 -0
  14. data/docs/CreateSubmissionBatchResponse.md +12 -0
  15. data/docs/CreateSubmissionData.md +12 -0
  16. data/docs/CreateSubmissionDataBatchRequest.md +13 -0
  17. data/docs/CreateSubmissionResponse.md +10 -0
  18. data/docs/CreateSubmissionResponse1.md +10 -0
  19. data/docs/{InlineResponse200.md → Error.md} +3 -2
  20. data/docs/{InlineResponse400.md → InvalidRequest.md} +3 -3
  21. data/docs/PDFApi.md +148 -64
  22. data/docs/Submission.md +16 -0
  23. data/docs/SubmissionBatch.md +16 -0
  24. data/docs/SubmissionBatchData.md +11 -0
  25. data/docs/Template.md +21 -0
  26. data/form_api.gemspec +6 -11
  27. data/git_push.sh +3 -3
  28. data/lib/form_api.rb +22 -15
  29. data/lib/form_api/api/client.rb +91 -38
  30. data/lib/form_api/api/pdf_api.rb +222 -109
  31. data/lib/form_api/api_client.rb +13 -13
  32. data/lib/form_api/api_error.rb +3 -3
  33. data/lib/form_api/configuration.rb +26 -5
  34. data/lib/form_api/models/{inline_response_201_1.rb → authentication_error.rb} +25 -29
  35. data/lib/form_api/models/{inline_response_200.rb → authentication_success_response.rb} +15 -24
  36. data/lib/form_api/models/{inline_response_201_combined_submission.rb → combined_submission.rb} +42 -66
  37. data/lib/form_api/models/{create_combined_submission_body.rb → combined_submission_data.rb} +13 -18
  38. data/lib/form_api/models/{inline_response_201.rb → create_combined_submission_response.rb} +37 -35
  39. data/lib/form_api/models/create_submission_batch_response.rb +257 -0
  40. data/lib/form_api/models/{create_submission_batch_body.rb → create_submission_data.rb} +32 -19
  41. data/lib/form_api/models/{create_submission_body.rb → create_submission_data_batch_request.rb} +45 -18
  42. data/lib/form_api/models/create_submission_response.rb +237 -0
  43. data/lib/form_api/models/create_submission_response1.rb +237 -0
  44. data/lib/form_api/models/{inline_response_400.rb → error.rb} +17 -21
  45. data/lib/form_api/models/{inline_response_422.rb → invalid_request.rb} +17 -21
  46. data/lib/form_api/models/{templatestemplate_idsubmissionsbatch_submission.rb → submission.rb} +40 -26
  47. data/lib/form_api/models/submission_batch.rb +291 -0
  48. data/lib/form_api/models/{inline_response_401.rb → submission_batch_data.rb} +48 -24
  49. data/lib/form_api/models/{inline_response_200_1.rb → template.rb} +88 -152
  50. data/lib/form_api/version.rb +4 -4
  51. data/spec/api/client_spec.rb +197 -23
  52. data/spec/api/pdf_api_spec.rb +168 -63
  53. data/spec/api_client_spec.rb +37 -37
  54. data/spec/configuration_spec.rb +11 -11
  55. data/spec/models/authentication_error_spec.rb +51 -0
  56. data/spec/models/authentication_success_response_spec.rb +45 -0
  57. data/spec/models/combined_submission_data_spec.rb +59 -0
  58. data/spec/models/combined_submission_spec.rb +81 -0
  59. data/spec/models/create_combined_submission_response_spec.rb +57 -0
  60. data/spec/models/create_submission_batch_response_spec.rb +69 -0
  61. data/spec/models/create_submission_data_batch_request_spec.rb +71 -0
  62. data/spec/models/create_submission_data_spec.rb +65 -0
  63. data/spec/models/create_submission_response1_spec.rb +57 -0
  64. data/spec/models/create_submission_response_spec.rb +57 -0
  65. data/spec/models/error_spec.rb +51 -0
  66. data/spec/models/invalid_request_spec.rb +51 -0
  67. data/spec/models/submission_batch_data_spec.rb +59 -0
  68. data/spec/models/submission_batch_spec.rb +93 -0
  69. data/spec/models/submission_spec.rb +93 -0
  70. data/spec/models/template_spec.rb +123 -0
  71. data/spec/spec_helper.rb +3 -14
  72. metadata +70 -95
  73. data/.swagger-codegen/VERSION +0 -1
  74. data/docs/CreateCombinedSubmissionBody.md +0 -11
  75. data/docs/CreateSubmissionBatchBody.md +0 -10
  76. data/docs/CreateSubmissionBody.md +0 -10
  77. data/docs/InlineResponse2001.md +0 -21
  78. data/docs/InlineResponse201.md +0 -9
  79. data/docs/InlineResponse2011.md +0 -9
  80. data/docs/InlineResponse201CombinedSubmission.md +0 -14
  81. data/docs/TemplatestemplateIdsubmissionsbatchSubmission.md +0 -14
  82. data/spec/models/create_combined_submission_body_spec.rb +0 -60
  83. data/spec/models/create_submission_batch_body_spec.rb +0 -54
  84. data/spec/models/create_submission_body_spec.rb +0 -54
  85. data/spec/models/inline_response_200_1_spec.rb +0 -124
  86. data/spec/models/inline_response_200_spec.rb +0 -46
  87. data/spec/models/inline_response_201_1_spec.rb +0 -52
  88. data/spec/models/inline_response_201_combined_submission_spec.rb +0 -82
  89. data/spec/models/inline_response_201_spec.rb +0 -52
  90. data/spec/models/inline_response_400_spec.rb +0 -52
  91. data/spec/models/inline_response_401_spec.rb +0 -42
  92. data/spec/models/inline_response_422_spec.rb +0 -52
  93. data/spec/models/templatestemplate_idsubmissionsbatch_submission_spec.rb +0 -82
  94. data/spec/vcr_cassettes/FormAPI_Client/should_generate_a_PDF_and_wait_for_the_submission_to_be_processed.yml +0 -127
data/docs/CreateSubmissionData.md ADDED
@@ -0,0 +1,12 @@
1
+ # FormAPI::CreateSubmissionData
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **test** | **BOOLEAN** | | [optional]
7
+ **data** | **Object** | |
8
+ **html** | **String** | | [optional]
9
+ **css** | **String** | | [optional]
10
+ **metadata** | **Object** | | [optional]
11
+
12
+
data/docs/CreateSubmissionDataBatchRequest.md ADDED
@@ -0,0 +1,13 @@
1
+ # FormAPI::CreateSubmissionDataBatchRequest
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **template_id** | **String** | |
7
+ **test** | **BOOLEAN** | | [optional]
8
+ **data** | **Object** | |
9
+ **html** | **String** | | [optional]
10
+ **css** | **String** | | [optional]
11
+ **metadata** | **Object** | | [optional]
12
+
13
+
data/docs/CreateSubmissionResponse.md ADDED
@@ -0,0 +1,10 @@
1
+ # FormAPI::CreateSubmissionResponse
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
+
data/docs/CreateSubmissionResponse1.md ADDED
@@ -0,0 +1,10 @@
1
+ # FormAPI::CreateSubmissionResponse1
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
+
data/docs/{InlineResponse200.md → Error.md} RENAMED
@@ -1,8 +1,9 @@
1
- # FormAPI::InlineResponse200
1
+ # FormAPI::Error
2
2
 
3
3
  ## Properties
4
4
  Name | Type | Description | Notes
5
5
  ------------ | ------------- | ------------- | -------------
6
- **status** | **String** | |
6
+ **status** | **String** | |
7
+ **error** | **String** | |
7
8
 
8
9
 
data/docs/{InlineResponse400.md → InvalidRequest.md} RENAMED
@@ -1,9 +1,9 @@
1
- # FormAPI::InlineResponse400
1
+ # FormAPI::InvalidRequest
2
2
 
3
3
  ## Properties
4
4
  Name | Type | Description | Notes
5
5
  ------------ | ------------- | ------------- | -------------
6
- **status** | **String** | |
7
- **error** | **String** | |
6
+ **status** | **String** | |
7
+ **errors** | **Array<String>** | |
8
8
 
9
9
 
data/docs/PDFApi.md CHANGED
@@ -4,19 +4,21 @@ All URIs are relative to *https://app.formapi.io/api/v1*
4
4
 
5
5
  Method | HTTP request | Description
6
6
  ------------- | ------------- | -------------
7
- [**batch_generate_pdf**](PDFApi.md#batch_generate_pdf) | **POST** /templates/{template_id}/submissions/batch | Generates multiple PDFs
7
+ [**batch_generate_pdf_v1**](PDFApi.md#batch_generate_pdf_v1) | **POST** /templates/{template_id}/submissions/batch | Generates multiple PDFs
8
+ [**batch_generate_pdfs**](PDFApi.md#batch_generate_pdfs) | **POST** /submissions/batches | Generates multiple PDFs
8
9
  [**combine_submissions**](PDFApi.md#combine_submissions) | **POST** /combined_submissions | Merge generated PDFs together
9
10
  [**expire_combined_submission**](PDFApi.md#expire_combined_submission) | **DELETE** /combined_submissions/{combined_submission_id} | Expire a combined submission
10
11
  [**expire_submission**](PDFApi.md#expire_submission) | **DELETE** /submissions/{submission_id} | Expire a PDF submission
11
12
  [**generate_pdf**](PDFApi.md#generate_pdf) | **POST** /templates/{template_id}/submissions | Generates a new PDF
12
13
  [**get_combined_submission**](PDFApi.md#get_combined_submission) | **GET** /combined_submissions/{combined_submission_id} | Check the status of a combined submission (merged PDFs)
13
14
  [**get_submission**](PDFApi.md#get_submission) | **GET** /submissions/{submission_id} | Check the status of a PDF
15
+ [**get_submission_batch**](PDFApi.md#get_submission_batch) | **GET** /submissions/batches/{submission_batch_id} | Check the status of a submission batch job
14
16
  [**get_templates**](PDFApi.md#get_templates) | **GET** /templates | Get a list of all templates
15
17
  [**test_authentication**](PDFApi.md#test_authentication) | **GET** /authentication | Test Authentication
16
18
 
17
19
 
18
- # **batch_generate_pdf**
19
- > Array<InlineResponse2011> batch_generate_pdf(template_id, opts)
20
+ # **batch_generate_pdf_v1**
21
+ > Array<CreateSubmissionResponse> batch_generate_pdf_v1(template_id, create_submission_data)
20
22
 
21
23
  Generates multiple PDFs
22
24
 
@@ -32,19 +34,65 @@ FormAPI.configure do |config|
32
34
  end
33
35
 
34
36
  api_instance = FormAPI::PDFApi.new
37
+ template_id = 'tpl_000000000000000001' # String |
38
+ create_submission_data = nil # Array<CreateSubmissionData> |
35
39
 
36
- template_id = "template_id_example" # String |
40
+ begin
41
+ #Generates multiple PDFs
42
+ result = api_instance.batch_generate_pdf_v1(template_id, create_submission_data)
43
+ p result
44
+ rescue FormAPI::ApiError => e
45
+ puts "Exception when calling PDFApi->batch_generate_pdf_v1: #{e}"
46
+ end
47
+ ```
48
+
49
+ ### Parameters
50
+
51
+ Name | Type | Description | Notes
52
+ ------------- | ------------- | ------------- | -------------
53
+ **template_id** | **String**| |
54
+ **create_submission_data** | [**Array&lt;CreateSubmissionData&gt;**](Array.md)| |
55
+
56
+ ### Return type
57
+
58
+ [**Array&lt;CreateSubmissionResponse&gt;**](CreateSubmissionResponse.md)
59
+
60
+ ### Authorization
61
+
62
+ [api_token_basic](../README.md#api_token_basic)
63
+
64
+ ### HTTP request headers
65
+
66
+ - **Content-Type**: application/json
67
+ - **Accept**: application/json
37
68
 
38
- opts = {
39
- create_submission_batch_body: [FormAPI::CreateSubmissionBatchBody.new] # Array<CreateSubmissionBatchBody> |
40
- }
69
+
70
+
71
+ # **batch_generate_pdfs**
72
+ > CreateSubmissionBatchResponse batch_generate_pdfs(submission_batch_data)
73
+
74
+ Generates multiple PDFs
75
+
76
+ ### Example
77
+ ```ruby
78
+ # load the gem
79
+ require 'form_api'
80
+ # setup authorization
81
+ FormAPI.configure do |config|
82
+ # Configure HTTP basic authorization: api_token_basic
83
+ config.username = 'YOUR USERNAME'
84
+ config.password = 'YOUR PASSWORD'
85
+ end
86
+
87
+ api_instance = FormAPI::PDFApi.new
88
+ submission_batch_data = FormAPI::SubmissionBatchData.new # SubmissionBatchData |
41
89
 
42
90
  begin
43
91
  #Generates multiple PDFs
44
- result = api_instance.batch_generate_pdf(template_id, opts)
92
+ result = api_instance.batch_generate_pdfs(submission_batch_data)
45
93
  p result
46
94
  rescue FormAPI::ApiError => e
47
- puts "Exception when calling PDFApi->batch_generate_pdf: #{e}"
95
+ puts "Exception when calling PDFApi->batch_generate_pdfs: #{e}"
48
96
  end
49
97
  ```
50
98
 
@@ -52,12 +100,11 @@ end
52
100
 
53
101
  Name | Type | Description | Notes
54
102
  ------------- | ------------- | ------------- | -------------
55
- **template_id** | **String**| |
56
- **create_submission_batch_body** | [**Array&lt;CreateSubmissionBatchBody&gt;**](CreateSubmissionBatchBody.md)| | [optional]
103
+ **submission_batch_data** | [**SubmissionBatchData**](SubmissionBatchData.md)| |
57
104
 
58
105
  ### Return type
59
106
 
60
- [**Array&lt;InlineResponse2011&gt;**](InlineResponse2011.md)
107
+ [**CreateSubmissionBatchResponse**](CreateSubmissionBatchResponse.md)
61
108
 
62
109
  ### Authorization
63
110
 
@@ -71,7 +118,7 @@ Name | Type | Description | Notes
71
118
 
72
119
 
73
120
  # **combine_submissions**
74
- > InlineResponse201 combine_submissions(opts)
121
+ > CreateCombinedSubmissionResponse combine_submissions(combined_submission_data)
75
122
 
76
123
  Merge generated PDFs together
77
124
 
@@ -87,14 +134,11 @@ FormAPI.configure do |config|
87
134
  end
88
135
 
89
136
  api_instance = FormAPI::PDFApi.new
90
-
91
- opts = {
92
- create_combined_submission_body: FormAPI::CreateCombinedSubmissionBody.new # CreateCombinedSubmissionBody |
93
- }
137
+ combined_submission_data = FormAPI::CombinedSubmissionData.new # CombinedSubmissionData |
94
138
 
95
139
  begin
96
140
  #Merge generated PDFs together
97
- result = api_instance.combine_submissions(opts)
141
+ result = api_instance.combine_submissions(combined_submission_data)
98
142
  p result
99
143
  rescue FormAPI::ApiError => e
100
144
  puts "Exception when calling PDFApi->combine_submissions: #{e}"
@@ -105,11 +149,11 @@ end
105
149
 
106
150
  Name | Type | Description | Notes
107
151
  ------------- | ------------- | ------------- | -------------
108
- **create_combined_submission_body** | [**CreateCombinedSubmissionBody**](CreateCombinedSubmissionBody.md)| | [optional]
152
+ **combined_submission_data** | [**CombinedSubmissionData**](CombinedSubmissionData.md)| |
109
153
 
110
154
  ### Return type
111
155
 
112
- [**InlineResponse201**](InlineResponse201.md)
156
+ [**CreateCombinedSubmissionResponse**](CreateCombinedSubmissionResponse.md)
113
157
 
114
158
  ### Authorization
115
159
 
@@ -123,7 +167,7 @@ Name | Type | Description | Notes
123
167
 
124
168
 
125
169
  # **expire_combined_submission**
126
- > InlineResponse201CombinedSubmission expire_combined_submission(combined_submission_id)
170
+ > CombinedSubmission expire_combined_submission(combined_submission_id)
127
171
 
128
172
  Expire a combined submission
129
173
 
@@ -139,9 +183,7 @@ FormAPI.configure do |config|
139
183
  end
140
184
 
141
185
  api_instance = FormAPI::PDFApi.new
142
-
143
- combined_submission_id = "combined_submission_id_example" # String |
144
-
186
+ combined_submission_id = 'com_000000000000000001' # String |
145
187
 
146
188
  begin
147
189
  #Expire a combined submission
@@ -156,11 +198,11 @@ end
156
198
 
157
199
  Name | Type | Description | Notes
158
200
  ------------- | ------------- | ------------- | -------------
159
- **combined_submission_id** | **String**| |
201
+ **combined_submission_id** | **String**| |
160
202
 
161
203
  ### Return type
162
204
 
163
- [**InlineResponse201CombinedSubmission**](InlineResponse201CombinedSubmission.md)
205
+ [**CombinedSubmission**](CombinedSubmission.md)
164
206
 
165
207
  ### Authorization
166
208
 
@@ -174,7 +216,7 @@ Name | Type | Description | Notes
174
216
 
175
217
 
176
218
  # **expire_submission**
177
- > TemplatestemplateIdsubmissionsbatchSubmission expire_submission(submission_id)
219
+ > Submission expire_submission(submission_id)
178
220
 
179
221
  Expire a PDF submission
180
222
 
@@ -190,9 +232,7 @@ FormAPI.configure do |config|
190
232
  end
191
233
 
192
234
  api_instance = FormAPI::PDFApi.new
193
-
194
- submission_id = "submission_id_example" # String |
195
-
235
+ submission_id = 'sub_000000000000000001' # String |
196
236
 
197
237
  begin
198
238
  #Expire a PDF submission
@@ -207,11 +247,11 @@ end
207
247
 
208
248
  Name | Type | Description | Notes
209
249
  ------------- | ------------- | ------------- | -------------
210
- **submission_id** | **String**| |
250
+ **submission_id** | **String**| |
211
251
 
212
252
  ### Return type
213
253
 
214
- [**TemplatestemplateIdsubmissionsbatchSubmission**](TemplatestemplateIdsubmissionsbatchSubmission.md)
254
+ [**Submission**](Submission.md)
215
255
 
216
256
  ### Authorization
217
257
 
@@ -225,7 +265,7 @@ Name | Type | Description | Notes
225
265
 
226
266
 
227
267
  # **generate_pdf**
228
- > InlineResponse2011 generate_pdf(template_id, opts)
268
+ > CreateSubmissionResponse generate_pdf(template_id, create_submission_data)
229
269
 
230
270
  Generates a new PDF
231
271
 
@@ -241,16 +281,12 @@ FormAPI.configure do |config|
241
281
  end
242
282
 
243
283
  api_instance = FormAPI::PDFApi.new
244
-
245
- template_id = "template_id_example" # String |
246
-
247
- opts = {
248
- create_submission_body: FormAPI::CreateSubmissionBody.new # CreateSubmissionBody |
249
- }
284
+ template_id = 'tpl_000000000000000001' # String |
285
+ create_submission_data = FormAPI::CreateSubmissionData.new # CreateSubmissionData |
250
286
 
251
287
  begin
252
288
  #Generates a new PDF
253
- result = api_instance.generate_pdf(template_id, opts)
289
+ result = api_instance.generate_pdf(template_id, create_submission_data)
254
290
  p result
255
291
  rescue FormAPI::ApiError => e
256
292
  puts "Exception when calling PDFApi->generate_pdf: #{e}"
@@ -261,12 +297,12 @@ end
261
297
 
262
298
  Name | Type | Description | Notes
263
299
  ------------- | ------------- | ------------- | -------------
264
- **template_id** | **String**| |
265
- **create_submission_body** | [**CreateSubmissionBody**](CreateSubmissionBody.md)| | [optional]
300
+ **template_id** | **String**| |
301
+ **create_submission_data** | [**CreateSubmissionData**](CreateSubmissionData.md)| |
266
302
 
267
303
  ### Return type
268
304
 
269
- [**InlineResponse2011**](InlineResponse2011.md)
305
+ [**CreateSubmissionResponse**](CreateSubmissionResponse.md)
270
306
 
271
307
  ### Authorization
272
308
 
@@ -280,7 +316,7 @@ Name | Type | Description | Notes
280
316
 
281
317
 
282
318
  # **get_combined_submission**
283
- > InlineResponse201CombinedSubmission get_combined_submission(combined_submission_id)
319
+ > CombinedSubmission get_combined_submission(combined_submission_id)
284
320
 
285
321
  Check the status of a combined submission (merged PDFs)
286
322
 
@@ -296,9 +332,7 @@ FormAPI.configure do |config|
296
332
  end
297
333
 
298
334
  api_instance = FormAPI::PDFApi.new
299
-
300
- combined_submission_id = "combined_submission_id_example" # String |
301
-
335
+ combined_submission_id = 'com_000000000000000001' # String |
302
336
 
303
337
  begin
304
338
  #Check the status of a combined submission (merged PDFs)
@@ -313,11 +347,11 @@ end
313
347
 
314
348
  Name | Type | Description | Notes
315
349
  ------------- | ------------- | ------------- | -------------
316
- **combined_submission_id** | **String**| |
350
+ **combined_submission_id** | **String**| |
317
351
 
318
352
  ### Return type
319
353
 
320
- [**InlineResponse201CombinedSubmission**](InlineResponse201CombinedSubmission.md)
354
+ [**CombinedSubmission**](CombinedSubmission.md)
321
355
 
322
356
  ### Authorization
323
357
 
@@ -331,7 +365,7 @@ Name | Type | Description | Notes
331
365
 
332
366
 
333
367
  # **get_submission**
334
- > TemplatestemplateIdsubmissionsbatchSubmission get_submission(submission_id)
368
+ > Submission get_submission(submission_id)
335
369
 
336
370
  Check the status of a PDF
337
371
 
@@ -347,9 +381,7 @@ FormAPI.configure do |config|
347
381
  end
348
382
 
349
383
  api_instance = FormAPI::PDFApi.new
350
-
351
- submission_id = "submission_id_example" # String |
352
-
384
+ submission_id = 'sub_000000000000000001' # String |
353
385
 
354
386
  begin
355
387
  #Check the status of a PDF
@@ -364,11 +396,64 @@ end
364
396
 
365
397
  Name | Type | Description | Notes
366
398
  ------------- | ------------- | ------------- | -------------
367
- **submission_id** | **String**| |
399
+ **submission_id** | **String**| |
400
+
401
+ ### Return type
402
+
403
+ [**Submission**](Submission.md)
404
+
405
+ ### Authorization
406
+
407
+ [api_token_basic](../README.md#api_token_basic)
408
+
409
+ ### HTTP request headers
410
+
411
+ - **Content-Type**: Not defined
412
+ - **Accept**: application/json
413
+
414
+
415
+
416
+ # **get_submission_batch**
417
+ > SubmissionBatch get_submission_batch(submission_batch_id, opts)
418
+
419
+ Check the status of a submission batch job
420
+
421
+ ### Example
422
+ ```ruby
423
+ # load the gem
424
+ require 'form_api'
425
+ # setup authorization
426
+ FormAPI.configure do |config|
427
+ # Configure HTTP basic authorization: api_token_basic
428
+ config.username = 'YOUR USERNAME'
429
+ config.password = 'YOUR PASSWORD'
430
+ end
431
+
432
+ api_instance = FormAPI::PDFApi.new
433
+ submission_batch_id = 'sba_000000000000000001' # String |
434
+ opts = {
435
+ include_submissions: true # BOOLEAN |
436
+ }
437
+
438
+ begin
439
+ #Check the status of a submission batch job
440
+ result = api_instance.get_submission_batch(submission_batch_id, opts)
441
+ p result
442
+ rescue FormAPI::ApiError => e
443
+ puts "Exception when calling PDFApi->get_submission_batch: #{e}"
444
+ end
445
+ ```
446
+
447
+ ### Parameters
448
+
449
+ Name | Type | Description | Notes
450
+ ------------- | ------------- | ------------- | -------------
451
+ **submission_batch_id** | **String**| |
452
+ **include_submissions** | **BOOLEAN**| | [optional]
368
453
 
369
454
  ### Return type
370
455
 
371
- [**TemplatestemplateIdsubmissionsbatchSubmission**](TemplatestemplateIdsubmissionsbatchSubmission.md)
456
+ [**SubmissionBatch**](SubmissionBatch.md)
372
457
 
373
458
  ### Authorization
374
459
 
@@ -382,7 +467,7 @@ Name | Type | Description | Notes
382
467
 
383
468
 
384
469
  # **get_templates**
385
- > Array&lt;InlineResponse2001&gt; get_templates(opts)
470
+ > Array&lt;Template&gt; get_templates(opts)
386
471
 
387
472
  Get a list of all templates
388
473
 
@@ -398,10 +483,9 @@ FormAPI.configure do |config|
398
483
  end
399
484
 
400
485
  api_instance = FormAPI::PDFApi.new
401
-
402
486
  opts = {
403
- page: 56, # Integer | Default: 1
404
- per_page: 56 # Integer | Default: 50
487
+ page: 2, # Integer | Default: 1
488
+ per_page: 1 # Integer | Default: 50
405
489
  }
406
490
 
407
491
  begin
@@ -417,12 +501,12 @@ end
417
501
 
418
502
  Name | Type | Description | Notes
419
503
  ------------- | ------------- | ------------- | -------------
420
- **page** | **Integer**| Default: 1 | [optional]
421
- **per_page** | **Integer**| Default: 50 | [optional]
504
+ **page** | **Integer**| Default: 1 | [optional]
505
+ **per_page** | **Integer**| Default: 50 | [optional]
422
506
 
423
507
  ### Return type
424
508
 
425
- [**Array&lt;InlineResponse2001&gt;**](InlineResponse2001.md)
509
+ [**Array&lt;Template&gt;**](Template.md)
426
510
 
427
511
  ### Authorization
428
512
 
@@ -436,7 +520,7 @@ Name | Type | Description | Notes
436
520
 
437
521
 
438
522
  # **test_authentication**
439
- > InlineResponse200 test_authentication
523
+ > AuthenticationSuccessResponse test_authentication
440
524
 
441
525
  Test Authentication
442
526
 
@@ -467,7 +551,7 @@ This endpoint does not need any parameter.
467
551
 
468
552
  ### Return type
469
553
 
470
- [**InlineResponse200**](InlineResponse200.md)
554
+ [**AuthenticationSuccessResponse**](AuthenticationSuccessResponse.md)
471
555
 
472
556
  ### Authorization
473
557