docspring 1.1.0 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 46c0017858d8012630a820ae7499d88d2964a1bb96e771e916d338afaac9ba45
-  data.tar.gz: 36a5f2e2b37ab68927634e17b4536a7a3863a31cfd588b455ecde828edad53c8
+  metadata.gz: c74b21525656394ce9cefe7f7198a33bcba3f81f4c1301b0d215655f5b60c348
+  data.tar.gz: 1497deb61cbf6235ea8c5a0088b9188f23b09217904aad8e92b1e485bc5758cd
 SHA512:
-  metadata.gz: 4bfa4fb139f798ee2ec7dcf3bdf3728aeed65b72733367c1078e0b54ad23b35c7595f7008817e3ed4fda29a90393a1d6404c210ee0b0fc71953947c5ecc32919
-  data.tar.gz: 9dfb52bda962c02434dc1858f66e40ecd635001132cf03534d76de8ee12e2b9daca898769d1dfd0a742b28ef7d15a3ab2c1eed00c8767434ac1b2d99b5aee55d
+  metadata.gz: b74efd924682d6d6f5466c4a2759cf27f0b0e6b31fedbdb240e1bf0491312b1e328a9226d6f8d791cc3681f4971146b88fed2dec90a0a88ad8702230ca14f089
+  data.tar.gz: 83ccf2ba22bbd9a967f63ac20a8c75197b58d5547e8ef55949f11df94feb3545dc719001fea511fb1ac4a124f22dd0fffdb4dce0afb4c8fad6adc41358b40f34

data/CHANGELOG.md

@@ -1,3 +1,7 @@
+### 1.2.0 [September 21, 2020]
+
+- Renamed some internal models for template creation API endpoints. (CreateTemplateData / CreateTemplateData1 renamed to CreateHtmlTemplateData and CreateTemplateFromUploadData)
+
 ### 1.1.0 [September 12, 2020]
 
 - **BREAKING CHANGE**: Renamed createTemplate operation to createPDFTemplate

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    docspring (1.1.0)
+    docspring (1.2.0)
       ffi (~> 1.0, >= 1.9.24)
       json (>= 1.8)
       typhoeus (~> 1.0, >= 1.0.1)

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.1.0
+- Package version: 1.2.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.1.0.gem
+gem install ./docspring-1.2.0.gem
 ```
-(for development, run `gem install --dev ./docspring-1.1.0.gem` to install the development dependencies)
+(for development, run `gem install --dev ./docspring-1.2.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.1.0'
+    gem 'docspring', '~> 1.2.0'
 
 ### 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
@@ -114,6 +115,8 @@ Class | Method | HTTP request | Description
 
 ## 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)
@@ -124,18 +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::CreateTemplateData1](docs/CreateTemplateData1.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)
@@ -149,14 +153,15 @@ Class | Method | HTTP request | Description
  - [DocSpring::SubmissionDataBatchRequest](docs/SubmissionDataBatchRequest.md)
  - [DocSpring::SubmissionDataRequest](docs/SubmissionDataRequest.md)
  - [DocSpring::Template](docs/Template.md)
