docspring 1.2.0 → 1.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c74b21525656394ce9cefe7f7198a33bcba3f81f4c1301b0d215655f5b60c348
-  data.tar.gz: 1497deb61cbf6235ea8c5a0088b9188f23b09217904aad8e92b1e485bc5758cd
+  metadata.gz: e5dcdc4a15cf4315e7948d50bd6c5000579a43ea43a8192fdf56d835d486877d
+  data.tar.gz: ad497500fb8b69b49c62097727cf1bb24d7119deb4fa53660693184883a92115
 SHA512:
-  metadata.gz: b74efd924682d6d6f5466c4a2759cf27f0b0e6b31fedbdb240e1bf0491312b1e328a9226d6f8d791cc3681f4971146b88fed2dec90a0a88ad8702230ca14f089
-  data.tar.gz: 83ccf2ba22bbd9a967f63ac20a8c75197b58d5547e8ef55949f11df94feb3545dc719001fea511fb1ac4a124f22dd0fffdb4dce0afb4c8fad6adc41358b40f34
+  metadata.gz: 847f09feed503bec49f36de06eb23dce71bd842b8947de8bbaf6c9456c80db55230a5aaa3f5bbc292fc142d8351d501abb8efa3d641fca5c6528d38c932d1323
+  data.tar.gz: f9331fdfae0801c28f3b88b4d6c4947c8443b00da71ee0ec04c75ffaf8a1a26df03982a00521bd4559e1bab160d4369cbe79b118a1f53941f96eaa8be923ef64

data/.openapi-generator/VERSION

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

data/CHANGELOG.md

@@ -1,3 +1,23 @@
+### 1.4.0 [May 21, 2021]
+
+- Fix URI.escape deprecation warning for Ruby 2.7.0
+
+### 1.3.2 [November 19, 2020]
+
+- Added "sort_order" property for Submission Data Requests
+
+### 1.3.1 [September 27, 2020]
+
+- Changed gem author to DocSpring
+
+### 1.3.0 [September 26, 2020]
+
+- Updated OpenAPI Generator to v3.3.0
+
+### 1.2.1 [September 24, 2020]
+
+- 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
+
 ### 1.2.0 [September 21, 2020]
 
 - Renamed some internal models for template creation API endpoints. (CreateTemplateData / CreateTemplateData1 renamed to CreateHtmlTemplateData and CreateTemplateFromUploadData)

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    docspring (1.2.0)
+    docspring (1.4.0)
       ffi (~> 1.0, >= 1.9.24)
       json (>= 1.8)
       typhoeus (~> 1.0, >= 1.0.1)
@@ -14,8 +14,6 @@ GEM
       public_suffix (>= 2.0.2, < 5.0)
     autotest (4.4.6)
       ZenTest (>= 4.4.1)
-    autotest-fsevent (0.2.15)
-      sys-uname
     autotest-growl (0.2.16)
     autotest-rails-pure (4.1.2)
     bundler-audit (0.6.1)
@@ -54,8 +52,6 @@ GEM
       rspec-support (~> 3.9.0)
     rspec-support (3.9.2)
     safe_yaml (1.0.5)
-    sys-uname (1.2.0)
-      ffi (>= 1.0.0)
     thor (0.20.3)
     typhoeus (1.3.1)
       ethon (>= 0.9.0)
@@ -70,7 +66,6 @@ PLATFORMS
 
 DEPENDENCIES
   autotest (~> 4.4, >= 4.4.6)
-  autotest-fsevent (~> 0.2, >= 0.2.15)
   autotest-growl (~> 0.2, >= 0.2.16)
   autotest-rails-pure (~> 4.1, >= 4.1.2)
   bundler-audit
@@ -82,4 +77,4 @@ DEPENDENCIES
   webmock (~> 1.24, >= 1.24.3)
 
 BUNDLED WITH
-   2.1.4
+   2.2.11

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.2.0
+- Package version: 1.4.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.2.0.gem
+gem install ./docspring-1.4.0.gem
 ```
-(for development, run `gem install --dev ./docspring-1.2.0.gem` to install the development dependencies)
+(for development, run `gem install --dev ./docspring-1.4.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.2.0'
+    gem 'docspring', '~> 1.4.0'
 
 ### Install from Git
 
