docspring 1.0.0 → 1.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cee0ce15eabd610765888e637b1e86d2e597844224f000b91889e866b0a5a851
-  data.tar.gz: 5de24c41293961ac2fe26e0f3b863440aab35e6043f7cce350276515d94e2443
+  metadata.gz: 1be91b76c31c9162e4c340d87023d7db134d30348d791ff72ee62b2d594898f1
+  data.tar.gz: 36899cc962a45a4b600aee02a939d5785c7d4119170265ebffb5ddad27338f2d
 SHA512:
-  metadata.gz: a26e65e0212f2b7175e4b43aa3e896302419d0f00fc376cb545dd586492ef1355b3a30c1cdab948a57f52932281ad8311f568d5ba622b08bb679d58b094bb9ee
-  data.tar.gz: 80d79e2142642d96b72846ef6aaf22591b8ac393b5b0bf49884987e98672705bc312a2133d853335dfe6b2caf1dbffe0ae2108d140013b3db0697a6f5bb641d4
+  metadata.gz: fa5cf74b0d0d6c4725f3f8cbddf5035db11de42c721bc9e63d9346ad88fdc0721ff57907ca808d12018bd1997aed5865dc4e2618a9fb858c0ebb64c712eca5c0
+  data.tar.gz: 458febae51a15f31ea6ad97e41958c3a3f9d3647c17b64a49cb686066da9f485a22a1a90d224f16a5ea11a64c793c7f6fbcba99e310acf82e20bc400023354af

data/.openapi-generator/VERSION

@@ -1 +1 @@
-3.3.0-SNAPSHOT
+3.3.0

data/CHANGELOG.md

@@ -1,48 +1,25 @@
-### 1.12.0 [October 10, 2019]
+### 1.3.1 [September 27, 2020]
 
-- Add permanent_download_url attribute to Submission model
+- Changed gem author to DocSpring
 
-### 1.11.0 [October 9, 2019]
+### 1.3.0 [September 26, 2020]
 
-- 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
+- Updated OpenAPI Generator to v3.3.0
 
-### 1.10.0 [Aug 7, 2019]
-* Added Create Folder, List Folder, Move to Folder endpoints
+### 1.2.1 [September 24, 2020]
 
-### 1.9.1 [August 2, 2019]
+- Fixed the "include_data=true" option for the "Get Submission" API endpoint. Added the "data" property to the Submission model so that this is parsed and returned correctly when requested
 
-- Relax json dependency to support older versions (>= 1.8)
+### 1.2.0 [September 21, 2020]
 
-### 1.9.0 [June 22, 2019]
+- Renamed some internal models for template creation API endpoints. (CreateTemplateData / CreateTemplateData1 renamed to CreateHtmlTemplateData and CreateTemplateFromUploadData)
 
-- **BREAKING CHANGE** Renamed "Get Templates" endpoint to "List Templates". Added a search query parameter.
+### 1.1.0 [September 12, 2020]
 
-### 1.8.0 [April 11, 2019]
+- **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
 
-- Added support for editable PDFS (editable: true)
+### 1.0.0 [May 20, 2019]
 
-### 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.3.1)
       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/LICENSE

@@ -1,4 +1,4 @@
-Copyright © 2018 Form Applications Inc.
+Copyright © 2018-2020 DocSpring, Inc.
 
 Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
 

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.3.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.0.0.gem
+gem install ./docspring-1.3.1.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.3.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.0.0'
+    gem 'docspring', '~> 1.3.1'
 
 ### Install from Git
 
@@ -62,15 +62,15 @@ DocSpring.configure do |config|
 end
 
 api_instance = DocSpring::PDFApi.new
-template_id = 'tpl_000000000000000001' # String | 
-request_body = nil # Array<Object> | 
+template_id = 'tpl_000000000000000002' # String | 
+add_fields_data = DocSpring::AddFieldsData.new # AddFieldsData | 
 
 begin
-  #Generates multiple PDFs
-  result = api_instance.batch_generate_pdf_v1(template_id, request_body)
+  #Add new fields to a Template
+  result = api_instance.add_fields_to_template(template_id, add_fields_data)
   p result
 rescue DocSpring::ApiError => e
