form_api 1.6.0 → 1.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b28c9f71a22655dd4a6687d49323c40b067371e67654865a4c72455288ad0a20
-  data.tar.gz: 76dfee353e3b53ed4ff7a4f3f75f3407a4e96b6b40e8e6513f7fb7d4d4096a53
+  metadata.gz: 58a777d9e6dc2a11db9e8eb3c3525228743ff6ae1156f374abea9e5789965be2
+  data.tar.gz: fe5a3dca2d77ee29bf169d11f05edda9261f54b4d8c1470ed2939fd57e57504b
 SHA512:
-  metadata.gz: d4becd6ec92face2c93247a67fb09bd0d0c619794c8a87148411832e04a5412a0bf54ae04af7d1c99bf18280df16a6da27782c6201e57f604325372991876118
-  data.tar.gz: 0f201bb33eecbe261883b5d455cb61662d544e34edb560c31d52f5b9d6bf5fe2cd12b081c60a8e9d7c53ba8c65fff7038fa4e67bcac71a9713850f501ae22d9c
+  metadata.gz: 5128eb81f2242d91a8a73a01493cc0ba1d7617bc13f9f234babcce6567739716ddb6b2498ff25f5f5061092298df4d63be74f0402be69661be32f68625069406
+  data.tar.gz: 6c59f305169dce401d6ae88199e1df3eda5e4bffdd3461ba212d4b68d264d4a6ae411e377ca954b93a262cd4a5ef974447a14936b918c47171aca821057c5c30

data/CHANGELOG.md

@@ -1,3 +1,6 @@
+### 1.7.0 [December 23, 2018]
+* Added CustomFiles, and combinePdf call to support many different types of source PDFs. Renamed a few models
+
 ### 1.6.0 [December 18, 2018]
 * Updated API host to api.formapi.io
 

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    form_api (1.6.0)
+    form_api (1.7.0)
       ffi (~> 1.0, >= 1.9.24)
       json (~> 2.1, >= 2.1.0)
       typhoeus (~> 1.0, >= 1.0.1)

data/README.md

@@ -7,7 +7,7 @@ FormAPI is a service that helps you fill out and sign PDF templates.
 This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
 
 - API version: v1
-- Package version: 1.6.0
+- Package version: 1.7.0
 - Build package: io.formapi.codegen.FormApiRubyClientCodegen
 
 ## Installation
@@ -23,15 +23,15 @@ gem build form_api.gemspec
 Then either install the gem locally:
 
 ```shell
-gem install ./form_api-1.6.0.gem
+gem install ./form_api-1.7.0.gem
 ```
-(for development, run `gem install --dev ./form_api-1.6.0.gem` to install the development dependencies)
+(for development, run `gem install --dev ./form_api-1.7.0.gem` to install the development dependencies)
 
 or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
 
 Finally add this to the Gemfile:
 
-    gem 'form_api', '~> 1.6.0'
+    gem 'form_api', '~> 1.7.0'
 
 ### Install from Git
 
@@ -63,11 +63,11 @@ end
 
 api_instance = FormAPI::PDFApi.new
 template_id = 'tpl_000000000000000001' # String | 
-create_submission_data_batch_v1 = nil # Array<CreateSubmissionDataBatchV1> | 
+request_body = nil # Array<Object> | 
 
 begin
   #Generates multiple PDFs
-  result = api_instance.batch_generate_pdf_v1(template_id, create_submission_data_batch_v1)
+  result = api_instance.batch_generate_pdf_v1(template_id, request_body)
   p result
 rescue FormAPI::ApiError => e
   puts "Exception when calling PDFApi->batch_generate_pdf_v1: #{e}"
