docspring 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cee0ce15eabd610765888e637b1e86d2e597844224f000b91889e866b0a5a851
-  data.tar.gz: 5de24c41293961ac2fe26e0f3b863440aab35e6043f7cce350276515d94e2443
+  metadata.gz: 46c0017858d8012630a820ae7499d88d2964a1bb96e771e916d338afaac9ba45
+  data.tar.gz: 36a5f2e2b37ab68927634e17b4536a7a3863a31cfd588b455ecde828edad53c8
 SHA512:
-  metadata.gz: a26e65e0212f2b7175e4b43aa3e896302419d0f00fc376cb545dd586492ef1355b3a30c1cdab948a57f52932281ad8311f568d5ba622b08bb679d58b094bb9ee
-  data.tar.gz: 80d79e2142642d96b72846ef6aaf22591b8ac393b5b0bf49884987e98672705bc312a2133d853335dfe6b2caf1dbffe0ae2108d140013b3db0697a6f5bb641d4
+  metadata.gz: 4bfa4fb139f798ee2ec7dcf3bdf3728aeed65b72733367c1078e0b54ad23b35c7595f7008817e3ed4fda29a90393a1d6404c210ee0b0fc71953947c5ecc32919
+  data.tar.gz: 9dfb52bda962c02434dc1858f66e40ecd635001132cf03534d76de8ee12e2b9daca898769d1dfd0a742b28ef7d15a3ab2c1eed00c8767434ac1b2d99b5aee55d

data/CHANGELOG.md

@@ -1,48 +1,9 @@
-### 1.12.0 [October 10, 2019]
+### 1.1.0 [September 12, 2020]
 
-- Add permanent_download_url attribute to Submission model
+- **BREAKING CHANGE**: Renamed createTemplate operation to createPDFTemplate
+- Added createHTMLTemplate operation. (This uses the same API endpoint as createPDFTemplate, but the example shows how to set html, scss, etc. fields)
+- Added updateTemplate operation, to update a PDF or HTML template
 
-### 1.11.0 [October 9, 2019]
+### 1.0.0 [May 20, 2019]
 
-- Add parent folder ID and path params to GET template response
-- Add parent folder ID param when creating a new template, so you can upload a template into a folder
-
-### 1.10.0 [Aug 7, 2019]
-* Added Create Folder, List Folder, Move to Folder endpoints
-
-### 1.9.1 [August 2, 2019]
-
-- Relax json dependency to support older versions (>= 1.8)
-
-### 1.9.0 [June 22, 2019]
-
-- **BREAKING CHANGE** Renamed "Get Templates" endpoint to "List Templates". Added a search query parameter.
-
-### 1.8.0 [April 11, 2019]
-
-- Added support for editable PDFS (editable: true)
-
-### 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
-
-### 1.5.0 [December 13, 2018]
-
-- Fix model name for newly created Templates (PendingTemplate)
-- Added "actions" to submission and combined_submission responses. Includes information about custom S3 uploads
-
-### 1.4.1 [December 2, 2018]
-
-- Fixed crash in 1.4.0, did not include all of the necessary files
-
-### 1.4.0 [December 1, 2018]
-
-- Added Create Template, Get Template, and Get Template Schema endpoints
-
-### 1.3.0 [November 4, 2018]
-
-- Initial changelog
+- Renamed FormAPI to DocSpring. (View the CHANGELOG in the original FormAPI API client for prior releases.)

data/Gemfile

@@ -3,6 +3,7 @@ source 'https://rubygems.org'
 gemspec
 
 group :development, :test do
-  gem 'rake', '~> 12.0.0'
+  gem 'rake', '>= 12.3.3'
   gem 'pry-byebug'
+  gem 'bundler-audit'
 end

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    docspring (1.0.0)
+    docspring (1.1.0)
       ffi (~> 1.0, >= 1.9.24)
       json (>= 1.8)
       typhoeus (~> 1.0, >= 1.0.1)
@@ -10,50 +10,54 @@ GEM
   remote: https://rubygems.org/
   specs:
     ZenTest (4.12.0)
-    addressable (2.5.2)
-      public_suffix (>= 2.0.2, < 4.0)
+    addressable (2.7.0)
+      public_suffix (>= 2.0.2, < 5.0)
     autotest (4.4.6)
       ZenTest (>= 4.4.1)
