docspring 1.0.0

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+
+begin
+  require 'rspec/core/rake_task'
+
+  RSpec::Core::RakeTask.new(:spec)
+  task default: :spec
+rescue LoadError
+  # no rspec available
+end

data/docs/AuthenticationError.md

@@ -0,0 +1,9 @@
+# DocSpring::AuthenticationError
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**status** | **String** |  | [optional] 
+**error** | **String** |  | 
+
+

data/docs/AuthenticationSuccessResponse.md

@@ -0,0 +1,8 @@
+# DocSpring::AuthenticationSuccessResponse
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**status** | **String** |  | [optional] 
+
+

data/docs/CombinePdfsData.md

@@ -0,0 +1,12 @@
+# DocSpring::CombinePdfsData
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**test** | **BOOLEAN** |  | [optional] 
+**source_pdfs** | **Array<Object>** |  | 
+**metadata** | **Object** |  | [optional] 
+**expires_in** | **Integer** |  | [optional] 
+**delete_custom_files** | **BOOLEAN** |  | [optional] 
+
+

data/docs/CombinedSubmission.md

@@ -0,0 +1,16 @@
+# DocSpring::CombinedSubmission
+
+## Properties
+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] 
+**state** | **String** |  | [optional] 
+**actions** | [**Array<CombinedSubmissionAction>**](CombinedSubmissionAction.md) |  | [optional] 
+
+

data/docs/CombinedSubmissionAction.md

@@ -0,0 +1,13 @@
+# DocSpring::CombinedSubmissionAction
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **String** |  | 
+**integration_id** | **String** |  | 
+**state** | **String** |  | 
+**action_category** | **String** |  | 
+**action_type** | **String** |  | 
+**result_data** | **Object** |  | 
+
+

data/docs/CombinedSubmissionData.md

@@ -0,0 +1,11 @@
+# DocSpring::CombinedSubmissionData
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**test** | **BOOLEAN** |  | [optional] 
+**submission_ids** | **Array<String>** |  | 
+**metadata** | **Object** |  | [optional] 
+**expires_in** | **Integer** |  | [optional] 
+
+

data/docs/CreateCombinedSubmissionResponse.md

@@ -0,0 +1,10 @@
+# DocSpring::CreateCombinedSubmissionResponse
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**combined_submission** | [**CombinedSubmission**](CombinedSubmission.md) |  | [optional] 
+**errors** | **Array<String>** |  | [optional] 
+**status** | **String** |  | [optional] 
+
+

data/docs/CreateCustomFileData.md

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

data/docs/CreateCustomFileResponse.md

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

data/docs/CreateFolderData.md

@@ -0,0 +1,8 @@
+# DocSpring::CreateFolderData
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**folder** | [**FoldersFolder**](FoldersFolder.md) |  | 
+
+

data/docs/CreateSubmissionBatchResponse.md

@@ -0,0 +1,12 @@
+# DocSpring::CreateSubmissionBatchResponse
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**submission_batch** | [**SubmissionBatch**](SubmissionBatch.md) |  | [optional] 
+**submissions** | [**Array<CreateSubmissionBatchSubmissionsResponse>**](CreateSubmissionBatchSubmissionsResponse.md) |  | [optional] 
+**error** | **String** |  | [optional] 
+**errors** | **Array<String>** |  | [optional] 
+**status** | **String** |  | [optional] 
+
+

data/docs/CreateSubmissionBatchSubmissionsResponse.md

@@ -0,0 +1,10 @@
+# DocSpring::CreateSubmissionBatchSubmissionsResponse
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**submission** | [**Submission**](Submission.md) |  | [optional] 
+**errors** | **Array<String>** |  | [optional] 
+**status** | **String** |  | [optional] 
+
+

data/docs/CreateSubmissionDataRequestData.md