@@ -83,14 +83,18 @@ Class | Method | HTTP request | Description
 ------------ | ------------- | ------------- | -------------
 *FormAPI::PDFApi* | [**batch_generate_pdf_v1**](docs/PDFApi.md#batch_generate_pdf_v1) | **POST** /templates/{template_id}/submissions/batch | Generates multiple PDFs
 *FormAPI::PDFApi* | [**batch_generate_pdfs**](docs/PDFApi.md#batch_generate_pdfs) | **POST** /submissions/batches | Generates multiple PDFs
+*FormAPI::PDFApi* | [**combine_pdfs**](docs/PDFApi.md#combine_pdfs) | **POST** /combined_submissions?v&#x3D;2 | Merge submission PDFs, template PDFs, or custom files
 *FormAPI::PDFApi* | [**combine_submissions**](docs/PDFApi.md#combine_submissions) | **POST** /combined_submissions | Merge generated PDFs together
+*FormAPI::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
 *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
-*FormAPI::PDFApi* | [**create_template**](docs/PDFApi.md#create_template) | **POST** /templates | Upload a new PDF template
+*FormAPI::PDFApi* | [**create_template**](docs/PDFApi.md#create_template) | **POST** /templates | Upload a new PDF template with a file upload
+*FormAPI::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
 *FormAPI::PDFApi* | [**expire_combined_submission**](docs/PDFApi.md#expire_combined_submission) | **DELETE** /combined_submissions/{combined_submission_id} | Expire a combined submission
 *FormAPI::PDFApi* | [**expire_submission**](docs/PDFApi.md#expire_submission) | **DELETE** /submissions/{submission_id} | Expire a PDF submission
 *FormAPI::PDFApi* | [**generate_pdf**](docs/PDFApi.md#generate_pdf) | **POST** /templates/{template_id}/submissions | Generates a new PDF
 *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)
 *FormAPI::PDFApi* | [**get_data_request**](docs/PDFApi.md#get_data_request) | **GET** /data_requests/{data_request_id} | Look up a submission data request
+*FormAPI::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
 *FormAPI::PDFApi* | [**get_submission**](docs/PDFApi.md#get_submission) | **GET** /submissions/{submission_id} | Check the status of a PDF
 *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
 *FormAPI::PDFApi* | [**get_template**](docs/PDFApi.md#get_template) | **GET** /templates/{template_id} | Check the status of an uploaded template
@@ -104,19 +108,21 @@ Class | Method | HTTP request | Description
 
  - [FormAPI::AuthenticationError](docs/AuthenticationError.md)
  - [FormAPI::AuthenticationSuccessResponse](docs/AuthenticationSuccessResponse.md)
+ - [FormAPI::CombinePdfsData](docs/CombinePdfsData.md)
  - [FormAPI::CombinedSubmission](docs/CombinedSubmission.md)
  - [FormAPI::CombinedSubmissionAction](docs/CombinedSubmissionAction.md)
  - [FormAPI::CombinedSubmissionData](docs/CombinedSubmissionData.md)
  - [FormAPI::CreateCombinedSubmissionResponse](docs/CreateCombinedSubmissionResponse.md)
+ - [FormAPI::CreateCustomFileData](docs/CreateCustomFileData.md)
+ - [FormAPI::CreateCustomFileResponse](docs/CreateCustomFileResponse.md)
  - [FormAPI::CreateSubmissionBatchResponse](docs/CreateSubmissionBatchResponse.md)
  - [FormAPI::CreateSubmissionBatchSubmissionsResponse](docs/CreateSubmissionBatchSubmissionsResponse.md)
- - [FormAPI::CreateSubmissionData](docs/CreateSubmissionData.md)
- - [FormAPI::CreateSubmissionDataBatchRequest](docs/CreateSubmissionDataBatchRequest.md)
- - [FormAPI::CreateSubmissionDataBatchV1](docs/CreateSubmissionDataBatchV1.md)
  - [FormAPI::CreateSubmissionDataRequestData](docs/CreateSubmissionDataRequestData.md)
  - [FormAPI::CreateSubmissionDataRequestTokenResponse](docs/CreateSubmissionDataRequestTokenResponse.md)
  - [FormAPI::CreateSubmissionDataRequestTokenResponseToken](docs/CreateSubmissionDataRequestTokenResponseToken.md)
  - [FormAPI::CreateSubmissionResponse](docs/CreateSubmissionResponse.md)
+ - [FormAPI::CreateTemplateData](docs/CreateTemplateData.md)
+ - [FormAPI::CustomFile](docs/CustomFile.md)
  - [FormAPI::Error](docs/Error.md)
  - [FormAPI::InvalidRequest](docs/InvalidRequest.md)
  - [FormAPI::PendingTemplate](docs/PendingTemplate.md)
@@ -124,8 +130,13 @@ Class | Method | HTTP request | Description
  - [FormAPI::SubmissionAction](docs/SubmissionAction.md)
  - [FormAPI::SubmissionBatch](docs/SubmissionBatch.md)
  - [FormAPI::SubmissionBatchData](docs/SubmissionBatchData.md)
+ - [FormAPI::SubmissionData](docs/SubmissionData.md)
+ - [FormAPI::SubmissionDataBatchRequest](docs/SubmissionDataBatchRequest.md)
  - [FormAPI::SubmissionDataRequest](docs/SubmissionDataRequest.md)
  - [FormAPI::Template](docs/Template.md)
+ - [FormAPI::Templatesv2Template](docs/Templatesv2Template.md)
+ - [FormAPI::Templatesv2TemplateDocument](docs/Templatesv2TemplateDocument.md)
+ - [FormAPI::Templatesv2TemplateDocumentMetadata](docs/Templatesv2TemplateDocumentMetadata.md)
  - [FormAPI::UpdateDataRequestResponse](docs/UpdateDataRequestResponse.md)
  - [FormAPI::UpdateSubmissionDataRequestData](docs/UpdateSubmissionDataRequestData.md)
 

data/docs/{CreateSubmissionDataBatchV1.md → CombinePdfsData.md}

@@ -1,12 +1,12 @@
-# FormAPI::CreateSubmissionDataBatchV1
+# FormAPI::CombinePdfsData
 
 ## Properties
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **test** | **BOOLEAN** |  | [optional] 
-**data** | **Object** |  | 
-**html** | **String** |  | [optional] 
-**css** | **String** |  | [optional] 
+**source_pdfs** | **Array<Object>** |  | 
 **metadata** | **Object** |  | [optional] 
+**expires_in** | **Integer** |  | [optional] 
+**delete_custom_files** | **BOOLEAN** |  | [optional] 
 
 

data/docs/CombinedSubmission.md

@@ -6,6 +6,7 @@ Name | Type | Description | Notes
 **metadata** | **Object** |  | [optional] 
 **expired** | **BOOLEAN** |  | [optional] 
 **expires_at** | **String** |  | [optional] 
+**source_pdfs** | **Array<Object>** |  | [optional] 
 **download_url** | **String** |  | [optional] 
 **submission_ids** | **Array<String>** |  | [optional] 
 **id** | **String** |  | [optional] 

data/docs/CreateCustomFileData.md

@@ -0,0 +1,8 @@
+# FormAPI::CreateCustomFileData
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**cache_id** | **String** |  | 
+
+

data/docs/CreateCustomFileResponse.md

@@ -0,0 +1,10 @@
+# FormAPI::CreateCustomFileResponse
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**custom_file** | [**CustomFile**](CustomFile.md) |  | [optional] 
+**errors** | **Array<String>** |  | [optional] 
+**status** | **String** |  | [optional] 
+
+

data/docs/CreateTemplateData.md

@@ -0,0 +1,8 @@
+# FormAPI::CreateTemplateData
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**template** | [**Templatesv2Template**](Templatesv2Template.md) |  | 
+
+

data/docs/CustomFile.md

@@ -0,0 +1,9 @@
+# FormAPI::CustomFile
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **String** |  | [optional] 
+**url** | **String** |  | [optional] 
+
+

data/docs/PDFApi.md

@@ -6,14 +6,18 @@ Method | HTTP request | Description
 ------------- | ------------- | -------------
 [**batch_generate_pdf_v1**](PDFApi.md#batch_generate_pdf_v1) | **POST** /templates/{template_id}/submissions/batch | Generates multiple PDFs
 [**batch_generate_pdfs**](PDFApi.md#batch_generate_pdfs) | **POST** /submissions/batches | Generates multiple PDFs
+[**combine_pdfs**](PDFApi.md#combine_pdfs) | **POST** /combined_submissions?v=2 | Merge submission PDFs, template PDFs, or custom files
 [**combine_submissions**](PDFApi.md#combine_submissions) | **POST** /combined_submissions | Merge generated PDFs together
+[**create_custom_file_from_upload**](PDFApi.md#create_custom_file_from_upload) | **POST** /custom_files | Create a new custom file from a cached presign upload
 [**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
-[**create_template**](PDFApi.md#create_template) | **POST** /templates | Upload a new PDF template
+[**create_template**](PDFApi.md#create_template) | **POST** /templates | Upload a new PDF template with a file upload
+[**create_template_from_upload**](PDFApi.md#create_template_from_upload) | **POST** /templates?v=2 | Create a new PDF template from a cached presign upload
 [**expire_combined_submission**](PDFApi.md#expire_combined_submission) | **DELETE** /combined_submissions/{combined_submission_id} | Expire a combined submission
 [**expire_submission**](PDFApi.md#expire_submission) | **DELETE** /submissions/{submission_id} | Expire a PDF submission
 [**generate_pdf**](PDFApi.md#generate_pdf) | **POST** /templates/{template_id}/submissions | Generates a new PDF
 [**get_combined_submission**](PDFApi.md#get_combined_submission) | **GET** /combined_submissions/{combined_submission_id} | Check the status of a combined submission (merged PDFs)
 [**get_data_request**](PDFApi.md#get_data_request) | **GET** /data_requests/{data_request_id} | Look up a submission data request
+[**get_presign_url**](PDFApi.md#get_presign_url) | **GET** /uploads/presign | Get a presigned URL so that you can upload a file to our AWS S3 bucket
 [**get_submission**](PDFApi.md#get_submission) | **GET** /submissions/{submission_id} | Check the status of a PDF
 [**get_submission_batch**](PDFApi.md#get_submission_batch) | **GET** /submissions/batches/{submission_batch_id} | Check the status of a submission batch job
 [**get_template**](PDFApi.md#get_template) | **GET** /templates/{template_id} | Check the status of an uploaded template
@@ -24,7 +28,7 @@ Method | HTTP request | Description
 
 
 # **batch_generate_pdf_v1**
-> Array<CreateSubmissionResponse> batch_generate_pdf_v1(template_id, create_submission_data_batch_v1)
+> Array<CreateSubmissionResponse> batch_generate_pdf_v1(template_id, request_body)
 
 Generates multiple PDFs
 
@@ -41,11 +45,11 @@ end
 
 api_instance = FormAPI::PDFApi.new
 template_id = 'tpl_000000000000000001' # String | 
-create_submission_data_batch_v1 = nil # Array<CreateSubmissionDataBatchV1> | 
+request_body = nil # Array<Object> | 
 
 begin
   #Generates multiple PDFs
-  result = api_instance.batch_generate_pdf_v1(template_id, create_submission_data_batch_v1)
+  result = api_instance.batch_generate_pdf_v1(template_id, request_body)
   p result
 rescue FormAPI::ApiError => e
   puts "Exception when calling PDFApi->batch_generate_pdf_v1: #{e}"
@@ -57,7 +61,7 @@ end
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
  **template_id** | **String**|  | 
- **create_submission_data_batch_v1** | [**Array&lt;CreateSubmissionDataBatchV1&gt;**](Array.md)|  | 
+ **request_body** | [**Array&lt;Object&gt;**](Array.md)|  | 
 
 ### Return type
 
@@ -123,6 +127,55 @@ Name | Type | Description  | Notes
 
 
 
+# **combine_pdfs**
+> CreateCombinedSubmissionResponse combine_pdfs(combine_pdfs_data)
+
+Merge submission PDFs, template PDFs, or custom files
+
+### Example
+```ruby
+# load the gem
+require 'form_api'
+# setup authorization
+FormAPI.configure do |config|
+  # Configure HTTP basic authorization: api_token_basic
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = FormAPI::PDFApi.new
+combine_pdfs_data = FormAPI::CombinePdfsData.new # CombinePdfsData | 
+
+begin
+  #Merge submission PDFs, template PDFs, or custom files
+  result = api_instance.combine_pdfs(combine_pdfs_data)
+  p result
+rescue FormAPI::ApiError => e
+  puts "Exception when calling PDFApi->combine_pdfs: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **combine_pdfs_data** | [**CombinePdfsData**](CombinePdfsData.md)|  | 
+
+### Return type
+
+[**CreateCombinedSubmissionResponse**](CreateCombinedSubmissionResponse.md)
+
+### Authorization
+
+[api_token_basic](../README.md#api_token_basic)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
 # **combine_submissions**
 > CreateCombinedSubmissionResponse combine_submissions(combined_submission_data)
 
@@ -172,6 +225,55 @@ Name | Type | Description  | Notes
 
 
 
+# **create_custom_file_from_upload**
+> CreateCustomFileResponse create_custom_file_from_upload(create_custom_file_data)
+
+Create a new custom file from a cached presign upload
+
+### Example
+```ruby
+# load the gem
+require 'form_api'
+# setup authorization
+FormAPI.configure do |config|
+  # Configure HTTP basic authorization: api_token_basic
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = FormAPI::PDFApi.new
+create_custom_file_data = FormAPI::CreateCustomFileData.new # CreateCustomFileData | 
+
+begin
+  #Create a new custom file from a cached presign upload
+  result = api_instance.create_custom_file_from_upload(create_custom_file_data)
+  p result
+rescue FormAPI::ApiError => e
+  puts "Exception when calling PDFApi->create_custom_file_from_upload: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **create_custom_file_data** | [**CreateCustomFileData**](CreateCustomFileData.md)|  | 
+
+### Return type
+
+[**CreateCustomFileResponse**](CreateCustomFileResponse.md)
+
+### Authorization
+
+[api_token_basic](../README.md#api_token_basic)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
 # **create_data_request_token**
 > CreateSubmissionDataRequestTokenResponse create_data_request_token(data_request_id)
 
@@ -224,7 +326,7 @@ Name | Type | Description  | Notes
 # **create_template**
 > PendingTemplate create_template(template_document, template_name)
 
-Upload a new PDF template
+Upload a new PDF template with a file upload
 
 ### Example
 ```ruby
@@ -242,7 +344,7 @@ template_document = File.new('/path/to/file') # File |
 template_name = 'template_name_example' # String | 
 
 begin
-  #Upload a new PDF template
+  #Upload a new PDF template with a file upload
   result = api_instance.create_template(template_document, template_name)
   p result
 rescue FormAPI::ApiError => e
@@ -272,6 +374,55 @@ Name | Type | Description  | Notes
 
 
 
+# **create_template_from_upload**
+> PendingTemplate create_template_from_upload(create_template_data)
+
+Create a new PDF template from a cached presign upload
+
+### Example
+```ruby
+# load the gem
+require 'form_api'
+# setup authorization
+FormAPI.configure do |config|
+  # Configure HTTP basic authorization: api_token_basic
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = FormAPI::PDFApi.new
+create_template_data = FormAPI::CreateTemplateData.new # CreateTemplateData | 
+
+begin
+  #Create a new PDF template from a cached presign upload
+  result = api_instance.create_template_from_upload(create_template_data)
+  p result
+rescue FormAPI::ApiError => e
+  puts "Exception when calling PDFApi->create_template_from_upload: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **create_template_data** | [**CreateTemplateData**](CreateTemplateData.md)|  | 
+
+### Return type
+
+[**PendingTemplate**](PendingTemplate.md)
+
+### Authorization
+
+[api_token_basic](../README.md#api_token_basic)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
 # **expire_combined_submission**
 > CombinedSubmission expire_combined_submission(combined_submission_id)
 
@@ -371,7 +522,7 @@ Name | Type | Description  | Notes
 
 
 # **generate_pdf**
-> CreateSubmissionResponse generate_pdf(template_id, create_submission_data)
+> CreateSubmissionResponse generate_pdf(template_id, submission_data)
 
 Generates a new PDF
 
@@ -388,11 +539,11 @@ end
 
 api_instance = FormAPI::PDFApi.new
 template_id = 'tpl_000000000000000001' # String | 
-create_submission_data = FormAPI::CreateSubmissionData.new # CreateSubmissionData | 
+submission_data = FormAPI::SubmissionData.new # SubmissionData | 
 
 begin
   #Generates a new PDF
-  result = api_instance.generate_pdf(template_id, create_submission_data)
+  result = api_instance.generate_pdf(template_id, submission_data)
   p result
 rescue FormAPI::ApiError => e
   puts "Exception when calling PDFApi->generate_pdf: #{e}"
@@ -404,7 +555,7 @@ end
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
  **template_id** | **String**|  | 
- **create_submission_data** | [**CreateSubmissionData**](CreateSubmissionData.md)|  | 
+ **submission_data** | [**SubmissionData**](SubmissionData.md)|  | 
 
 ### Return type
 
@@ -519,6 +670,51 @@ Name | Type | Description  | Notes
 
 
 
+# **get_presign_url**
+> Hash&lt;String, Object&gt; get_presign_url
+
+Get a presigned URL so that you can upload a file to our AWS S3 bucket
+
+### Example
+```ruby
+# load the gem
+require 'form_api'
+# setup authorization
+FormAPI.configure do |config|
+  # Configure HTTP basic authorization: api_token_basic
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = FormAPI::PDFApi.new
+
+begin
+  #Get a presigned URL so that you can upload a file to our AWS S3 bucket
+  result = api_instance.get_presign_url
+  p result
+rescue FormAPI::ApiError => e
+  puts "Exception when calling PDFApi->get_presign_url: #{e}"
+end
+```
+
+### Parameters
+This endpoint does not need any parameter.
+
+### Return type
+
+**Hash&lt;String, Object&gt;**
+
+### Authorization
+
+[api_token_basic](../README.md#api_token_basic)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+
 # **get_submission**
 > Submission get_submission(submission_id)
 
@@ -585,7 +781,7 @@ FormAPI.configure do |config|
 end
 
 api_instance = FormAPI::PDFApi.new
-submission_batch_id = 'sba_000000000000000001' # String | 
+submission_batch_id = 'sbb_000000000000000001' # String | 
 opts = {
   include_submissions: true # BOOLEAN | 
 }