-    autotest-fsevent (0.2.14)
+    autotest-fsevent (0.2.15)
       sys-uname
     autotest-growl (0.2.16)
     autotest-rails-pure (4.1.2)
-    byebug (10.0.2)
+    bundler-audit (0.6.1)
+      bundler (>= 1.2.0, < 3)
+      thor (~> 0.18)
+    byebug (11.1.1)
     coderay (1.1.2)
     crack (0.4.3)
       safe_yaml (~> 1.0.0)
     diff-lcs (1.3)
-    ethon (0.11.0)
+    ethon (0.12.0)
       ffi (>= 1.3.0)
-    ffi (1.9.25)
-    hashdiff (0.3.7)
-    json (2.1.0)
-    method_source (0.9.0)
-    pry (0.11.3)
+    ffi (1.12.2)
+    hashdiff (1.0.1)
+    json (2.3.0)
+    method_source (0.9.2)
+    pry (0.12.2)
       coderay (~> 1.1.0)
       method_source (~> 0.9.0)
-    pry-byebug (3.6.0)
-      byebug (~> 10.0)
+    pry-byebug (3.8.0)
+      byebug (~> 11.0)
       pry (~> 0.10)
-    public_suffix (3.0.3)
-    rake (12.0.0)
-    rspec (3.8.0)
-      rspec-core (~> 3.8.0)
-      rspec-expectations (~> 3.8.0)
-      rspec-mocks (~> 3.8.0)
-    rspec-core (3.8.0)
-      rspec-support (~> 3.8.0)
-    rspec-expectations (3.8.1)
+    public_suffix (4.0.3)
+    rake (13.0.1)
+    rspec (3.9.0)
+      rspec-core (~> 3.9.0)
+      rspec-expectations (~> 3.9.0)
+      rspec-mocks (~> 3.9.0)
+    rspec-core (3.9.1)
+      rspec-support (~> 3.9.1)
+    rspec-expectations (3.9.0)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.8.0)
-    rspec-mocks (3.8.0)
+      rspec-support (~> 3.9.0)
+    rspec-mocks (3.9.1)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.8.0)
-    rspec-support (3.8.0)
-    safe_yaml (1.0.4)
-    sys-uname (1.0.3)
+      rspec-support (~> 3.9.0)
+    rspec-support (3.9.2)
+    safe_yaml (1.0.5)
+    sys-uname (1.2.0)
       ffi (>= 1.0.0)
-    typhoeus (1.3.0)
+    thor (0.20.3)
+    typhoeus (1.3.1)
       ethon (>= 0.9.0)
     vcr (3.0.3)
     webmock (1.24.6)
@@ -66,15 +70,16 @@ PLATFORMS
 
 DEPENDENCIES
   autotest (~> 4.4, >= 4.4.6)
-  autotest-fsevent (~> 0.2, >= 0.2.12)
+  autotest-fsevent (~> 0.2, >= 0.2.15)
   autotest-growl (~> 0.2, >= 0.2.16)
   autotest-rails-pure (~> 4.1, >= 4.1.2)
+  bundler-audit
   docspring!
   pry-byebug
-  rake (~> 12.0.0)
+  rake (>= 12.3.3)
   rspec (~> 3.6, >= 3.6.0)
   vcr (~> 3.0, >= 3.0.1)
   webmock (~> 1.24, >= 1.24.3)
 
 BUNDLED WITH
-   2.0.2
+   2.1.4

data/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.0.0
+- Package version: 1.1.0
 - 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.0.0.gem
+gem install ./docspring-1.1.0.gem
 ```
-(for development, run `gem install --dev ./docspring-1.0.0.gem` to install the development dependencies)
+(for development, run `gem install --dev ./docspring-1.1.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 'docspring', '~> 1.0.0'
+    gem 'docspring', '~> 1.1.0'
 
 ### Install from Git
 
