Updated on 2021-11-28 11:29:20. Version: 1.4.1

Author: ndbroadbent

CHANGELOG.md

@@ -1,3 +1,7 @@
+### 1.4.1 [November 28, 2021]
+
+- Added 'password' parameter to Generate PDF and Combine PDF API endpoints. You can now encrypt each generated PDF with a unique password.
+
 ### 1.4.0 [May 21, 2021]
 
 - Fix URI.escape deprecation warning for Ruby 2.7.0

Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    docspring (1.4.0)
+    docspring (1.4.1)
       ffi (~> 1.0, >= 1.9.24)
       json (>= 1.8)
       typhoeus (~> 1.0, >= 1.0.1)
@@ -10,7 +10,7 @@ GEM
   remote: https://rubygems.org/
   specs:
     ZenTest (4.12.0)
-    addressable (2.7.0)
+    addressable (2.8.0)
       public_suffix (>= 2.0.2, < 5.0)
     autotest (4.4.6)
       ZenTest (>= 4.4.1)
@@ -77,4 +77,4 @@ DEPENDENCIES
   webmock (~> 1.24, >= 1.24.3)
 
 BUNDLED WITH
-   2.2.11
+   2.2.29

README.md

@@ -7,7 +7,7 @@ DocSpring 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.4.0
+- Package version: 1.4.1
 - Build package: com.docspring.codegen.DocSpringRubyClientCodegen
 
 ## Installation
@@ -23,15 +23,15 @@ gem build docspring.gemspec
 Then either install the gem locally:
 
 ```shell
-gem install ./docspring-1.4.0.gem
+gem install ./docspring-1.4.1.gem
 ```