@@ -86,6 +86,7 @@ Class | Method | HTTP request | Description
 *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=2 | Merge submission PDFs, template PDFs, or custom files
 *DocSpring::PDFApi* | [**combine_submissions**](docs/PDFApi.md#combine_submissions) | **POST** /combined_submissions | Merge generated PDFs together
+*DocSpring::PDFApi* | [**copy_template**](docs/PDFApi.md#copy_template) | **POST** /templates/{template_id}/copy | Copy a Template
 *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
@@ -123,6 +124,7 @@ Class | Method | HTTP request | Description
  - [DocSpring::CombinedSubmission](docs/CombinedSubmission.md)
  - [DocSpring::CombinedSubmissionAction](docs/CombinedSubmissionAction.md)
  - [DocSpring::CombinedSubmissionData](docs/CombinedSubmissionData.md)
+ - [DocSpring::CopyTemplateData](docs/CopyTemplateData.md)
  - [DocSpring::CreateCombinedSubmissionResponse](docs/CreateCombinedSubmissionResponse.md)
  - [DocSpring::CreateCustomFileData](docs/CreateCustomFileData.md)
  - [DocSpring::CreateCustomFileResponse](docs/CreateCustomFileResponse.md)

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

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

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

@@ -6,8 +6,8 @@ Name | Type | Description | Notes
 **expiration_interval** | **String** |  | [optional] 
 **webhook_url** | **String** |  | [optional] 
 **scss** | **String** |  | [optional] 
-**expire_after** | **Float** |  | [optional] 
 **allow_additional_properties** | **BOOLEAN** |  | [optional] 
+**expire_after** | **Float** |  | [optional] 
 **description** | **String** |  | [optional] 
 **public_submissions** | **BOOLEAN** |  | [optional] 
 **slack_webhook_url** | **String** |  | [optional] 
@@ -16,8 +16,8 @@ Name | Type | Description | Notes
 **editable_submissions** | **BOOLEAN** |  | [optional] 
 **expire_submissions** | **BOOLEAN** |  | [optional] 
 **name** | **String** |  | [optional] 
-**html** | **String** |  | [optional] 
 **footer_html** | **String** |  | [optional] 
+**html** | **String** |  | [optional] 
 **template_type** | **String** |  | [optional] 
 **redirect_url** | **String** |  | [optional] 
 

data/docs/MoveTemplateData.md

@@ -3,6 +3,6 @@
 ## Properties
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**parent_folder_id** | **String** |  | [optional] 
+**parent_folder_id** | **String** |  | 
 
 

data/docs/PDFApi.md

@@ -9,6 +9,7 @@ Method | HTTP request | Description
 [**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
+[**copy_template**](PDFApi.md#copy_template) | **POST** /templates/{template_id}/copy | Copy a Template
 [**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
@@ -285,6 +286,57 @@ Name | Type | Description  | Notes
 
 
 
+# **copy_template**
+> Template copy_template(template_id, copy_template_data)
+
+Copy 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 | 
+copy_template_data = DocSpring::CopyTemplateData.new # CopyTemplateData | 
+
+begin
+  #Copy a Template
+  result = api_instance.copy_template(template_id, copy_template_data)
+  p result
+rescue DocSpring::ApiError => e
+  puts "Exception when calling PDFApi->copy_template: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **template_id** | **String**|  | 
+ **copy_template_data** | [**CopyTemplateData**](CopyTemplateData.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
+
+
+
 # **create_custom_file_from_upload**
 > CreateCustomFileResponse create_custom_file_from_upload(create_custom_file_data)
 
@@ -945,7 +997,7 @@ end
 api_instance = DocSpring::PDFApi.new
 submission_id = 'sub_000000000000000001' # String | 
 opts = {
-  include_data: false # BOOLEAN | 
+  include_data: true # BOOLEAN | 
 }
 
 begin

data/docs/Submission.md

@@ -11,6 +11,7 @@ Name | Type | Description | Notes
 **expires_at** | **String** |  | [optional] 
 **processed_at** | **String** |  | [optional] 
 **state** | **String** |  | 
+**data** | **Object** |  | [optional] 
 **metadata** | **Object** |  | [optional] 
 **truncated_text** | **Object** |  | [optional] 
 **pdf_hash** | **String** |  | [optional] 
@@ -19,5 +20,7 @@ Name | Type | Description | Notes
 **batch_id** | **String** |  | [optional] 
 **data_requests** | [**Array<SubmissionDataRequest>**](SubmissionDataRequest.md) |  | [optional] 
 **actions** | [**Array<SubmissionAction>**](SubmissionAction.md) |  | [optional] 
+**source** | **String** |  | [optional] 
+**referrer** | **String** |  | [optional] 
 
 

data/docs/SubmissionBatchData.md

@@ -4,8 +4,8 @@
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **metadata** | **Object** |  | [optional] 
-**test** | **BOOLEAN** |  | [optional] 
-**template_id** | **String** |  | [optional] 
 **submissions** | [**Array<SubmissionDataBatchRequest>**](SubmissionDataBatchRequest.md) |  | 
+**template_id** | **String** |  | [optional] 
+**test** | **BOOLEAN** |  | [optional] 
 
 

data/docs/SubmissionData.md

@@ -3,12 +3,12 @@
 ## Properties
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**test** | **BOOLEAN** |  | [optional] 
+**css** | **String** |  | [optional] 
 **data** | **Object** |  | 
+**data_requests** | [**Array<CreateSubmissionDataRequestData>**](CreateSubmissionDataRequestData.md) |  | [optional] 
+**field_overrides** | **Object** |  | [optional] 
 **html** | **String** |  | [optional] 
-**css** | **String** |  | [optional] 
 **metadata** | **Object** |  | [optional] 
-**field_overrides** | **Object** |  | [optional] 
-**data_requests** | [**Array<CreateSubmissionDataRequestData>**](CreateSubmissionDataRequestData.md) |  | [optional] 
+**test** | **BOOLEAN** |  | [optional] 
 
 

data/docs/SubmissionDataBatchRequest.md

@@ -5,9 +5,9 @@ Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **css** | **String** |  | [optional] 
 **metadata** | **Object** |  | [optional] 
-**test** | **BOOLEAN** |  | [optional] 
 **data** | **Object** |  | [optional] 
-**template_id** | **String** |  | [optional] 
+**test** | **BOOLEAN** |  | [optional] 
 **html** | **String** |  | [optional] 
+**template_id** | **String** |  | [optional] 
 
 

data/docs/SubmissionDataRequest.md

@@ -7,6 +7,7 @@ Name | Type | Description | Notes
 **name** | **String** |  | 
 **email** | **String** |  | 
 **order** | **Integer** |  | 
+**sort_order** | **Integer** |  | 
 **fields** | **Array<String>** |  | 
 **metadata** | **Object** |  | 
 **state** | **String** |  | 

data/docs/TemplateData.md

@@ -6,8 +6,8 @@ Name | Type | Description | Notes
 **expiration_interval** | **String** |  | [optional] 
 **webhook_url** | **String** |  | [optional] 
 **scss** | **String** |  | [optional] 
-**expire_after** | **Float** |  | [optional] 
 **allow_additional_properties** | **BOOLEAN** |  | [optional] 
+**expire_after** | **Float** |  | [optional] 
 **description** | **String** |  | [optional] 
 **public_submissions** | **BOOLEAN** |  | [optional] 
 **slack_webhook_url** | **String** |  | [optional] 
@@ -16,8 +16,8 @@ Name | Type | Description | Notes
 **editable_submissions** | **BOOLEAN** |  | [optional] 
 **expire_submissions** | **BOOLEAN** |  | [optional] 
 **name** | **String** |  | [optional] 
-**html** | **String** |  | [optional] 
 **footer_html** | **String** |  | [optional] 
+**html** | **String** |  | [optional] 
 **redirect_url** | **String** |  | [optional] 
 
 

data/docs/TemplatestemplateIdaddFieldsFields.md

@@ -3,8 +3,8 @@
 ## Properties
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**uppercase** | **BOOLEAN** |  | [optional] 
 **background_color_field_name** | **String** |  | [optional] 
+**uppercase** | **BOOLEAN** |  | [optional] 
 **metadata** | **String** |  | [optional] 
 **barcode_symbology** | **String** |  | [optional] 
 **min_length** | **Float** |  | [optional] 
@@ -23,19 +23,19 @@ Name | Type | Description | Notes
 **height** | **Float** |  | [optional] 
 **number_condition_range_exclusive_max** | **BOOLEAN** |  | [optional] 
 **invert_boolean_condition** | **BOOLEAN** |  | [optional] 
-**static** | **BOOLEAN** |  | [optional] 
 **shape_fill_color_field_name** | **String** |  | [optional] 
+**static** | **BOOLEAN** |  | [optional] 
 **shape_border_color_field_name** | **String** |  | [optional] 
 **v_alignment** | **String** |  | [optional] 
 **bold** | **BOOLEAN** |  | [optional] 
 **shape_border_width** | **Float** |  | [optional] 
 **comb_number_of_cells** | **Float** |  | [optional] 
 **shape_border_color** | **String** |  | [optional] 
-**typeface** | **String** |  | [optional] 
 **comb** | **BOOLEAN** |  | [optional] 
+**typeface** | **String** |  | [optional] 
 **shape_type** | **String** |  | [optional] 
-**display_type** | **String** |  | [optional] 
 **condition** | **String** |  | [optional] 
+**display_type** | **String** |  | [optional] 
 **check_color** | **String** |  | [optional] 
 **multiline_lines** | **Float** |  | [optional] 
 **multiline** | **BOOLEAN** |  | [optional] 
@@ -49,8 +49,8 @@ Name | Type | Description | Notes
 **color_field_name** | **String** |  | [optional] 
 **qrcode_color_field_name** | **String** |  | [optional] 
 **number_condition_range_min** | **Float** |  | [optional] 
-**hidden** | **BOOLEAN** |  | [optional] 
 **color** | **String** |  | [optional] 
+**hidden** | **BOOLEAN** |  | [optional] 
 **check_color_field_required** | **BOOLEAN** |  | [optional] 
 **combined_field_format** | **String** |  | [optional] 
 **description** | **String** |  | [optional] 
@@ -65,8 +65,8 @@ Name | Type | Description | Notes
 **date_time_format** | **String** |  | [optional] 
 **qrcode_color_field_required** | **BOOLEAN** |  | [optional] 
 **currency** | **BOOLEAN** |  | [optional] 
-**strikethrough** | **BOOLEAN** |  | [optional] 
 **false_text** | **String** |  | [optional] 
+**strikethrough** | **BOOLEAN** |  | [optional] 
 **character_spacing** | **Float** |  | [optional] 
 **number_condition_range_max** | **Float** |  | [optional] 
 **background_color** | **String** |  | [optional] 
@@ -77,15 +77,15 @@ Name | Type | Description | Notes
 **shape_fill_color** | **String** |  | [optional] 
 **string_condition_type** | **String** |  | [optional] 
 **shape_fill_color_field_required** | **BOOLEAN** |  | [optional] 
-**include_time** | **BOOLEAN** |  | [optional] 
 **decimal_places** | **Float** |  | [optional] 
-**x** | **Float** |  | [optional] 
+**include_time** | **BOOLEAN** |  | [optional] 
 **width** | **Float** |  | [optional] 
+**x** | **Float** |  | [optional] 
 **maximum** | **Float** |  | [optional] 
 **y** | **Float** |  | [optional] 
 **signature_allow_draw** | **BOOLEAN** |  | [optional] 
-**opacity** | **Float** |  | [optional] 
 **number_condition_type** | **String** |  | [optional] 
+**opacity** | **Float** |  | [optional] 
 **minimum** | **Float** |  | [optional] 
 **signature_allow_type** | **BOOLEAN** |  | [optional]