@@ -88,8 +88,9 @@ Class | Method | HTTP request | Description
 *DocSpring::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
 *DocSpring::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
 *DocSpring::PDFApi* | [**create_folder**](docs/PDFApi.md#create_folder) | **POST** /folders/ | Create a folder
-*DocSpring::PDFApi* | [**create_template**](docs/PDFApi.md#create_template) | **POST** /templates | Upload a new PDF template with a file upload
-*DocSpring::PDFApi* | [**create_template_from_upload**](docs/PDFApi.md#create_template_from_upload) | **POST** /templates?v=2 | Create a new PDF template from a cached presign upload
+*DocSpring::PDFApi* | [**create_html_template**](docs/PDFApi.md#create_html_template) | **POST** /templates?desc=html | Create a new HTML template
+*DocSpring::PDFApi* | [**create_pdf_template**](docs/PDFApi.md#create_pdf_template) | **POST** /templates | Create a new PDF template with a form POST file upload
+*DocSpring::PDFApi* | [**create_pdf_template_from_upload**](docs/PDFApi.md#create_pdf_template_from_upload) | **POST** /templates?desc=cached_upload | Create a new PDF template from a cached presign upload
 *DocSpring::PDFApi* | [**delete_folder**](docs/PDFApi.md#delete_folder) | **DELETE** /folders/{folder_id} | Delete a folder
 *DocSpring::PDFApi* | [**expire_combined_submission**](docs/PDFApi.md#expire_combined_submission) | **DELETE** /combined_submissions/{combined_submission_id} | Expire a combined submission
 *DocSpring::PDFApi* | [**expire_submission**](docs/PDFApi.md#expire_submission) | **DELETE** /submissions/{submission_id} | Expire a PDF submission
@@ -108,6 +109,7 @@ Class | Method | HTTP request | Description
 *DocSpring::PDFApi* | [**rename_folder**](docs/PDFApi.md#rename_folder) | **POST** /folders/{folder_id}/rename | Rename a folder
 *DocSpring::PDFApi* | [**test_authentication**](docs/PDFApi.md#test_authentication) | **GET** /authentication | Test Authentication
 *DocSpring::PDFApi* | [**update_data_request**](docs/PDFApi.md#update_data_request) | **PUT** /data_requests/{data_request_id} | Update a submission data request
+*DocSpring::PDFApi* | [**update_template**](docs/PDFApi.md#update_template) | **PUT** /templates/{template_id} | Update a Template
 
 
 ## Documentation for Models
@@ -129,6 +131,7 @@ Class | Method | HTTP request | Description
  - [DocSpring::CreateSubmissionDataRequestTokenResponseToken](docs/CreateSubmissionDataRequestTokenResponseToken.md)
  - [DocSpring::CreateSubmissionResponse](docs/CreateSubmissionResponse.md)
  - [DocSpring::CreateTemplateData](docs/CreateTemplateData.md)
+ - [DocSpring::CreateTemplateData1](docs/CreateTemplateData1.md)
  - [DocSpring::CustomFile](docs/CustomFile.md)
  - [DocSpring::Error](docs/Error.md)
  - [DocSpring::Folder](docs/Folder.md)
@@ -146,11 +149,14 @@ Class | Method | HTTP request | Description
  - [DocSpring::SubmissionDataBatchRequest](docs/SubmissionDataBatchRequest.md)
  - [DocSpring::SubmissionDataRequest](docs/SubmissionDataRequest.md)
  - [DocSpring::Template](docs/Template.md)
- - [DocSpring::Templatesv2Template](docs/Templatesv2Template.md)
- - [DocSpring::Templatesv2TemplateDocument](docs/Templatesv2TemplateDocument.md)
- - [DocSpring::Templatesv2TemplateDocumentMetadata](docs/Templatesv2TemplateDocumentMetadata.md)
+ - [DocSpring::TemplatesdesccachedUploadTemplate](docs/TemplatesdesccachedUploadTemplate.md)
+ - [DocSpring::TemplatesdesccachedUploadTemplateDocument](docs/TemplatesdesccachedUploadTemplateDocument.md)
+ - [DocSpring::TemplatesdesccachedUploadTemplateDocumentMetadata](docs/TemplatesdesccachedUploadTemplateDocumentMetadata.md)
+ - [DocSpring::TemplatestemplateIdTemplate](docs/TemplatestemplateIdTemplate.md)
  - [DocSpring::UpdateDataRequestResponse](docs/UpdateDataRequestResponse.md)
  - [DocSpring::UpdateSubmissionDataRequestData](docs/UpdateSubmissionDataRequestData.md)
+ - [DocSpring::UpdateTemplateData](docs/UpdateTemplateData.md)
+ - [DocSpring::UpdateTemplateResponse](docs/UpdateTemplateResponse.md)
 
 
 ## Documentation for Authorization

data/docs/CombinedSubmission.md

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

data/docs/CreateTemplateData.md

@@ -3,6 +3,6 @@
 ## Properties
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**template** | [**Templatesv2Template**](Templatesv2Template.md) |  | 
+**template** | [**TemplatesdesccachedUploadTemplate**](TemplatesdesccachedUploadTemplate.md) |  | 
 
 

data/docs/CreateTemplateData1.md

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

data/docs/PDFApi.md

@@ -11,8 +11,9 @@ Method | HTTP request | Description
 [**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
+[**create_html_template**](PDFApi.md#create_html_template) | **POST** /templates?desc=html | Create a new HTML template
+[**create_pdf_template**](PDFApi.md#create_pdf_template) | **POST** /templates | Create a new PDF template with a form POST file upload
+[**create_pdf_template_from_upload**](PDFApi.md#create_pdf_template_from_upload) | **POST** /templates?desc=cached_upload | 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
@@ -31,6 +32,7 @@ Method | HTTP request | Description
 [**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
+[**update_template**](PDFApi.md#update_template) | **PUT** /templates/{template_id} | Update a Template
 
 
 # **batch_generate_pdf_v1**
@@ -378,10 +380,59 @@ Name | Type | Description  | Notes
 
 
 
-# **create_template**
-> PendingTemplate create_template(template_document, template_name, opts)
+# **create_html_template**
+> PendingTemplate create_html_template(create_template_data1)
 
-Upload a new PDF template with a file upload
+Create a new HTML 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
+create_template_data1 = DocSpring::CreateTemplateData1.new # CreateTemplateData1 | 
+
+begin
+  #Create a new HTML template
+  result = api_instance.create_html_template(create_template_data1)
+  p result
+rescue DocSpring::ApiError => e
+  puts "Exception when calling PDFApi->create_html_template: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **create_template_data1** | [**CreateTemplateData1**](CreateTemplateData1.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
+
+
+
+# **create_pdf_template**
+> PendingTemplate create_pdf_template(template_document, template_name, opts)
+
+Create a new PDF template with a form POST file upload
 
 ### Example
 ```ruby
@@ -402,11 +453,11 @@ opts = {
 }
 
 begin
-  #Upload a new PDF template with a file upload
-  result = api_instance.create_template(template_document, template_name, opts)
+  #Create a new PDF template with a form POST file upload
+  result = api_instance.create_pdf_template(template_document, template_name, opts)
   p result
 rescue DocSpring::ApiError => e
-  puts "Exception when calling PDFApi->create_template: #{e}"
+  puts "Exception when calling PDFApi->create_pdf_template: #{e}"
 end
 ```
 
@@ -433,8 +484,8 @@ Name | Type | Description  | Notes
 
 
 
-# **create_template_from_upload**
-> PendingTemplate create_template_from_upload(create_template_data)
+# **create_pdf_template_from_upload**
+> PendingTemplate create_pdf_template_from_upload(create_template_data)
 
 Create a new PDF template from a cached presign upload
 
@@ -454,10 +505,10 @@ 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)
+  result = api_instance.create_pdf_template_from_upload(create_template_data)
   p result
 rescue DocSpring::ApiError => e
-  puts "Exception when calling PDFApi->create_template_from_upload: #{e}"
+  puts "Exception when calling PDFApi->create_pdf_template_from_upload: #{e}"
 end
 ```
 
@@ -1383,3 +1434,54 @@ Name | Type | Description  | Notes
 
 
 
+# **update_template**
+> UpdateTemplateResponse update_template(template_id, update_template_data)
+
+Update 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_000000000000000003' # String | 
+update_template_data = DocSpring::UpdateTemplateData.new # UpdateTemplateData | 
+
+begin
+  #Update a Template
+  result = api_instance.update_template(template_id, update_template_data)
+  p result
+rescue DocSpring::ApiError => e
+  puts "Exception when calling PDFApi->update_template: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **template_id** | **String**|  | 
+ **update_template_data** | [**UpdateTemplateData**](UpdateTemplateData.md)|  | 
+
+### Return type
+
+[**UpdateTemplateResponse**](UpdateTemplateResponse.md)
+
+### Authorization
+
+[api_token_basic](../README.md#api_token_basic)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+