docspring 1.1.0 → 1.3.2
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/.openapi-generator/VERSION +1 -1
- data/CHANGELOG.md +20 -0
- data/Gemfile.lock +1 -1
- data/LICENSE +1 -1
- data/README.md +22 -15
- data/docs/AddFieldsData.md +8 -0
- data/docs/AddFieldsTemplateResponse.md +10 -0
- data/docs/CombinePdfsData.md +4 -4
- data/docs/CombinedSubmissionData.md +3 -3
- data/docs/CopyTemplateData.md +9 -0
- data/docs/CreateHtmlTemplateData.md +8 -0
- data/docs/CreateSubmissionDataRequestData.md +2 -2
- data/docs/CreateTemplateFromUploadData.md +8 -0
- data/docs/{TemplatesdesccachedUploadTemplate.md → HtmlTemplateData.md} +3 -4
- data/docs/MoveTemplateData.md +1 -1
- data/docs/PDFApi.md +113 -9
- data/docs/PendingTemplate.md +1 -0
- data/docs/Submission.md +4 -0
- data/docs/SubmissionBatchData.md +2 -2
- data/docs/SubmissionData.md +4 -4
- data/docs/SubmissionDataBatchRequest.md +2 -2
- data/docs/SubmissionDataRequest.md +1 -0
- data/docs/Template.md +1 -0
- data/docs/{TemplatestemplateIdTemplate.md → TemplateData.md} +3 -3
- data/docs/TemplatestemplateIdaddFieldsFields.md +92 -0
- data/docs/UpdateSubmissionDataRequestData.md +9 -9
- data/docs/UpdateTemplateData.md +1 -1
- data/docs/UploadTemplateData.md +25 -0
- data/docs/UploadTemplateDataDocument.md +10 -0
- data/docs/{TemplatesdesccachedUploadTemplateDocumentMetadata.md → UploadTemplateDataDocumentMetadata.md} +1 -1
- data/docspring.gemspec +2 -2
- data/lib/docspring.rb +12 -7
- data/lib/docspring/api/pdf_api.rb +137 -19
- data/lib/docspring/api_client.rb +1 -1
- data/lib/docspring/api_error.rb +1 -1
- data/lib/docspring/configuration.rb +1 -1
- data/lib/docspring/models/add_fields_data.rb +190 -0
- data/lib/docspring/models/add_fields_template_response.rb +239 -0
- data/lib/docspring/models/authentication_error.rb +1 -1
- data/lib/docspring/models/authentication_success_response.rb +1 -1
- data/lib/docspring/models/combine_pdfs_data.rb +28 -28
- data/lib/docspring/models/combined_submission.rb +1 -1
- data/lib/docspring/models/combined_submission_action.rb +1 -6
- data/lib/docspring/models/combined_submission_data.rb +23 -23
- data/lib/docspring/models/copy_template_data.rb +197 -0
- data/lib/docspring/models/create_combined_submission_response.rb +1 -1
- data/lib/docspring/models/create_custom_file_data.rb +1 -1
- data/lib/docspring/models/create_custom_file_response.rb +1 -1
- data/lib/docspring/models/create_folder_data.rb +1 -1
- data/lib/docspring/models/{create_template_data.rb → create_html_template_data.rb} +3 -3
- data/lib/docspring/models/create_submission_batch_response.rb +1 -1
- data/lib/docspring/models/create_submission_batch_submissions_response.rb +1 -1
- data/lib/docspring/models/create_submission_data_request_data.rb +20 -20
- data/lib/docspring/models/create_submission_data_request_token_response.rb +1 -1
- data/lib/docspring/models/create_submission_data_request_token_response_token.rb +1 -1
- data/lib/docspring/models/create_submission_response.rb +1 -1
- data/lib/docspring/models/{create_template_data1.rb → create_template_from_upload_data.rb} +3 -3
- data/lib/docspring/models/custom_file.rb +1 -1
- data/lib/docspring/models/error.rb +1 -1
- data/lib/docspring/models/folder.rb +1 -1
- data/lib/docspring/models/folders_folder.rb +1 -1
- data/lib/docspring/models/html_template_data.rb +373 -0
- data/lib/docspring/models/invalid_request.rb +1 -1
- data/lib/docspring/models/move_folder_data.rb +1 -1
- data/lib/docspring/models/move_template_data.rb +6 -1
- data/lib/docspring/models/pending_template.rb +11 -2
- data/lib/docspring/models/rename_folder_data.rb +1 -1
- data/lib/docspring/models/submission.rb +41 -5
- data/lib/docspring/models/submission_action.rb +1 -6
- data/lib/docspring/models/submission_batch.rb +1 -1
- data/lib/docspring/models/submission_batch_data.rb +16 -16
- data/lib/docspring/models/submission_data.rb +34 -34
- data/lib/docspring/models/submission_data_batch_request.rb +20 -20
- data/lib/docspring/models/submission_data_request.rb +14 -15
- data/lib/docspring/models/template.rb +11 -2
- data/lib/docspring/models/{templatestemplate_id_template.rb → template_data.rb} +21 -21
- data/lib/docspring/models/templatestemplate_idadd_fields_fields.rb +1306 -0
- data/lib/docspring/models/update_data_request_response.rb +1 -1
- data/lib/docspring/models/update_submission_data_request_data.rb +79 -79
- data/lib/docspring/models/update_template_data.rb +2 -2
- data/lib/docspring/models/update_template_response.rb +1 -1
- data/lib/docspring/models/{templatesdesccached_upload_template.rb → upload_template_data.rb} +22 -22
- data/lib/docspring/models/{templatesdesccached_upload_template_document.rb → upload_template_data_document.rb} +3 -3
- data/lib/docspring/models/{templatesdesccached_upload_template_document_metadata.rb → upload_template_data_document_metadata.rb} +2 -2
- data/lib/docspring/version.rb +2 -2
- data/spec/api/pdf_api_integration_spec.rb +49 -18
- data/spec/api/pdf_api_spec_original.skipped.rb +36 -8
- data/spec/api_client_spec.rb +1 -1
- data/spec/configuration_spec.rb +1 -1
- data/spec/models/add_fields_data_spec.rb +41 -0
- data/spec/models/add_fields_template_response_spec.rb +57 -0
- data/spec/models/authentication_error_spec.rb +1 -1
- data/spec/models/authentication_success_response_spec.rb +1 -1
- data/spec/models/combine_pdfs_data_spec.rb +5 -5
- data/spec/models/combined_submission_action_spec.rb +1 -1
- data/spec/models/combined_submission_data_spec.rb +5 -5
- data/spec/models/combined_submission_spec.rb +1 -1
- data/spec/models/copy_template_data_spec.rb +47 -0
- data/spec/models/create_combined_submission_response_spec.rb +1 -1
- data/spec/models/create_custom_file_data_spec.rb +1 -1
- data/spec/models/create_custom_file_response_spec.rb +1 -1
- data/spec/models/create_folder_data_spec.rb +1 -1
- data/spec/models/{create_template_data_spec.rb → create_html_template_data_spec.rb} +7 -7
- data/spec/models/create_submission_batch_response_spec.rb +1 -1
- data/spec/models/create_submission_batch_submissions_response_spec.rb +1 -1
- data/spec/models/create_submission_data_request_data_spec.rb +9 -9
- data/spec/models/create_submission_data_request_token_response_spec.rb +1 -1
- data/spec/models/create_submission_data_request_token_response_token_spec.rb +1 -1
- data/spec/models/create_submission_response_spec.rb +1 -1
- data/spec/models/{create_template_data1_spec.rb → create_template_from_upload_data_spec.rb} +7 -7
- data/spec/models/custom_file_spec.rb +1 -1
- data/spec/models/error_spec.rb +1 -1
- data/spec/models/folder_spec.rb +1 -1
- data/spec/models/folders_folder_spec.rb +1 -1
- data/spec/models/html_template_data_spec.rb +145 -0
- data/spec/models/invalid_request_spec.rb +1 -1
- data/spec/models/move_folder_data_spec.rb +1 -1
- data/spec/models/move_template_data_spec.rb +1 -1
- data/spec/models/pending_template_spec.rb +7 -1
- data/spec/models/rename_folder_data_spec.rb +1 -1
- data/spec/models/submission_action_spec.rb +1 -1
- data/spec/models/submission_batch_data_spec.rb +3 -3
- data/spec/models/submission_batch_spec.rb +1 -1
- data/spec/models/submission_data_batch_request_spec.rb +5 -5
- data/spec/models/submission_data_request_spec.rb +7 -1
- data/spec/models/submission_data_spec.rb +7 -7
- data/spec/models/submission_spec.rb +25 -1
- data/spec/models/{templatestemplate_id_template_spec.rb → template_data_spec.rb} +11 -11
- data/spec/models/template_spec.rb +7 -1
- data/spec/models/templatestemplate_idadd_fields_fields_spec.rb +589 -0
- data/spec/models/update_data_request_response_spec.rb +1 -1
- data/spec/models/update_submission_data_request_data_spec.rb +17 -17
- data/spec/models/update_template_data_spec.rb +1 -1
- data/spec/models/update_template_response_spec.rb +1 -1
- data/spec/models/{templatesdesccached_upload_template_document_metadata_spec.rb → upload_template_data_document_metadata_spec.rb} +7 -7
- data/spec/models/{templatesdesccached_upload_template_document_spec.rb → upload_template_data_document_spec.rb} +7 -7
- data/spec/models/{templatesdesccached_upload_template_spec.rb → upload_template_data_spec.rb} +12 -12
- data/spec/spec_helper.rb +1 -1
- metadata +50 -30
- data/docs/CreateTemplateData.md +0 -8
- data/docs/CreateTemplateData1.md +0 -8
- data/docs/TemplatesdesccachedUploadTemplateDocument.md +0 -10
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 939bd91dfbd14e20907927edbd3f165b7f29eafa158dd5c96e591c22ed81ba9c
|
4
|
+
data.tar.gz: bb613af52b81ce0fe162be624431c7e03e9a4ccaacbf2cbb54134cadb9bd1b36
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: f9f9868aca3a924df5ac2196876db4f68b494b9bfe3ebe178697553d04e1803c0bd9d5e4a5ddc68745dc304049ef38bf50bb39cc2452f71caaf3481b8044eebf
|
7
|
+
data.tar.gz: b18c9ab4b8bfd0327e7598070092903455c7971854b1f615c534b58089ebca27d64ba2803e9a4332e11d240c4ba8228fccbfdba08dc6e934c6e299d46627a0d5
|
data/.openapi-generator/VERSION
CHANGED
@@ -1 +1 @@
|
|
1
|
-
3.3.0
|
1
|
+
3.3.0
|
data/CHANGELOG.md
CHANGED
@@ -1,3 +1,23 @@
|
|
1
|
+
### 1.3.2 [November 19, 2020]
|
2
|
+
|
3
|
+
- Added "sort_order" property for Submission Data Requests
|
4
|
+
|
5
|
+
### 1.3.1 [September 27, 2020]
|
6
|
+
|
7
|
+
- Changed gem author to DocSpring
|
8
|
+
|
9
|
+
### 1.3.0 [September 26, 2020]
|
10
|
+
|
11
|
+
- Updated OpenAPI Generator to v3.3.0
|
12
|
+
|
13
|
+
### 1.2.1 [September 24, 2020]
|
14
|
+
|
15
|
+
- 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
|
16
|
+
|
17
|
+
### 1.2.0 [September 21, 2020]
|
18
|
+
|
19
|
+
- Renamed some internal models for template creation API endpoints. (CreateTemplateData / CreateTemplateData1 renamed to CreateHtmlTemplateData and CreateTemplateFromUploadData)
|
20
|
+
|
1
21
|
### 1.1.0 [September 12, 2020]
|
2
22
|
|
3
23
|
- **BREAKING CHANGE**: Renamed createTemplate operation to createPDFTemplate
|
data/Gemfile.lock
CHANGED
data/LICENSE
CHANGED
@@ -1,4 +1,4 @@
|
|
1
|
-
Copyright © 2018
|
1
|
+
Copyright © 2018-2020 DocSpring, Inc.
|
2
2
|
|
3
3
|
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:
|
4
4
|
|
data/README.md
CHANGED
@@ -7,7 +7,7 @@ DocSpring is a service that helps you fill out and sign PDF templates.
|
|
7
7
|
This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
|
8
8
|
|
9
9
|
- API version: v1
|
10
|
-
- Package version: 1.
|
10
|
+
- Package version: 1.3.2
|
11
11
|
- Build package: com.docspring.codegen.DocSpringRubyClientCodegen
|
12
12
|
|
13
13
|
## Installation
|
@@ -23,15 +23,15 @@ gem build docspring.gemspec
|
|
23
23
|
Then either install the gem locally:
|
24
24
|
|
25
25
|
```shell
|
26
|
-
gem install ./docspring-1.
|
26
|
+
gem install ./docspring-1.3.2.gem
|
27
27
|
```
|
28
|
-
(for development, run `gem install --dev ./docspring-1.
|
28
|
+
(for development, run `gem install --dev ./docspring-1.3.2.gem` to install the development dependencies)
|
29
29
|
|
30
30
|
or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
|
31
31
|
|
32
32
|
Finally add this to the Gemfile:
|
33
33
|
|
34
|
-
gem 'docspring', '~> 1.
|
34
|
+
gem 'docspring', '~> 1.3.2'
|
35
35
|
|
36
36
|
### Install from Git
|
37
37
|
|
@@ -62,15 +62,15 @@ DocSpring.configure do |config|
|
|
62
62
|
end
|
63
63
|
|
64
64
|
api_instance = DocSpring::PDFApi.new
|
65
|
-
template_id = '
|
66
|
-
|
65
|
+
template_id = 'tpl_000000000000000002' # String |
|
66
|
+
add_fields_data = DocSpring::AddFieldsData.new # AddFieldsData |
|
67
67
|
|
68
68
|
begin
|
69
|
-
#
|
70
|
-
result = api_instance.
|
69
|
+
#Add new fields to a Template
|
70
|
+
result = api_instance.add_fields_to_template(template_id, add_fields_data)
|
71
71
|
p result
|
72
72
|
rescue DocSpring::ApiError => e
|
73
|
-
puts "Exception when calling PDFApi->
|
73
|
+
puts "Exception when calling PDFApi->add_fields_to_template: #{e}"
|
74
74
|
end
|
75
75
|
|
76
76
|
```
|
@@ -81,10 +81,12 @@ All URIs are relative to *https://api.docspring.com/api/v1*
|
|
81
81
|
|
82
82
|
Class | Method | HTTP request | Description
|
83
83
|
------------ | ------------- | ------------- | -------------
|
84
|
+
*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
|
84
85
|
*DocSpring::PDFApi* | [**batch_generate_pdf_v1**](docs/PDFApi.md#batch_generate_pdf_v1) | **POST** /templates/{template_id}/submissions/batch | Generates multiple PDFs
|
85
86
|
*DocSpring::PDFApi* | [**batch_generate_pdfs**](docs/PDFApi.md#batch_generate_pdfs) | **POST** /submissions/batches | Generates multiple PDFs
|
86
87
|
*DocSpring::PDFApi* | [**combine_pdfs**](docs/PDFApi.md#combine_pdfs) | **POST** /combined_submissions?v=2 | Merge submission PDFs, template PDFs, or custom files
|
87
88
|
*DocSpring::PDFApi* | [**combine_submissions**](docs/PDFApi.md#combine_submissions) | **POST** /combined_submissions | Merge generated PDFs together
|
89
|
+
*DocSpring::PDFApi* | [**copy_template**](docs/PDFApi.md#copy_template) | **POST** /templates/{template_id}/copy | Copy a Template
|
88
90
|
*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
|
89
91
|
*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
|
90
92
|
*DocSpring::PDFApi* | [**create_folder**](docs/PDFApi.md#create_folder) | **POST** /folders/ | Create a folder
|
@@ -114,28 +116,32 @@ Class | Method | HTTP request | Description
|
|
114
116
|
|
115
117
|
## Documentation for Models
|
116
118
|
|
119
|
+
- [DocSpring::AddFieldsData](docs/AddFieldsData.md)
|
120
|
+
- [DocSpring::AddFieldsTemplateResponse](docs/AddFieldsTemplateResponse.md)
|
117
121
|
- [DocSpring::AuthenticationError](docs/AuthenticationError.md)
|
118
122
|
- [DocSpring::AuthenticationSuccessResponse](docs/AuthenticationSuccessResponse.md)
|
119
123
|
- [DocSpring::CombinePdfsData](docs/CombinePdfsData.md)
|
120
124
|
- [DocSpring::CombinedSubmission](docs/CombinedSubmission.md)
|
121
125
|
- [DocSpring::CombinedSubmissionAction](docs/CombinedSubmissionAction.md)
|
122
126
|
- [DocSpring::CombinedSubmissionData](docs/CombinedSubmissionData.md)
|
127
|
+
- [DocSpring::CopyTemplateData](docs/CopyTemplateData.md)
|
123
128
|
- [DocSpring::CreateCombinedSubmissionResponse](docs/CreateCombinedSubmissionResponse.md)
|
124
129
|
- [DocSpring::CreateCustomFileData](docs/CreateCustomFileData.md)
|
125
130
|
- [DocSpring::CreateCustomFileResponse](docs/CreateCustomFileResponse.md)
|
126
131
|
- [DocSpring::CreateFolderData](docs/CreateFolderData.md)
|
132
|
+
- [DocSpring::CreateHtmlTemplateData](docs/CreateHtmlTemplateData.md)
|
127
133
|
- [DocSpring::CreateSubmissionBatchResponse](docs/CreateSubmissionBatchResponse.md)
|
128
134
|
- [DocSpring::CreateSubmissionBatchSubmissionsResponse](docs/CreateSubmissionBatchSubmissionsResponse.md)
|
129
135
|
- [DocSpring::CreateSubmissionDataRequestData](docs/CreateSubmissionDataRequestData.md)
|
130
136
|
- [DocSpring::CreateSubmissionDataRequestTokenResponse](docs/CreateSubmissionDataRequestTokenResponse.md)
|
131
137
|
- [DocSpring::CreateSubmissionDataRequestTokenResponseToken](docs/CreateSubmissionDataRequestTokenResponseToken.md)
|
132
138
|
- [DocSpring::CreateSubmissionResponse](docs/CreateSubmissionResponse.md)
|
133
|
-
- [DocSpring::
|
134
|
-
- [DocSpring::CreateTemplateData1](docs/CreateTemplateData1.md)
|
139
|
+
- [DocSpring::CreateTemplateFromUploadData](docs/CreateTemplateFromUploadData.md)
|
135
140
|
- [DocSpring::CustomFile](docs/CustomFile.md)
|
136
141
|
- [DocSpring::Error](docs/Error.md)
|
137
142
|
- [DocSpring::Folder](docs/Folder.md)
|
138
143
|
- [DocSpring::FoldersFolder](docs/FoldersFolder.md)
|
144
|
+
- [DocSpring::HtmlTemplateData](docs/HtmlTemplateData.md)
|
139
145
|
- [DocSpring::InvalidRequest](docs/InvalidRequest.md)
|
140
146
|
- [DocSpring::MoveFolderData](docs/MoveFolderData.md)
|
141
147
|
- [DocSpring::MoveTemplateData](docs/MoveTemplateData.md)
|
@@ -149,14 +155,15 @@ Class | Method | HTTP request | Description
|
|
149
155
|
- [DocSpring::SubmissionDataBatchRequest](docs/SubmissionDataBatchRequest.md)
|
150
156
|
- [DocSpring::SubmissionDataRequest](docs/SubmissionDataRequest.md)
|
151
157
|
- [DocSpring::Template](docs/Template.md)
|
152
|
-
- [DocSpring::
|
153
|
-
- [DocSpring::
|
154
|
-
- [DocSpring::TemplatesdesccachedUploadTemplateDocumentMetadata](docs/TemplatesdesccachedUploadTemplateDocumentMetadata.md)
|
155
|
-
- [DocSpring::TemplatestemplateIdTemplate](docs/TemplatestemplateIdTemplate.md)
|
158
|
+
- [DocSpring::TemplateData](docs/TemplateData.md)
|
159
|
+
- [DocSpring::TemplatestemplateIdaddFieldsFields](docs/TemplatestemplateIdaddFieldsFields.md)
|
156
160
|
- [DocSpring::UpdateDataRequestResponse](docs/UpdateDataRequestResponse.md)
|
157
161
|
- [DocSpring::UpdateSubmissionDataRequestData](docs/UpdateSubmissionDataRequestData.md)
|
158
162
|
- [DocSpring::UpdateTemplateData](docs/UpdateTemplateData.md)
|
159
163
|
- [DocSpring::UpdateTemplateResponse](docs/UpdateTemplateResponse.md)
|
164
|
+
- [DocSpring::UploadTemplateData](docs/UploadTemplateData.md)
|
165
|
+
- [DocSpring::UploadTemplateDataDocument](docs/UploadTemplateDataDocument.md)
|
166
|
+
- [DocSpring::UploadTemplateDataDocumentMetadata](docs/UploadTemplateDataDocumentMetadata.md)
|
160
167
|
|
161
168
|
|
162
169
|
## Documentation for Authorization
|
@@ -0,0 +1,10 @@
|
|
1
|
+
# DocSpring::AddFieldsTemplateResponse
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**new_field_ids** | **Array<Integer>** | | [optional]
|
7
|
+
**errors** | **Array<String>** | | [optional]
|
8
|
+
**status** | **String** | | [optional]
|
9
|
+
|
10
|
+
|
data/docs/CombinePdfsData.md
CHANGED
@@ -3,10 +3,10 @@
|
|
3
3
|
## Properties
|
4
4
|
Name | Type | Description | Notes
|
5
5
|
------------ | ------------- | ------------- | -------------
|
6
|
-
**test** | **BOOLEAN** | | [optional]
|
7
|
-
**source_pdfs** | **Array<Object>** | |
|
8
|
-
**metadata** | **Object** | | [optional]
|
9
|
-
**expires_in** | **Integer** | | [optional]
|
10
6
|
**delete_custom_files** | **BOOLEAN** | | [optional]
|
7
|
+
**expires_in** | **Integer** | | [optional]
|
8
|
+
**metadata** | **Object** | | [optional]
|
9
|
+
**source_pdfs** | **Array<Object>** | |
|
10
|
+
**test** | **BOOLEAN** | | [optional]
|
11
11
|
|
12
12
|
|
@@ -3,9 +3,9 @@
|
|
3
3
|
## Properties
|
4
4
|
Name | Type | Description | Notes
|
5
5
|
------------ | ------------- | ------------- | -------------
|
6
|
-
**test** | **BOOLEAN** | | [optional]
|
7
|
-
**submission_ids** | **Array<String>** | |
|
8
|
-
**metadata** | **Object** | | [optional]
|
9
6
|
**expires_in** | **Integer** | | [optional]
|
7
|
+
**metadata** | **Object** | | [optional]
|
8
|
+
**submission_ids** | **Array<String>** | |
|
9
|
+
**test** | **BOOLEAN** | | [optional]
|
10
10
|
|
11
11
|
|
@@ -3,8 +3,8 @@
|
|
3
3
|
## Properties
|
4
4
|
Name | Type | Description | Notes
|
5
5
|
------------ | ------------- | ------------- | -------------
|
6
|
-
**metadata** | **Object** | | [optional]
|
7
6
|
**auth_type** | **String** | | [optional]
|
7
|
+
**metadata** | **Object** | | [optional]
|
8
8
|
**auth_second_factor_type** | **String** | | [optional]
|
9
9
|
**auth_phone_number_hash** | **String** | | [optional]
|
10
10
|
**auth_session_started_at** | **String** | | [optional]
|
@@ -13,8 +13,8 @@ Name | Type | Description | Notes
|
|
13
13
|
**auth_username_hash** | **String** | | [optional]
|
14
14
|
**name** | **String** | | [optional]
|
15
15
|
**fields** | **Array<String>** | | [optional]
|
16
|
-
**email** | **String** | | [optional]
|
17
16
|
**auth_provider** | **String** | | [optional]
|
17
|
+
**email** | **String** | | [optional]
|
18
18
|
**order** | **Integer** | | [optional]
|
19
19
|
|
20
20
|
|
@@ -1,4 +1,4 @@
|
|
1
|
-
# DocSpring::
|
1
|
+
# DocSpring::HtmlTemplateData
|
2
2
|
|
3
3
|
## Properties
|
4
4
|
Name | Type | Description | Notes
|
@@ -6,9 +6,8 @@ Name | Type | Description | Notes
|
|
6
6
|
**expiration_interval** | **String** | | [optional]
|
7
7
|
**webhook_url** | **String** | | [optional]
|
8
8
|
**scss** | **String** | | [optional]
|
9
|
-
**expire_after** | **Float** | | [optional]
|
10
9
|
**allow_additional_properties** | **BOOLEAN** | | [optional]
|
11
|
-
**
|
10
|
+
**expire_after** | **Float** | | [optional]
|
12
11
|
**description** | **String** | | [optional]
|
13
12
|
**public_submissions** | **BOOLEAN** | | [optional]
|
14
13
|
**slack_webhook_url** | **String** | | [optional]
|
@@ -17,8 +16,8 @@ Name | Type | Description | Notes
|
|
17
16
|
**editable_submissions** | **BOOLEAN** | | [optional]
|
18
17
|
**expire_submissions** | **BOOLEAN** | | [optional]
|
19
18
|
**name** | **String** | | [optional]
|
20
|
-
**html** | **String** | | [optional]
|
21
19
|
**footer_html** | **String** | | [optional]
|
20
|
+
**html** | **String** | | [optional]
|
22
21
|
**template_type** | **String** | | [optional]
|
23
22
|
**redirect_url** | **String** | | [optional]
|
24
23
|
|
data/docs/MoveTemplateData.md
CHANGED
data/docs/PDFApi.md
CHANGED
@@ -4,10 +4,12 @@ All URIs are relative to *https://api.docspring.com/api/v1*
|
|
4
4
|
|
5
5
|
Method | HTTP request | Description
|
6
6
|
------------- | ------------- | -------------
|
7
|
+
[**add_fields_to_template**](PDFApi.md#add_fields_to_template) | **PUT** /templates/{template_id}/add_fields | Add new fields to a Template
|
7
8
|
[**batch_generate_pdf_v1**](PDFApi.md#batch_generate_pdf_v1) | **POST** /templates/{template_id}/submissions/batch | Generates multiple PDFs
|
8
9
|
[**batch_generate_pdfs**](PDFApi.md#batch_generate_pdfs) | **POST** /submissions/batches | Generates multiple PDFs
|
9
10
|
[**combine_pdfs**](PDFApi.md#combine_pdfs) | **POST** /combined_submissions?v=2 | Merge submission PDFs, template PDFs, or custom files
|
10
11
|
[**combine_submissions**](PDFApi.md#combine_submissions) | **POST** /combined_submissions | Merge generated PDFs together
|
12
|
+
[**copy_template**](PDFApi.md#copy_template) | **POST** /templates/{template_id}/copy | Copy a Template
|
11
13
|
[**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
|
12
14
|
[**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
|
13
15
|
[**create_folder**](PDFApi.md#create_folder) | **POST** /folders/ | Create a folder
|
@@ -35,6 +37,57 @@ Method | HTTP request | Description
|
|
35
37
|
[**update_template**](PDFApi.md#update_template) | **PUT** /templates/{template_id} | Update a Template
|
36
38
|
|
37
39
|
|
40
|
+
# **add_fields_to_template**
|
41
|
+
> AddFieldsTemplateResponse add_fields_to_template(template_id, add_fields_data)
|
42
|
+
|
43
|
+
Add new fields to a Template
|
44
|
+
|
45
|
+
### Example
|
46
|
+
```ruby
|
47
|
+
# load the gem
|
48
|
+
require 'docspring'
|
49
|
+
# setup authorization
|
50
|
+
DocSpring.configure do |config|
|
51
|
+
# Configure HTTP basic authorization: api_token_basic
|
52
|
+
config.username = 'YOUR USERNAME'
|
53
|
+
config.password = 'YOUR PASSWORD'
|
54
|
+
end
|
55
|
+
|
56
|
+
api_instance = DocSpring::PDFApi.new
|
57
|
+
template_id = 'tpl_000000000000000002' # String |
|
58
|
+
add_fields_data = DocSpring::AddFieldsData.new # AddFieldsData |
|
59
|
+
|
60
|
+
begin
|
61
|
+
#Add new fields to a Template
|
62
|
+
result = api_instance.add_fields_to_template(template_id, add_fields_data)
|
63
|
+
p result
|
64
|
+
rescue DocSpring::ApiError => e
|
65
|
+
puts "Exception when calling PDFApi->add_fields_to_template: #{e}"
|
66
|
+
end
|
67
|
+
```
|
68
|
+
|
69
|
+
### Parameters
|
70
|
+
|
71
|
+
Name | Type | Description | Notes
|
72
|
+
------------- | ------------- | ------------- | -------------
|
73
|
+
**template_id** | **String**| |
|
74
|
+
**add_fields_data** | [**AddFieldsData**](AddFieldsData.md)| |
|
75
|
+
|
76
|
+
### Return type
|
77
|
+
|
78
|
+
[**AddFieldsTemplateResponse**](AddFieldsTemplateResponse.md)
|
79
|
+
|
80
|
+
### Authorization
|
81
|
+
|
82
|
+
[api_token_basic](../README.md#api_token_basic)
|
83
|
+
|
84
|
+
### HTTP request headers
|
85
|
+
|
86
|
+
- **Content-Type**: application/json
|
87
|
+
- **Accept**: application/json
|
88
|
+
|
89
|
+
|
90
|
+
|
38
91
|
# **batch_generate_pdf_v1**
|
39
92
|
> Array<CreateSubmissionResponse> batch_generate_pdf_v1(template_id, request_body)
|
40
93
|
|
@@ -233,6 +286,57 @@ Name | Type | Description | Notes
|
|
233
286
|
|
234
287
|
|
235
288
|
|
289
|
+
# **copy_template**
|
290
|
+
> Template copy_template(template_id, copy_template_data)
|
291
|
+
|
292
|
+
Copy a Template
|
293
|
+
|
294
|
+
### Example
|
295
|
+
```ruby
|
296
|
+
# load the gem
|
297
|
+
require 'docspring'
|
298
|
+
# setup authorization
|
299
|
+
DocSpring.configure do |config|
|
300
|
+
# Configure HTTP basic authorization: api_token_basic
|
301
|
+
config.username = 'YOUR USERNAME'
|
302
|
+
config.password = 'YOUR PASSWORD'
|
303
|
+
end
|
304
|
+
|
305
|
+
api_instance = DocSpring::PDFApi.new
|
306
|
+
template_id = 'tpl_000000000000000001' # String |
|
307
|
+
copy_template_data = DocSpring::CopyTemplateData.new # CopyTemplateData |
|
308
|
+
|
309
|
+
begin
|
310
|
+
#Copy a Template
|
311
|
+
result = api_instance.copy_template(template_id, copy_template_data)
|
312
|
+
p result
|
313
|
+
rescue DocSpring::ApiError => e
|
314
|
+
puts "Exception when calling PDFApi->copy_template: #{e}"
|
315
|
+
end
|
316
|
+
```
|
317
|
+
|
318
|
+
### Parameters
|
319
|
+
|
320
|
+
Name | Type | Description | Notes
|
321
|
+
------------- | ------------- | ------------- | -------------
|
322
|
+
**template_id** | **String**| |
|
323
|
+
**copy_template_data** | [**CopyTemplateData**](CopyTemplateData.md)| |
|
324
|
+
|
325
|
+
### Return type
|
326
|
+
|
327
|
+
[**Template**](Template.md)
|
328
|
+
|
329
|
+
### Authorization
|
330
|
+
|
331
|
+
[api_token_basic](../README.md#api_token_basic)
|
332
|
+
|
333
|
+
### HTTP request headers
|
334
|
+
|
335
|
+
- **Content-Type**: application/json
|
336
|
+
- **Accept**: application/json
|
337
|
+
|
338
|
+
|
339
|
+
|
236
340
|
# **create_custom_file_from_upload**
|
237
341
|
> CreateCustomFileResponse create_custom_file_from_upload(create_custom_file_data)
|
238
342
|
|
@@ -381,7 +485,7 @@ Name | Type | Description | Notes
|
|
381
485
|
|
382
486
|
|
383
487
|
# **create_html_template**
|
384
|
-
> PendingTemplate create_html_template(
|
488
|
+
> PendingTemplate create_html_template(create_html_template_data)
|
385
489
|
|
386
490
|
Create a new HTML template
|
387
491
|
|
@@ -397,11 +501,11 @@ DocSpring.configure do |config|
|
|
397
501
|
end
|
398
502
|
|
399
503
|
api_instance = DocSpring::PDFApi.new
|
400
|
-
|
504
|
+
create_html_template_data = DocSpring::CreateHtmlTemplateData.new # CreateHtmlTemplateData |
|
401
505
|
|
402
506
|
begin
|
403
507
|
#Create a new HTML template
|
404
|
-
result = api_instance.create_html_template(
|
508
|
+
result = api_instance.create_html_template(create_html_template_data)
|
405
509
|
p result
|
406
510
|
rescue DocSpring::ApiError => e
|
407
511
|
puts "Exception when calling PDFApi->create_html_template: #{e}"
|
@@ -412,7 +516,7 @@ end
|
|
412
516
|
|
413
517
|
Name | Type | Description | Notes
|
414
518
|
------------- | ------------- | ------------- | -------------
|
415
|
-
**
|
519
|
+
**create_html_template_data** | [**CreateHtmlTemplateData**](CreateHtmlTemplateData.md)| |
|
416
520
|
|
417
521
|
### Return type
|
418
522
|
|
@@ -485,7 +589,7 @@ Name | Type | Description | Notes
|
|
485
589
|
|
486
590
|
|
487
591
|
# **create_pdf_template_from_upload**
|
488
|
-
> PendingTemplate create_pdf_template_from_upload(
|
592
|
+
> PendingTemplate create_pdf_template_from_upload(create_template_from_upload_data)
|
489
593
|
|
490
594
|
Create a new PDF template from a cached presign upload
|
491
595
|
|
@@ -501,11 +605,11 @@ DocSpring.configure do |config|
|
|
501
605
|
end
|
502
606
|
|
503
607
|
api_instance = DocSpring::PDFApi.new
|
504
|
-
|
608
|
+
create_template_from_upload_data = DocSpring::CreateTemplateFromUploadData.new # CreateTemplateFromUploadData |
|
505
609
|
|
506
610
|
begin
|
507
611
|
#Create a new PDF template from a cached presign upload
|
508
|
-
result = api_instance.create_pdf_template_from_upload(
|
612
|
+
result = api_instance.create_pdf_template_from_upload(create_template_from_upload_data)
|
509
613
|
p result
|
510
614
|
rescue DocSpring::ApiError => e
|
511
615
|
puts "Exception when calling PDFApi->create_pdf_template_from_upload: #{e}"
|
@@ -516,7 +620,7 @@ end
|
|
516
620
|
|
517
621
|
Name | Type | Description | Notes
|
518
622
|
------------- | ------------- | ------------- | -------------
|
519
|
-
**
|
623
|
+
**create_template_from_upload_data** | [**CreateTemplateFromUploadData**](CreateTemplateFromUploadData.md)| |
|
520
624
|
|
521
625
|
### Return type
|
522
626
|
|
@@ -893,7 +997,7 @@ end
|
|
893
997
|
api_instance = DocSpring::PDFApi.new
|
894
998
|
submission_id = 'sub_000000000000000001' # String |
|
895
999
|
opts = {
|
896
|
-
include_data:
|
1000
|
+
include_data: true # BOOLEAN |
|
897
1001
|
}
|
898
1002
|
|
899
1003
|
begin
|