@@ -0,0 +1,20 @@
+# DocSpring::CreateSubmissionDataRequestData
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**metadata** | **Object** |  | [optional] 
+**auth_type** | **String** |  | [optional] 
+**auth_second_factor_type** | **String** |  | [optional] 
+**auth_phone_number_hash** | **String** |  | [optional] 
+**auth_session_started_at** | **String** |  | [optional] 
+**auth_user_id_hash** | **String** |  | [optional] 
+**auth_session_id_hash** | **String** |  | [optional] 
+**auth_username_hash** | **String** |  | [optional] 
+**name** | **String** |  | [optional] 
+**fields** | **Array<String>** |  | [optional] 
+**email** | **String** |  | [optional] 
+**auth_provider** | **String** |  | [optional] 
+**order** | **Integer** |  | [optional] 
+
+

data/docs/CreateSubmissionDataRequestTokenResponse.md

@@ -0,0 +1,10 @@
+# DocSpring::CreateSubmissionDataRequestTokenResponse
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**errors** | **Array<String>** |  | [optional] 
+**status** | **String** |  | [optional] 
+**token** | [**CreateSubmissionDataRequestTokenResponseToken**](CreateSubmissionDataRequestTokenResponseToken.md) |  | [optional] 
+
+

data/docs/CreateSubmissionDataRequestTokenResponseToken.md

@@ -0,0 +1,11 @@
+# DocSpring::CreateSubmissionDataRequestTokenResponseToken
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**expires_at** | **String** |  | [optional] 
+**id** | **String** |  | [optional] 
+**secret** | **String** |  | [optional] 
+**data_request_url** | **String** |  | [optional] 
+
+

data/docs/CreateSubmissionResponse.md

@@ -0,0 +1,10 @@
+# DocSpring::CreateSubmissionResponse
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**submission** | [**Submission**](Submission.md) |  | [optional] 
+**errors** | **Array<String>** |  | [optional] 
+**status** | **String** |  | [optional] 
+
+

data/docs/CreateTemplateData.md

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

data/docs/CustomFile.md

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

data/docs/Error.md

@@ -0,0 +1,9 @@
+# DocSpring::Error
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**status** | **String** |  | 
+**error** | **String** |  | 
+
+

data/docs/Folder.md

@@ -0,0 +1,11 @@
+# DocSpring::Folder
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**path** | **String** |  | [optional] 
+**parent_folder_id** | **String** |  | [optional] 
+**name** | **String** |  | [optional] 
+**id** | **String** |  | [optional] 
+
+

data/docs/FoldersFolder.md

@@ -0,0 +1,9 @@
+# DocSpring::FoldersFolder
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**parent_folder_id** | **String** |  | [optional] 
+**name** | **String** |  | [optional] 
+
+

data/docs/InvalidRequest.md

@@ -0,0 +1,9 @@
+# DocSpring::InvalidRequest
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**status** | **String** |  | 
+**errors** | **Array<String>** |  | 
+
+

data/docs/MoveFolderData.md

@@ -0,0 +1,8 @@
+# DocSpring::MoveFolderData
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**parent_folder_id** | **String** |  | [optional] 
+
+

data/docs/MoveTemplateData.md

@@ -0,0 +1,8 @@
+# DocSpring::MoveTemplateData
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**parent_folder_id** | **String** |  | [optional] 
+
+

data/docs/PDFApi.md