-  puts "Exception when calling PDFApi->batch_generate_pdf_v1: #{e}"
+  puts "Exception when calling PDFApi->add_fields_to_template: #{e}"
 end
 
 ```
@@ -81,6 +81,7 @@ All URIs are relative to *https://api.docspring.com/api/v1*
 
 Class | Method | HTTP request | Description
 ------------ | ------------- | ------------- | -------------
+*DocSpring::PDFApi* | [**add_fields_to_template**](docs/PDFApi.md#add_fields_to_template) | **PUT** /templates/{template_id}/add_fields | Add new fields to a Template
 *DocSpring::PDFApi* | [**batch_generate_pdf_v1**](docs/PDFApi.md#batch_generate_pdf_v1) | **POST** /templates/{template_id}/submissions/batch | Generates multiple PDFs
 *DocSpring::PDFApi* | [**batch_generate_pdfs**](docs/PDFApi.md#batch_generate_pdfs) | **POST** /submissions/batches | Generates multiple PDFs
 *DocSpring::PDFApi* | [**combine_pdfs**](docs/PDFApi.md#combine_pdfs) | **POST** /combined_submissions?v&#x3D;2 | Merge submission PDFs, template PDFs, or custom files
@@ -88,8 +89,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&#x3D;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&#x3D;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&#x3D;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,10 +110,13 @@ 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
 
+ - [DocSpring::AddFieldsData](docs/AddFieldsData.md)
+ - [DocSpring::AddFieldsTemplateResponse](docs/AddFieldsTemplateResponse.md)
  - [DocSpring::AuthenticationError](docs/AuthenticationError.md)
  - [DocSpring::AuthenticationSuccessResponse](docs/AuthenticationSuccessResponse.md)
  - [DocSpring::CombinePdfsData](docs/CombinePdfsData.md)
@@ -122,17 +127,19 @@ Class | Method | HTTP request | Description
  - [DocSpring::CreateCustomFileData](docs/CreateCustomFileData.md)
  - [DocSpring::CreateCustomFileResponse](docs/CreateCustomFileResponse.md)
  - [DocSpring::CreateFolderData](docs/CreateFolderData.md)
+ - [DocSpring::CreateHtmlTemplateData](docs/CreateHtmlTemplateData.md)
  - [DocSpring::CreateSubmissionBatchResponse](docs/CreateSubmissionBatchResponse.md)
  - [DocSpring::CreateSubmissionBatchSubmissionsResponse](docs/CreateSubmissionBatchSubmissionsResponse.md)
  - [DocSpring::CreateSubmissionDataRequestData](docs/CreateSubmissionDataRequestData.md)
  - [DocSpring::CreateSubmissionDataRequestTokenResponse](docs/CreateSubmissionDataRequestTokenResponse.md)
  - [DocSpring::CreateSubmissionDataRequestTokenResponseToken](docs/CreateSubmissionDataRequestTokenResponseToken.md)
  - [DocSpring::CreateSubmissionResponse](docs/CreateSubmissionResponse.md)
- - [DocSpring::CreateTemplateData](docs/CreateTemplateData.md)
+ - [DocSpring::CreateTemplateFromUploadData](docs/CreateTemplateFromUploadData.md)
  - [DocSpring::CustomFile](docs/CustomFile.md)
  - [DocSpring::Error](docs/Error.md)
  - [DocSpring::Folder](docs/Folder.md)
  - [DocSpring::FoldersFolder](docs/FoldersFolder.md)
+ - [DocSpring::HtmlTemplateData](docs/HtmlTemplateData.md)
  - [DocSpring::InvalidRequest](docs/InvalidRequest.md)
  - [DocSpring::MoveFolderData](docs/MoveFolderData.md)
  - [DocSpring::MoveTemplateData](docs/MoveTemplateData.md)
@@ -146,11 +153,15 @@ 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::TemplateData](docs/TemplateData.md)
+ - [DocSpring::TemplatestemplateIdaddFieldsFields](docs/TemplatestemplateIdaddFieldsFields.md)
  - [DocSpring::UpdateDataRequestResponse](docs/UpdateDataRequestResponse.md)
  - [DocSpring::UpdateSubmissionDataRequestData](docs/UpdateSubmissionDataRequestData.md)
+ - [DocSpring::UpdateTemplateData](docs/UpdateTemplateData.md)
+ - [DocSpring::UpdateTemplateResponse](docs/UpdateTemplateResponse.md)
+ - [DocSpring::UploadTemplateData](docs/UploadTemplateData.md)
+ - [DocSpring::UploadTemplateDataDocument](docs/UploadTemplateDataDocument.md)
+ - [DocSpring::UploadTemplateDataDocumentMetadata](docs/UploadTemplateDataDocumentMetadata.md)
 
 
 ## Documentation for Authorization

data/docs/AddFieldsData.md

@@ -0,0 +1,8 @@
+# DocSpring::AddFieldsData
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**fields** | [**Array<TemplatestemplateIdaddFieldsFields>**](TemplatestemplateIdaddFieldsFields.md) |  | 
+
+

data/docs/AddFieldsTemplateResponse.md

@@ -0,0 +1,10 @@
+# DocSpring::AddFieldsTemplateResponse
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**new_field_ids** | **Array<Integer>** |  | [optional] 
+**errors** | **Array<String>** |  | [optional] 
+**status** | **String** |  | [optional] 
+
+

data/docs/CombinePdfsData.md

@@ -3,10 +3,10 @@
 ## Properties
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**test** | **BOOLEAN** |  | [optional] 
-**source_pdfs** | **Array<Object>** |  | 
-**metadata** | **Object** |  | [optional] 
-**expires_in** | **Integer** |  | [optional] 
 **delete_custom_files** | **BOOLEAN** |  | [optional] 
+**expires_in** | **Integer** |  | [optional] 
+**metadata** | **Object** |  | [optional] 
+**source_pdfs** | **Array<Object>** |  | 
+**test** | **BOOLEAN** |  | [optional] 
 
 

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/CombinedSubmissionData.md

@@ -3,9 +3,9 @@
 ## Properties
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**test** | **BOOLEAN** |  | [optional] 
-**submission_ids** | **Array<String>** |  | 
-**metadata** | **Object** |  | [optional] 
 **expires_in** | **Integer** |  | [optional] 
+**metadata** | **Object** |  | [optional] 
+**submission_ids** | **Array<String>** |  | 
+**test** | **BOOLEAN** |  | [optional] 
 
 

data/docs/{CreateTemplateData.md → CreateHtmlTemplateData.md}

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

data/docs/CreateSubmissionDataRequestData.md

@@ -3,8 +3,8 @@
 ## Properties
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**metadata** | **Object** |  | [optional] 
 **auth_type** | **String** |  | [optional] 
+**metadata** | **Object** |  | [optional] 
 **auth_second_factor_type** | **String** |  | [optional] 
 **auth_phone_number_hash** | **String** |  | [optional] 
 **auth_session_started_at** | **String** |  | [optional] 
@@ -13,8 +13,8 @@ Name | Type | Description | Notes
 **auth_username_hash** | **String** |  | [optional] 
 **name** | **String** |  | [optional] 
 **fields** | **Array<String>** |  | [optional] 
-**email** | **String** |  | [optional] 
 **auth_provider** | **String** |  | [optional] 
+**email** | **String** |  | [optional] 
 **order** | **Integer** |  | [optional] 
 
 

data/docs/CreateTemplateFromUploadData.md

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

data/docs/HtmlTemplateData.md

@@ -0,0 +1,24 @@
+# DocSpring::HtmlTemplateData
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**expiration_interval** | **String** |  | [optional] 
+**webhook_url** | **String** |  | [optional] 
+**scss** | **String** |  | [optional] 
+**allow_additional_properties** | **BOOLEAN** |  | [optional] 
+**expire_after** | **Float** |  | [optional] 
+**description** | **String** |  | [optional] 
+**public_submissions** | **BOOLEAN** |  | [optional] 
+**slack_webhook_url** | **String** |  | [optional] 
+**header_html** | **String** |  | [optional] 
+**public_web_form** | **BOOLEAN** |  | [optional] 
+**editable_submissions** | **BOOLEAN** |  | [optional] 
+**expire_submissions** | **BOOLEAN** |  | [optional] 
+**name** | **String** |  | [optional] 
+**footer_html** | **String** |  | [optional] 
+**html** | **String** |  | [optional] 
+**template_type** | **String** |  | [optional] 
+**redirect_url** | **String** |  | [optional] 
+
+