-(for development, run `gem install --dev ./docspring-1.4.0.gem` to install the development dependencies)
+(for development, run `gem install --dev ./docspring-1.4.1.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 'docspring', '~> 1.4.0'
+    gem 'docspring', '~> 1.4.1'
 
 ### Install from Git
 
@@ -99,12 +99,15 @@ Class | Method | HTTP request | Description
 *DocSpring::PDFApi* | [**generate_pdf**](docs/PDFApi.md#generate_pdf) | **POST** /templates/{template_id}/submissions | Generates a new PDF
 *DocSpring::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)
 *DocSpring::PDFApi* | [**get_data_request**](docs/PDFApi.md#get_data_request) | **GET** /data_requests/{data_request_id} | Look up a submission data request
+*DocSpring::PDFApi* | [**get_full_template**](docs/PDFApi.md#get_full_template) | **GET** /templates/{template_id}?full=true | Fetch the full template attributes
 *DocSpring::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
 *DocSpring::PDFApi* | [**get_submission**](docs/PDFApi.md#get_submission) | **GET** /submissions/{submission_id} | Check the status of a PDF
 *DocSpring::PDFApi* | [**get_submission_batch**](docs/PDFApi.md#get_submission_batch) | **GET** /submissions/batches/{submission_batch_id} | Check the status of a submission batch job
-*DocSpring::PDFApi* | [**get_template**](docs/PDFApi.md#get_template) | **GET** /templates/{template_id} | Get a single template
+*DocSpring::PDFApi* | [**get_template**](docs/PDFApi.md#get_template) | **GET** /templates/{template_id} | Check the status of an uploaded template
 *DocSpring::PDFApi* | [**get_template_schema**](docs/PDFApi.md#get_template_schema) | **GET** /templates/{template_id}/schema | Fetch the JSON schema for a template
 *DocSpring::PDFApi* | [**list_folders**](docs/PDFApi.md#list_folders) | **GET** /folders/ | Get a list of all folders
+*DocSpring::PDFApi* | [**list_submissions**](docs/PDFApi.md#list_submissions) | **GET** /submissions | List all submissions
+*DocSpring::PDFApi* | [**list_submissions_0**](docs/PDFApi.md#list_submissions_0) | **GET** /templates/{template_id}/submissions | List all submissions for a given template
 *DocSpring::PDFApi* | [**list_templates**](docs/PDFApi.md#list_templates) | **GET** /templates | Get a list of all templates
 *DocSpring::PDFApi* | [**move_folder_to_folder**](docs/PDFApi.md#move_folder_to_folder) | **POST** /folders/{folder_id}/move | Move a folder
 *DocSpring::PDFApi* | [**move_template_to_folder**](docs/PDFApi.md#move_template_to_folder) | **POST** /templates/{template_id}/move | Move Template to folder
@@ -143,6 +146,7 @@ Class | Method | HTTP request | Description
  - [DocSpring::FoldersFolder](docs/FoldersFolder.md)
  - [DocSpring::HtmlTemplateData](docs/HtmlTemplateData.md)
  - [DocSpring::InvalidRequest](docs/InvalidRequest.md)
+ - [DocSpring::ListSubmissionsResponse](docs/ListSubmissionsResponse.md)
  - [DocSpring::MoveFolderData](docs/MoveFolderData.md)
  - [DocSpring::MoveTemplateData](docs/MoveTemplateData.md)
  - [DocSpring::PendingTemplate](docs/PendingTemplate.md)
@@ -155,6 +159,8 @@ Class | Method | HTTP request | Description
  - [DocSpring::SubmissionDataBatchRequest](docs/SubmissionDataBatchRequest.md)
  - [DocSpring::SubmissionDataRequest](docs/SubmissionDataRequest.md)
  - [DocSpring::Template](docs/Template.md)
+ - [DocSpring::Template1](docs/Template1.md)
+ - [DocSpring::Template1Defaults](docs/Template1Defaults.md)
  - [DocSpring::TemplateData](docs/TemplateData.md)
  - [DocSpring::TemplatestemplateIdaddFieldsFields](docs/TemplatestemplateIdaddFieldsFields.md)
  - [DocSpring::UpdateDataRequestResponse](docs/UpdateDataRequestResponse.md)

docs/CombinePdfsData.md

@@ -6,6 +6,7 @@ Name | Type | Description | Notes
 **delete_custom_files** | **BOOLEAN** |  | [optional] 
 **expires_in** | **Integer** |  | [optional] 
 **metadata** | **Object** |  | [optional] 
+**password** | **String** |  | [optional] 
 **source_pdfs** | **Array<Object>** |  | 
 **test** | **BOOLEAN** |  | [optional] 
 

docs/CombinedSubmission.md

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

docs/CombinedSubmissionData.md

@@ -5,6 +5,7 @@ Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **expires_in** | **Integer** |  | [optional] 
 **metadata** | **Object** |  | [optional] 
+**password** | **String** |  | [optional] 
 **submission_ids** | **Array<String>** |  | 
 **test** | **BOOLEAN** |  | [optional] 
 

docs/ListSubmissionsResponse.md

@@ -0,0 +1,10 @@
+# DocSpring::ListSubmissionsResponse
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**next_cursor** | **String** |  | [optional] 
+**submissions** | [**Array<Submission>**](Submission.md) |  | [optional] 
+**limit** | **Float** |  | [optional] 
+
+

docs/PDFApi.md

@@ -22,12 +22,15 @@ Method | HTTP request | Description
 [**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_full_template**](PDFApi.md#get_full_template) | **GET** /templates/{template_id}?full=true | Fetch the full template attributes
 [**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**](PDFApi.md#get_template) | **GET** /templates/{template_id} | Check the status of an uploaded 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_submissions**](PDFApi.md#list_submissions) | **GET** /submissions | List all submissions
+[**list_submissions_0**](PDFApi.md#list_submissions_0) | **GET** /templates/{template_id}/submissions | List all submissions for a given template
 [**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
@@ -933,6 +936,55 @@ Name | Type | Description  | Notes
 
 
 
+# **get_full_template**
+> Template1 get_full_template(template_id)
+
+Fetch the full template attributes
+
+### 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 full template attributes
+  result = api_instance.get_full_template(template_id)
+  p result
+rescue DocSpring::ApiError => e
+  puts "Exception when calling PDFApi->get_full_template: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **template_id** | **String**|  | 
+
+### Return type
+
+[**Template1**](Template1.md)
+
+### Authorization
+
+[api_token_basic](../README.md#api_token_basic)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+
 # **get_presign_url**
 > Hash<String, Object> get_presign_url
 
@@ -1087,7 +1139,7 @@ Name | Type | Description  | Notes
 # **get_template**
 > Template get_template(template_id)
 
-Get a single template
+Check the status of an uploaded template
 
 ### Example
 ```ruby
@@ -1101,10 +1153,10 @@ DocSpring.configure do |config|
 end
 
 api_instance = DocSpring::PDFApi.new
-template_id = 'tpl_000000000000000011' # String | 
+template_id = 'tpl_000000000000000001' # String | 
 
 begin
-  #Get a single template
+  #Check the status of an uploaded template
   result = api_instance.get_template(template_id)
   p result
 rescue DocSpring::ApiError => e
@@ -1233,6 +1285,130 @@ Name | Type | Description  | Notes
 
 
 
+# **list_submissions**
+> ListSubmissionsResponse list_submissions(opts)
+
+List all submissions
+
+### 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 = {
+  cursor: 'sub_list_000012', # String | 
+  limit: 3, # Float | 
+  created_after: '2019-01-01T09:00:00-05:00', # String | 
+  created_before: '2020-01-01T09:00:00-05:00', # String | 
+  type: 'test', # String | 
+  include_data: true # BOOLEAN | 
+}
+
+begin
+  #List all submissions
+  result = api_instance.list_submissions(opts)
+  p result
+rescue DocSpring::ApiError => e
+  puts "Exception when calling PDFApi->list_submissions: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **cursor** | **String**|  | [optional] 
+ **limit** | **Float**|  | [optional] 
+ **created_after** | **String**|  | [optional] 
+ **created_before** | **String**|  | [optional] 
+ **type** | **String**|  | [optional] 
+ **include_data** | **BOOLEAN**|  | [optional] 
+
+### Return type
+
+[**ListSubmissionsResponse**](ListSubmissionsResponse.md)
+
+### Authorization
+
+[api_token_basic](../README.md#api_token_basic)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+
+# **list_submissions_0**
+> ListSubmissionsResponse list_submissions_0(template_id, opts)
+
+List all submissions for a given 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_000000000000000002' # String | 
+opts = {
+  cursor: 'cursor_example', # String | 
+  limit: 3.4, # Float | 
+  created_after: 'created_after_example', # String | 
+  created_before: 'created_before_example', # String | 
+  type: 'type_example', # String | 
+  include_data: true # BOOLEAN | 
+}
+
+begin
+  #List all submissions for a given template
+  result = api_instance.list_submissions_0(template_id, opts)
+  p result
+rescue DocSpring::ApiError => e
+  puts "Exception when calling PDFApi->list_submissions_0: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **template_id** | **String**|  | 
+ **cursor** | **String**|  | [optional] 
+ **limit** | **Float**|  | [optional] 
+ **created_after** | **String**|  | [optional] 
+ **created_before** | **String**|  | [optional] 
+ **type** | **String**|  | [optional] 
+ **include_data** | **BOOLEAN**|  | [optional] 
+
+### Return type
+
+[**ListSubmissionsResponse**](ListSubmissionsResponse.md)
+
+### Authorization
+
+[api_token_basic](../README.md#api_token_basic)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+
 # **list_templates**
 > Array<Template> list_templates(opts)
 

docs/SubmissionData.md

@@ -9,6 +9,7 @@ Name | Type | Description | Notes
 **field_overrides** | **Object** |  | [optional] 
 **html** | **String** |  | [optional] 
 **metadata** | **Object** |  | [optional] 
+**password** | **String** |  | [optional] 
 **test** | **BOOLEAN** |  | [optional]