- - [DocSpring::TemplatesdesccachedUploadTemplate](docs/TemplatesdesccachedUploadTemplate.md)
- - [DocSpring::TemplatesdesccachedUploadTemplateDocument](docs/TemplatesdesccachedUploadTemplateDocument.md)
- - [DocSpring::TemplatesdesccachedUploadTemplateDocumentMetadata](docs/TemplatesdesccachedUploadTemplateDocumentMetadata.md)
- - [DocSpring::TemplatestemplateIdTemplate](docs/TemplatestemplateIdTemplate.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/CreateHtmlTemplateData.md

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

data/docs/CreateTemplateFromUploadData.md

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

data/docs/{TemplatesdesccachedUploadTemplate.md → HtmlTemplateData.md}

@@ -1,4 +1,4 @@
-# DocSpring::TemplatesdesccachedUploadTemplate
+# DocSpring::HtmlTemplateData
 
 ## Properties
 Name | Type | Description | Notes
@@ -8,7 +8,6 @@ Name | Type | Description | Notes
 **scss** | **String** |  | [optional] 
 **expire_after** | **Float** |  | [optional] 
 **allow_additional_properties** | **BOOLEAN** |  | [optional] 
-**document** | [**TemplatesdesccachedUploadTemplateDocument**](TemplatesdesccachedUploadTemplateDocument.md) |  | [optional] 
 **description** | **String** |  | [optional] 
 **public_submissions** | **BOOLEAN** |  | [optional] 
 **slack_webhook_url** | **String** |  | [optional] 

data/docs/PDFApi.md

@@ -4,6 +4,7 @@ All URIs are relative to *https://api.docspring.com/api/v1*
 
 Method | HTTP request | Description
 ------------- | ------------- | -------------
+[**add_fields_to_template**](PDFApi.md#add_fields_to_template) | **PUT** /templates/{template_id}/add_fields | Add new fields to a Template
 [**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
@@ -35,6 +36,57 @@ Method | HTTP request | Description
 [**update_template**](PDFApi.md#update_template) | **PUT** /templates/{template_id} | Update a Template
 
 
+# **add_fields_to_template**
+> AddFieldsTemplateResponse add_fields_to_template(template_id, add_fields_data)
+
+Add new fields to 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_000000000000000002' # String | 
+add_fields_data = DocSpring::AddFieldsData.new # AddFieldsData | 
+
+begin
+  #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->add_fields_to_template: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **template_id** | **String**|  | 
+ **add_fields_data** | [**AddFieldsData**](AddFieldsData.md)|  | 
+
+### Return type
+
+[**AddFieldsTemplateResponse**](AddFieldsTemplateResponse.md)
+
+### Authorization
+
+[api_token_basic](../README.md#api_token_basic)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
 # **batch_generate_pdf_v1**
 > Array<CreateSubmissionResponse> batch_generate_pdf_v1(template_id, request_body)
 
@@ -381,7 +433,7 @@ Name | Type | Description  | Notes
 
 
 # **create_html_template**
-> PendingTemplate create_html_template(create_template_data1)
+> PendingTemplate create_html_template(create_html_template_data)
 
 Create a new HTML template
 
@@ -397,11 +449,11 @@ DocSpring.configure do |config|
 end
 
 api_instance = DocSpring::PDFApi.new
-create_template_data1 = DocSpring::CreateTemplateData1.new # CreateTemplateData1 | 
+create_html_template_data = DocSpring::CreateHtmlTemplateData.new # CreateHtmlTemplateData | 
 
 begin
   #Create a new HTML template
-  result = api_instance.create_html_template(create_template_data1)
+  result = api_instance.create_html_template(create_html_template_data)
   p result
 rescue DocSpring::ApiError => e
   puts "Exception when calling PDFApi->create_html_template: #{e}"
@@ -412,7 +464,7 @@ end
 
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
- **create_template_data1** | [**CreateTemplateData1**](CreateTemplateData1.md)|  | 
+ **create_html_template_data** | [**CreateHtmlTemplateData**](CreateHtmlTemplateData.md)|  | 
 
 ### Return type
 
@@ -485,7 +537,7 @@ Name | Type | Description  | Notes
 
 
 # **create_pdf_template_from_upload**
-> PendingTemplate create_pdf_template_from_upload(create_template_data)
+> PendingTemplate create_pdf_template_from_upload(create_template_from_upload_data)
 
 Create a new PDF template from a cached presign upload
 
@@ -501,11 +553,11 @@ DocSpring.configure do |config|
 end
 
 api_instance = DocSpring::PDFApi.new
-create_template_data = DocSpring::CreateTemplateData.new # CreateTemplateData | 
+create_template_from_upload_data = DocSpring::CreateTemplateFromUploadData.new # CreateTemplateFromUploadData | 
 
 begin
   #Create a new PDF template from a cached presign upload
-  result = api_instance.create_pdf_template_from_upload(create_template_data)
+  result = api_instance.create_pdf_template_from_upload(create_template_from_upload_data)
   p result
 rescue DocSpring::ApiError => e
   puts "Exception when calling PDFApi->create_pdf_template_from_upload: #{e}"
@@ -516,7 +568,7 @@ end
 
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
- **create_template_data** | [**CreateTemplateData**](CreateTemplateData.md)|  | 
+ **create_template_from_upload_data** | [**CreateTemplateFromUploadData**](CreateTemplateFromUploadData.md)|  | 
 
 ### Return type
 

data/docs/PendingTemplate.md

@@ -18,6 +18,7 @@ Name | Type | Description | Notes
 **name** | **String** |  | [optional] 
 **template_type** | **String** |  | [optional] 
 **id** | **String** |  | [optional] 
+**locked** | **BOOLEAN** |  | [optional] 
 **redirect_url** | **String** |  | [optional] 
 
 

data/docs/Submission.md

@@ -12,6 +12,7 @@ Name | Type | Description | Notes
 **processed_at** | **String** |  | [optional] 
 **state** | **String** |  | 
 **metadata** | **Object** |  | [optional] 
+**truncated_text** | **Object** |  | [optional] 
 **pdf_hash** | **String** |  | [optional] 
 **download_url** | **String** |  | [optional] 
 **permanent_download_url** | **String** |  | [optional] 

data/docs/Template.md

@@ -20,6 +20,7 @@ Name | Type | Description | Notes
 **template_type** | **String** |  | [optional] 
 **id** | **String** |  | [optional] 
 **page_dimensions** | **Array<Array<Float>>** |  | [optional] 
+**locked** | **BOOLEAN** |  | [optional] 
 **redirect_url** | **String** |  | [optional] 
 **document_url** | **String** |  | [optional] 
 

data/docs/{TemplatestemplateIdTemplate.md → TemplateData.md}

@@ -1,4 +1,4 @@
-# DocSpring::TemplatestemplateIdTemplate
+# DocSpring::TemplateData
 
 ## Properties
 Name | Type | Description | Notes

data/docs/TemplatestemplateIdaddFieldsFields.md

@@ -0,0 +1,92 @@
+# DocSpring::TemplatestemplateIdaddFieldsFields
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**uppercase** | **BOOLEAN** |  | [optional] 
+**background_color_field_name** | **String** |  | [optional] 
+**metadata** | **String** |  | [optional] 
+**barcode_symbology** | **String** |  | [optional] 
+**min_length** | **Float** |  | [optional] 
+**integer** | **BOOLEAN** |  | [optional] 
+**type** | **String** |  | [optional] 
+**required** | **BOOLEAN** |  | [optional] 
+**comb_value_offset** | **Float** |  | [optional] 
+**image_gravity** | **String** |  | [optional] 
+**overflow** | **String** |  | [optional] 
+**qrcode_color** | **String** |  | [optional] 
+**color_field_required** | **BOOLEAN** |  | [optional] 
+**background_color_field_required** | **BOOLEAN** |  | [optional] 
+**id** | **Float** |  | [optional] 
+**image_scale_type** | **String** |  | [optional] 
+**exclusive_minimum** | **BOOLEAN** |  | [optional] 
+**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] 
+**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] 
+**shape_type** | **String** |  | [optional] 
+**display_type** | **String** |  | [optional] 
+**condition** | **String** |  | [optional] 
+**check_color** | **String** |  | [optional] 
+**multiline_lines** | **Float** |  | [optional] 
+**multiline** | **BOOLEAN** |  | [optional] 
+**true_text** | **String** |  | [optional] 
+**name** | **String** |  | [optional] 
+**font_size** | **Float** |  | [optional] 
+**page** | **Float** |  | [optional] 
+**alignment** | **String** |  | [optional] 
+**max_length** | **Float** |  | [optional] 
+**auto_calculate_max_length** | **BOOLEAN** |  | [optional] 
+**color_field_name** | **String** |  | [optional] 
+**qrcode_color_field_name** | **String** |  | [optional] 
+**number_condition_range_min** | **Float** |  | [optional] 
+**hidden** | **BOOLEAN** |  | [optional] 
+**color** | **String** |  | [optional] 
+**check_color_field_required** | **BOOLEAN** |  | [optional] 
+**combined_field_format** | **String** |  | [optional] 
+**description** | **String** |  | [optional] 
+**shape_border_color_field_required** | **BOOLEAN** |  | [optional] 
+**combined_field_names** | **String** |  | [optional] 
+**title** | **String** |  | [optional] 
+**number_condition_range_exclusive_min** | **BOOLEAN** |  | [optional] 
+**combined_field_separator** | **String** |  | [optional] 
+**exclusive_maximum** | **BOOLEAN** |  | [optional] 
+**default** | **String** |  | [optional] 
+**combined_field_type** | **String** |  | [optional] 
+**date_time_format** | **String** |  | [optional] 
+**qrcode_color_field_required** | **BOOLEAN** |  | [optional] 
+**currency** | **BOOLEAN** |  | [optional] 
+**strikethrough** | **BOOLEAN** |  | [optional] 
+**false_text** | **String** |  | [optional] 
+**character_spacing** | **Float** |  | [optional] 
+**number_condition_range_max** | **Float** |  | [optional] 
+**background_color** | **String** |  | [optional] 
+**check_color_field_name** | **String** |  | [optional] 
+**check_character** | **String** |  | [optional] 
+**rotation** | **Float** |  | [optional] 
+**option_list** | **String** |  | [optional] 
+**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] 
+**width** | **Float** |  | [optional] 
+**maximum** | **Float** |  | [optional] 
+**y** | **Float** |  | [optional] 
+**signature_allow_draw** | **BOOLEAN** |  | [optional] 
+**opacity** | **Float** |  | [optional] 
+**number_condition_type** | **String** |  | [optional] 
+**minimum** | **Float** |  | [optional] 
+**signature_allow_type** | **BOOLEAN** |  | [optional] 
+
+

data/docs/UpdateTemplateData.md

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