@@ -0,0 +1,1385 @@
+# DocSpring::PDFApi
+
+All URIs are relative to *https://api.docspring.com/api/v1*
+
+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_folder**](PDFApi.md#create_folder) | **POST** /folders/ | Create a folder
+[**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
+[**delete_folder**](PDFApi.md#delete_folder) | **DELETE** /folders/{folder_id} | Delete a folder
+[**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} | Get a single template
+[**get_template_schema**](PDFApi.md#get_template_schema) | **GET** /templates/{template_id}/schema | Fetch the JSON schema for a template
+[**list_folders**](PDFApi.md#list_folders) | **GET** /folders/ | Get a list of all folders
+[**list_templates**](PDFApi.md#list_templates) | **GET** /templates | Get a list of all templates
+[**move_folder_to_folder**](PDFApi.md#move_folder_to_folder) | **POST** /folders/{folder_id}/move | Move a folder
+[**move_template_to_folder**](PDFApi.md#move_template_to_folder) | **POST** /templates/{template_id}/move | Move Template to folder
+[**rename_folder**](PDFApi.md#rename_folder) | **POST** /folders/{folder_id}/rename | Rename a folder
+[**test_authentication**](PDFApi.md#test_authentication) | **GET** /authentication | Test Authentication
+[**update_data_request**](PDFApi.md#update_data_request) | **PUT** /data_requests/{data_request_id} | Update a submission data request
+
+
+# **batch_generate_pdf_v1**
+> Array<CreateSubmissionResponse> batch_generate_pdf_v1(template_id, request_body)
+
+Generates multiple PDFs
+
+### Example
+```ruby
+# load the gem
+require 'docspring'
+# setup authorization
+DocSpring.configure do |config|
+  # Configure HTTP basic authorization: api_token_basic
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = DocSpring::PDFApi.new
+template_id = 'tpl_000000000000000001' # String | 
+request_body = nil # Array<Object> | 
+
+begin
+  #Generates multiple PDFs
+  result = api_instance.batch_generate_pdf_v1(template_id, request_body)
+  p result
+rescue DocSpring::ApiError => e
+  puts "Exception when calling PDFApi->batch_generate_pdf_v1: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **template_id** | **String**|  | 
+ **request_body** | [**Array&lt;Object&gt;**](Array.md)|  | 
+
+### Return type
+
+[**Array&lt;CreateSubmissionResponse&gt;**](CreateSubmissionResponse.md)
+
+### Authorization
+
+[api_token_basic](../README.md#api_token_basic)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **batch_generate_pdfs**
+> CreateSubmissionBatchResponse batch_generate_pdfs(submission_batch_data)
+
+Generates multiple PDFs
+
+### Example
+```ruby
+# load the gem
+require 'docspring'
+# setup authorization
+DocSpring.configure do |config|
+  # Configure HTTP basic authorization: api_token_basic
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = DocSpring::PDFApi.new
+submission_batch_data = DocSpring::SubmissionBatchData.new # SubmissionBatchData | 
+
+begin
+  #Generates multiple PDFs
+  result = api_instance.batch_generate_pdfs(submission_batch_data)
+  p result
+rescue DocSpring::ApiError => e
+  puts "Exception when calling PDFApi->batch_generate_pdfs: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **submission_batch_data** | [**SubmissionBatchData**](SubmissionBatchData.md)|  | 
+
+### Return type
+
+[**CreateSubmissionBatchResponse**](CreateSubmissionBatchResponse.md)
+
+### Authorization
+
+[api_token_basic](../README.md#api_token_basic)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **combine_pdfs**
+> CreateCombinedSubmissionResponse combine_pdfs(combine_pdfs_data)
+
+Merge submission PDFs, template PDFs, or custom files
+
+### Example
+```ruby
+# load the gem
+require 'docspring'
+# setup authorization
+DocSpring.configure do |config|
+  # Configure HTTP basic authorization: api_token_basic
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = DocSpring::PDFApi.new
+combine_pdfs_data = DocSpring::CombinePdfsData.new # CombinePdfsData | 
+
+begin
+  #Merge submission PDFs, template PDFs, or custom files
+  result = api_instance.combine_pdfs(combine_pdfs_data)
+  p result
+rescue DocSpring::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)
+
+Merge generated PDFs together
+
+### Example
+```ruby
+# load the gem
+require 'docspring'
+# setup authorization
+DocSpring.configure do |config|
+  # Configure HTTP basic authorization: api_token_basic
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = DocSpring::PDFApi.new
+combined_submission_data = DocSpring::CombinedSubmissionData.new # CombinedSubmissionData | 
+
+begin
+  #Merge generated PDFs together
+  result = api_instance.combine_submissions(combined_submission_data)
+  p result
+rescue DocSpring::ApiError => e
+  puts "Exception when calling PDFApi->combine_submissions: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **combined_submission_data** | [**CombinedSubmissionData**](CombinedSubmissionData.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
+
+
+
+# **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 'docspring'
+# setup authorization
+DocSpring.configure do |config|
+  # Configure HTTP basic authorization: api_token_basic
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = DocSpring::PDFApi.new
+create_custom_file_data = DocSpring::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 DocSpring::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)
+
+Creates a new data request token for form authentication
+
+### Example
+```ruby
+# load the gem
+require 'docspring'
+# setup authorization
+DocSpring.configure do |config|
+  # Configure HTTP basic authorization: api_token_basic
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = DocSpring::PDFApi.new
+data_request_id = 'drq_000000000000000001' # String | 
+
+begin
+  #Creates a new data request token for form authentication
+  result = api_instance.create_data_request_token(data_request_id)
+  p result
+rescue DocSpring::ApiError => e
+  puts "Exception when calling PDFApi->create_data_request_token: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **data_request_id** | **String**|  | 
+
+### Return type
+
+[**CreateSubmissionDataRequestTokenResponse**](CreateSubmissionDataRequestTokenResponse.md)
+
+### Authorization
+
+[api_token_basic](../README.md#api_token_basic)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+
+# **create_folder**
+> Folder create_folder(create_folder_data)
+
+Create a folder
+
+### Example
+```ruby
+# load the gem
+require 'docspring'
+# setup authorization
+DocSpring.configure do |config|
+  # Configure HTTP basic authorization: api_token_basic
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = DocSpring::PDFApi.new
+create_folder_data = DocSpring::CreateFolderData.new # CreateFolderData | 
+
+begin
+  #Create a folder
+  result = api_instance.create_folder(create_folder_data)
+  p result
+rescue DocSpring::ApiError => e
+  puts "Exception when calling PDFApi->create_folder: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **create_folder_data** | [**CreateFolderData**](CreateFolderData.md)|  | 
+
+### Return type
+
+[**Folder**](Folder.md)
+
+### Authorization
+
+[api_token_basic](../README.md#api_token_basic)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **create_template**
+> PendingTemplate create_template(template_document, template_name, opts)
+
+Upload a new PDF template with a file upload
+
+### Example
+```ruby
+# load the gem
+require 'docspring'
+# setup authorization
+DocSpring.configure do |config|
+  # Configure HTTP basic authorization: api_token_basic
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = DocSpring::PDFApi.new
+template_document = File.new('/path/to/file') # File | 
+template_name = 'template_name_example' # String | 
+opts = {
+  template_parent_folder_id: 'template_parent_folder_id_example' # String | 
+}
+
+begin
+  #Upload a new PDF template with a file upload
+  result = api_instance.create_template(template_document, template_name, opts)
+  p result
+rescue DocSpring::ApiError => e
+  puts "Exception when calling PDFApi->create_template: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **template_document** | **File**|  | 
+ **template_name** | **String**|  | 
+ **template_parent_folder_id** | **String**|  | [optional] 
+
+### Return type
+
+[**PendingTemplate**](PendingTemplate.md)
+
+### Authorization
+
+[api_token_basic](../README.md#api_token_basic)
+
+### HTTP request headers
+
+ - **Content-Type**: multipart/form-data
+ - **Accept**: application/json
+
+
+
+# **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 'docspring'
+# setup authorization
+DocSpring.configure do |config|
+  # Configure HTTP basic authorization: api_token_basic
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = DocSpring::PDFApi.new
+create_template_data = DocSpring::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 DocSpring::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
+
+
+
+# **delete_folder**
+> Folder delete_folder(folder_id)
+
+Delete a folder
+
+### Example
+```ruby
+# load the gem
+require 'docspring'
+# setup authorization
+DocSpring.configure do |config|
+  # Configure HTTP basic authorization: api_token_basic
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = DocSpring::PDFApi.new
+folder_id = 'fld_000000000000000001' # String | 
+
+begin
+  #Delete a folder
+  result = api_instance.delete_folder(folder_id)
+  p result
+rescue DocSpring::ApiError => e
+  puts "Exception when calling PDFApi->delete_folder: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **folder_id** | **String**|  | 
+
+### Return type
+
+[**Folder**](Folder.md)
+
+### Authorization
+
+[api_token_basic](../README.md#api_token_basic)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+
+# **expire_combined_submission**
+> CombinedSubmission expire_combined_submission(combined_submission_id)
+
+Expire a combined submission
+
+### Example
+```ruby
+# load the gem
+require 'docspring'
+# setup authorization
+DocSpring.configure do |config|
+  # Configure HTTP basic authorization: api_token_basic
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = DocSpring::PDFApi.new
+combined_submission_id = 'com_000000000000000001' # String | 
+
+begin
+  #Expire a combined submission
+  result = api_instance.expire_combined_submission(combined_submission_id)
+  p result
+rescue DocSpring::ApiError => e
+  puts "Exception when calling PDFApi->expire_combined_submission: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **combined_submission_id** | **String**|  | 
+
+### Return type
+
+[**CombinedSubmission**](CombinedSubmission.md)
+
+### Authorization
+
+[api_token_basic](../README.md#api_token_basic)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+
+# **expire_submission**
+> Submission expire_submission(submission_id)
+
+Expire a PDF submission
+
+### Example
+```ruby
+# load the gem
+require 'docspring'
+# setup authorization
+DocSpring.configure do |config|
+  # Configure HTTP basic authorization: api_token_basic
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = DocSpring::PDFApi.new
+submission_id = 'sub_000000000000000001' # String | 
+
+begin
+  #Expire a PDF submission
+  result = api_instance.expire_submission(submission_id)
+  p result
+rescue DocSpring::ApiError => e
+  puts "Exception when calling PDFApi->expire_submission: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **submission_id** | **String**|  | 
+
+### Return type
+
+[**Submission**](Submission.md)
+
+### Authorization
+
+[api_token_basic](../README.md#api_token_basic)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+
+# **generate_pdf**
+> CreateSubmissionResponse generate_pdf(template_id, submission_data)
+
+Generates a new PDF
+
+### Example
+```ruby
+# load the gem
+require 'docspring'
+# setup authorization
+DocSpring.configure do |config|
+  # Configure HTTP basic authorization: api_token_basic
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = DocSpring::PDFApi.new
+template_id = 'tpl_000000000000000001' # String | 
+submission_data = DocSpring::SubmissionData.new # SubmissionData | 
+
+begin
+  #Generates a new PDF
+  result = api_instance.generate_pdf(template_id, submission_data)
+  p result
+rescue DocSpring::ApiError => e
+  puts "Exception when calling PDFApi->generate_pdf: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **template_id** | **String**|  | 
+ **submission_data** | [**SubmissionData**](SubmissionData.md)|  | 
+
+### Return type
+
+[**CreateSubmissionResponse**](CreateSubmissionResponse.md)
+
+### Authorization
+
+[api_token_basic](../README.md#api_token_basic)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **get_combined_submission**
+> CombinedSubmission get_combined_submission(combined_submission_id)
+
+Check the status of a combined submission (merged PDFs)
+
+### Example
+```ruby
+# load the gem
+require 'docspring'
+# setup authorization
+DocSpring.configure do |config|
+  # Configure HTTP basic authorization: api_token_basic
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = DocSpring::PDFApi.new
+combined_submission_id = 'com_000000000000000001' # String | 
+
+begin
+  #Check the status of a combined submission (merged PDFs)
+  result = api_instance.get_combined_submission(combined_submission_id)
+  p result
+rescue DocSpring::ApiError => e
+  puts "Exception when calling PDFApi->get_combined_submission: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **combined_submission_id** | **String**|  | 
+
+### Return type
+
+[**CombinedSubmission**](CombinedSubmission.md)
+
+### Authorization
+
+[api_token_basic](../README.md#api_token_basic)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+
+# **get_data_request**
+> SubmissionDataRequest get_data_request(data_request_id)
+
+Look up a submission data request
+
+### Example
+```ruby
+# load the gem
+require 'docspring'
+# setup authorization
+DocSpring.configure do |config|
+  # Configure HTTP basic authorization: api_token_basic
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = DocSpring::PDFApi.new
+data_request_id = 'drq_000000000000000001' # String | 
+
+begin
+  #Look up a submission data request
+  result = api_instance.get_data_request(data_request_id)
+  p result
+rescue DocSpring::ApiError => e
+  puts "Exception when calling PDFApi->get_data_request: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **data_request_id** | **String**|  | 
+
+### Return type
+
+[**SubmissionDataRequest**](SubmissionDataRequest.md)
+
+### Authorization
+
+[api_token_basic](../README.md#api_token_basic)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+
+# **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 'docspring'
+# setup authorization
+DocSpring.configure do |config|
+  # Configure HTTP basic authorization: api_token_basic
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = DocSpring::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 DocSpring::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, opts)
+
+Check the status of a PDF
+
+### Example
+```ruby
+# load the gem
+require 'docspring'
+# setup authorization
+DocSpring.configure do |config|
+  # Configure HTTP basic authorization: api_token_basic
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = DocSpring::PDFApi.new
+submission_id = 'sub_000000000000000001' # String | 
+opts = {
+  include_data: false # BOOLEAN | 
+}
+
+begin
+  #Check the status of a PDF
+  result = api_instance.get_submission(submission_id, opts)
+  p result
+rescue DocSpring::ApiError => e
+  puts "Exception when calling PDFApi->get_submission: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **submission_id** | **String**|  | 
+ **include_data** | **BOOLEAN**|  | [optional] 
+
+### Return type
+
+[**Submission**](Submission.md)
+
+### Authorization
+
+[api_token_basic](../README.md#api_token_basic)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+
+# **get_submission_batch**
+> SubmissionBatch get_submission_batch(submission_batch_id, opts)
+
+Check the status of a submission batch job
+
+### Example
+```ruby
+# load the gem
+require 'docspring'
+# setup authorization
+DocSpring.configure do |config|
+  # Configure HTTP basic authorization: api_token_basic
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = DocSpring::PDFApi.new
+submission_batch_id = 'sbb_000000000000000001' # String | 
+opts = {
+  include_submissions: true # BOOLEAN | 
+}
+
+begin
+  #Check the status of a submission batch job
+  result = api_instance.get_submission_batch(submission_batch_id, opts)
+  p result
+rescue DocSpring::ApiError => e
+  puts "Exception when calling PDFApi->get_submission_batch: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **submission_batch_id** | **String**|  | 
+ **include_submissions** | **BOOLEAN**|  | [optional] 
+
+### Return type
+
+[**SubmissionBatch**](SubmissionBatch.md)
+
+### Authorization
+
+[api_token_basic](../README.md#api_token_basic)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+
+# **get_template**
+> Template get_template(template_id)
+
+Get a single template
+
+### Example
+```ruby
+# load the gem
+require 'docspring'
+# setup authorization
+DocSpring.configure do |config|
+  # Configure HTTP basic authorization: api_token_basic
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = DocSpring::PDFApi.new
+template_id = 'tpl_000000000000000011' # String | 
+
+begin
+  #Get a single template
+  result = api_instance.get_template(template_id)
+  p result
+rescue DocSpring::ApiError => e
+  puts "Exception when calling PDFApi->get_template: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **template_id** | **String**|  | 
+
+### Return type
+
+[**Template**](Template.md)
+
+### Authorization
+
+[api_token_basic](../README.md#api_token_basic)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+
+# **get_template_schema**
+> Hash&lt;String, Object&gt; get_template_schema(template_id)
+
+Fetch the JSON schema for a template
+
+### Example
+```ruby
+# load the gem
+require 'docspring'
+# setup authorization
+DocSpring.configure do |config|
+  # Configure HTTP basic authorization: api_token_basic
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = DocSpring::PDFApi.new
+template_id = 'tpl_000000000000000001' # String | 
+
+begin
+  #Fetch the JSON schema for a template
+  result = api_instance.get_template_schema(template_id)
+  p result
+rescue DocSpring::ApiError => e
+  puts "Exception when calling PDFApi->get_template_schema: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **template_id** | **String**|  | 
+
+### 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
+
+
+
+# **list_folders**
+> Array&lt;Folder&gt; list_folders(opts)
+
+Get a list of all folders
+
+### Example
+```ruby
+# load the gem
+require 'docspring'
+# setup authorization
+DocSpring.configure do |config|
+  # Configure HTTP basic authorization: api_token_basic
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = DocSpring::PDFApi.new
+opts = {
+  parent_folder_id: 'fld_000000000000000002' # String | Filter By Folder Id
+}
+
+begin
+  #Get a list of all folders
+  result = api_instance.list_folders(opts)
+  p result
+rescue DocSpring::ApiError => e
+  puts "Exception when calling PDFApi->list_folders: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **parent_folder_id** | **String**| Filter By Folder Id | [optional] 
+
+### Return type
+
+[**Array&lt;Folder&gt;**](Folder.md)
+
+### Authorization
+
+[api_token_basic](../README.md#api_token_basic)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+
+# **list_templates**
+> Array&lt;Template&gt; list_templates(opts)
+
+Get a list of all templates
+
+### Example
+```ruby
+# load the gem
+require 'docspring'
+# setup authorization
+DocSpring.configure do |config|
+  # Configure HTTP basic authorization: api_token_basic
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = DocSpring::PDFApi.new
+opts = {
+  query: '2', # String | Search By Name
+  parent_folder_id: 'fld_000000000000000001', # String | Filter By Folder Id
+  page: 2, # Integer | Default: 1
+  per_page: 1 # Integer | Default: 50
+}
+
+begin
+  #Get a list of all templates
+  result = api_instance.list_templates(opts)
+  p result
+rescue DocSpring::ApiError => e
+  puts "Exception when calling PDFApi->list_templates: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **query** | **String**| Search By Name | [optional] 
+ **parent_folder_id** | **String**| Filter By Folder Id | [optional] 
+ **page** | **Integer**| Default: 1 | [optional] 
+ **per_page** | **Integer**| Default: 50 | [optional] 
+
+### Return type
+
+[**Array&lt;Template&gt;**](Template.md)
+
+### Authorization
+
+[api_token_basic](../README.md#api_token_basic)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+
+# **move_folder_to_folder**
+> Folder move_folder_to_folder(folder_id, move_folder_data)
+
+Move a folder
+
+### Example
+```ruby
+# load the gem
+require 'docspring'
+# setup authorization
+DocSpring.configure do |config|
+  # Configure HTTP basic authorization: api_token_basic
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = DocSpring::PDFApi.new
+folder_id = 'fld_000000000000000001' # String | 
+move_folder_data = DocSpring::MoveFolderData.new # MoveFolderData | 
+
+begin
+  #Move a folder
+  result = api_instance.move_folder_to_folder(folder_id, move_folder_data)
+  p result
+rescue DocSpring::ApiError => e
+  puts "Exception when calling PDFApi->move_folder_to_folder: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **folder_id** | **String**|  | 
+ **move_folder_data** | [**MoveFolderData**](MoveFolderData.md)|  | 
+
+### Return type
+
+[**Folder**](Folder.md)
+
+### Authorization
+
+[api_token_basic](../README.md#api_token_basic)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **move_template_to_folder**
+> Template move_template_to_folder(template_id, move_template_data)
+
+Move Template to folder
+
+### Example
+```ruby
+# load the gem
+require 'docspring'
+# setup authorization
+DocSpring.configure do |config|
+  # Configure HTTP basic authorization: api_token_basic
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = DocSpring::PDFApi.new
+template_id = 'tpl_000000000000000001' # String | 
+move_template_data = DocSpring::MoveTemplateData.new # MoveTemplateData | 
+
+begin
+  #Move Template to folder
+  result = api_instance.move_template_to_folder(template_id, move_template_data)
+  p result
+rescue DocSpring::ApiError => e
+  puts "Exception when calling PDFApi->move_template_to_folder: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **template_id** | **String**|  | 
+ **move_template_data** | [**MoveTemplateData**](MoveTemplateData.md)|  | 
+
+### Return type
+
+[**Template**](Template.md)
+
+### Authorization
+
+[api_token_basic](../README.md#api_token_basic)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **rename_folder**
+> rename_folder(folder_id, rename_folder_data)
+
+Rename a folder
+
+### Example
+```ruby
+# load the gem
+require 'docspring'
+# setup authorization
+DocSpring.configure do |config|
+  # Configure HTTP basic authorization: api_token_basic
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = DocSpring::PDFApi.new
+folder_id = 'fld_000000000000000001' # String | 
+rename_folder_data = DocSpring::RenameFolderData.new # RenameFolderData | 
+
+begin
+  #Rename a folder
+  api_instance.rename_folder(folder_id, rename_folder_data)
+rescue DocSpring::ApiError => e
+  puts "Exception when calling PDFApi->rename_folder: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **folder_id** | **String**|  | 
+ **rename_folder_data** | [**RenameFolderData**](RenameFolderData.md)|  | 
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+[api_token_basic](../README.md#api_token_basic)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **test_authentication**
+> AuthenticationSuccessResponse test_authentication
+
+Test Authentication
+
+### Example
+```ruby
+# load the gem
+require 'docspring'
+# setup authorization
+DocSpring.configure do |config|
+  # Configure HTTP basic authorization: api_token_basic
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = DocSpring::PDFApi.new
+
+begin
+  #Test Authentication
+  result = api_instance.test_authentication
+  p result
+rescue DocSpring::ApiError => e
+  puts "Exception when calling PDFApi->test_authentication: #{e}"
+end
+```
+
+### Parameters
+This endpoint does not need any parameter.
+
+### Return type
+
+[**AuthenticationSuccessResponse**](AuthenticationSuccessResponse.md)
+
+### Authorization
+
+[api_token_basic](../README.md#api_token_basic)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+
+# **update_data_request**
+> UpdateDataRequestResponse update_data_request(data_request_id, update_submission_data_request_data)
+
+Update a submission data request
+
+### Example
+```ruby
+# load the gem
+require 'docspring'
+# setup authorization
+DocSpring.configure do |config|
+  # Configure HTTP basic authorization: api_token_basic
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = DocSpring::PDFApi.new
+data_request_id = 'drq_000000000000000001' # String | 
+update_submission_data_request_data = DocSpring::UpdateSubmissionDataRequestData.new # UpdateSubmissionDataRequestData | 
+
+begin
+  #Update a submission data request
+  result = api_instance.update_data_request(data_request_id, update_submission_data_request_data)
+  p result
+rescue DocSpring::ApiError => e
+  puts "Exception when calling PDFApi->update_data_request: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **data_request_id** | **String**|  | 
+ **update_submission_data_request_data** | [**UpdateSubmissionDataRequestData**](UpdateSubmissionDataRequestData.md)|  | 
+
+### Return type
+
+[**UpdateDataRequestResponse**](UpdateDataRequestResponse.md)
+
+### Authorization
+
+[api_token_basic](../README.md#api_token_basic)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+