Skip to content

Commit 3d0394f

Browse files
ndbroadbentndbroadbent
committed
Updated on 2020-09-21 19:13:06. Version: 1.2.0
1 parent 84f44f0 commit 3d0394f

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

53 files changed

+3445
-154
lines changed

‎CHANGELOG.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,7 @@
1+
### 1.2.0 [September 21, 2020]
2+
3+
- Renamed some internal models for template creation API endpoints. (CreateTemplateData / CreateTemplateData1 renamed to CreateHtmlTemplateData and CreateTemplateFromUploadData)
4+
15
### 1.1.0 [September 12, 2020]
26

37
- **BREAKING CHANGE**: Renamed createTemplate operation to createPDFTemplate

‎Gemfile.lock

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
PATH
22
remote: .
33
specs:
4-
docspring (1.1.0)
4+
docspring (1.2.0)
55
ffi (~> 1.0, >= 1.9.24)
66
json (>= 1.8)
77
typhoeus (~> 1.0, >= 1.0.1)

‎README.md

Lines changed: 20 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ DocSpring is a service that helps you fill out and sign PDF templates.
77
This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
88

99
- API version: v1
10-
- Package version: 1.1.0
10+
- Package version: 1.2.0
1111
- Build package: com.docspring.codegen.DocSpringRubyClientCodegen
1212

1313
## Installation
@@ -23,15 +23,15 @@ gem build docspring.gemspec
2323
Then either install the gem locally:
2424

2525
```shell
26-
gem install ./docspring-1.1.0.gem
26+
gem install ./docspring-1.2.0.gem
2727
```
28-
(for development, run `gem install --dev ./docspring-1.1.0.gem` to install the development dependencies)
28+
(for development, run `gem install --dev ./docspring-1.2.0.gem` to install the development dependencies)
2929

3030
or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
3131

3232
Finally add this to the Gemfile:
3333

34-
gem 'docspring', '~> 1.1.0'
34+
gem 'docspring', '~> 1.2.0'
3535

3636
### Install from Git
3737

@@ -62,15 +62,15 @@ DocSpring.configure do |config|
6262
end
6363

6464
api_instance = DocSpring::PDFApi.new
65-
template_id = 'tpl_000000000000000001' # String |
66-
request_body = nil # Array<Object> |
65+
template_id = 'tpl_000000000000000002' # String |
66+
add_fields_data = DocSpring::AddFieldsData.new # AddFieldsData |
6767

6868
begin
69-
#Generates multiple PDFs
70-
result = api_instance.batch_generate_pdf_v1(template_id, request_body)
69+
#Add new fields to a Template
70+
result = api_instance.add_fields_to_template(template_id, add_fields_data)
7171
p result
7272
rescue DocSpring::ApiError => e
73-
puts "Exception when calling PDFApi->batch_generate_pdf_v1: #{e}"
73+
puts "Exception when calling PDFApi->add_fields_to_template: #{e}"
7474
end
7575

7676
```
@@ -81,6 +81,7 @@ All URIs are relative to *https://api.docspring.com/api/v1*
8181

8282
Class | Method | HTTP request | Description
8383
------------ | ------------- | ------------- | -------------
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
8485
*DocSpring::PDFApi* | [**batch_generate_pdf_v1**](docs/PDFApi.md#batch_generate_pdf_v1) | **POST** /templates/{template_id}/submissions/batch | Generates multiple PDFs
8586
*DocSpring::PDFApi* | [**batch_generate_pdfs**](docs/PDFApi.md#batch_generate_pdfs) | **POST** /submissions/batches | Generates multiple PDFs
8687
*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
114115

115116
## Documentation for Models
116117

118+
- [DocSpring::AddFieldsData](docs/AddFieldsData.md)
119+
- [DocSpring::AddFieldsTemplateResponse](docs/AddFieldsTemplateResponse.md)
117120
- [DocSpring::AuthenticationError](docs/AuthenticationError.md)
118121
- [DocSpring::AuthenticationSuccessResponse](docs/AuthenticationSuccessResponse.md)
119122
- [DocSpring::CombinePdfsData](docs/CombinePdfsData.md)
@@ -124,18 +127,19 @@ Class | Method | HTTP request | Description
124127
- [DocSpring::CreateCustomFileData](docs/CreateCustomFileData.md)
125128
- [DocSpring::CreateCustomFileResponse](docs/CreateCustomFileResponse.md)
126129
- [DocSpring::CreateFolderData](docs/CreateFolderData.md)
130+
- [DocSpring::CreateHtmlTemplateData](docs/CreateHtmlTemplateData.md)
127131
- [DocSpring::CreateSubmissionBatchResponse](docs/CreateSubmissionBatchResponse.md)
128132
- [DocSpring::CreateSubmissionBatchSubmissionsResponse](docs/CreateSubmissionBatchSubmissionsResponse.md)
129133
- [DocSpring::CreateSubmissionDataRequestData](docs/CreateSubmissionDataRequestData.md)
130134
- [DocSpring::CreateSubmissionDataRequestTokenResponse](docs/CreateSubmissionDataRequestTokenResponse.md)
131135
- [DocSpring::CreateSubmissionDataRequestTokenResponseToken](docs/CreateSubmissionDataRequestTokenResponseToken.md)
132136
- [DocSpring::CreateSubmissionResponse](docs/CreateSubmissionResponse.md)
133-
- [DocSpring::CreateTemplateData](docs/CreateTemplateData.md)
134-
- [DocSpring::CreateTemplateData1](docs/CreateTemplateData1.md)
137+
- [DocSpring::CreateTemplateFromUploadData](docs/CreateTemplateFromUploadData.md)
135138
- [DocSpring::CustomFile](docs/CustomFile.md)
136139
- [DocSpring::Error](docs/Error.md)
137140
- [DocSpring::Folder](docs/Folder.md)
138141
- [DocSpring::FoldersFolder](docs/FoldersFolder.md)
142+
- [DocSpring::HtmlTemplateData](docs/HtmlTemplateData.md)
139143
- [DocSpring::InvalidRequest](docs/InvalidRequest.md)
140144
- [DocSpring::MoveFolderData](docs/MoveFolderData.md)
141145
- [DocSpring::MoveTemplateData](docs/MoveTemplateData.md)
@@ -149,14 +153,15 @@ Class | Method | HTTP request | Description
149153
- [DocSpring::SubmissionDataBatchRequest](docs/SubmissionDataBatchRequest.md)
150154
- [DocSpring::SubmissionDataRequest](docs/SubmissionDataRequest.md)
151155
- [DocSpring::Template](docs/Template.md)
152-
- [DocSpring::TemplatesdesccachedUploadTemplate](docs/TemplatesdesccachedUploadTemplate.md)
153-
- [DocSpring::TemplatesdesccachedUploadTemplateDocument](docs/TemplatesdesccachedUploadTemplateDocument.md)
154-
- [DocSpring::TemplatesdesccachedUploadTemplateDocumentMetadata](docs/TemplatesdesccachedUploadTemplateDocumentMetadata.md)
155-
- [DocSpring::TemplatestemplateIdTemplate](docs/TemplatestemplateIdTemplate.md)
156+
- [DocSpring::TemplateData](docs/TemplateData.md)
157+
- [DocSpring::TemplatestemplateIdaddFieldsFields](docs/TemplatestemplateIdaddFieldsFields.md)
156158
- [DocSpring::UpdateDataRequestResponse](docs/UpdateDataRequestResponse.md)
157159
- [DocSpring::UpdateSubmissionDataRequestData](docs/UpdateSubmissionDataRequestData.md)
158160
- [DocSpring::UpdateTemplateData](docs/UpdateTemplateData.md)
159161
- [DocSpring::UpdateTemplateResponse](docs/UpdateTemplateResponse.md)
162+
- [DocSpring::UploadTemplateData](docs/UploadTemplateData.md)
163+
- [DocSpring::UploadTemplateDataDocument](docs/UploadTemplateDataDocument.md)
164+
- [DocSpring::UploadTemplateDataDocumentMetadata](docs/UploadTemplateDataDocumentMetadata.md)
160165

161166

162167
## Documentation for Authorization

‎docs/AddFieldsData.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
# DocSpring::AddFieldsData
2+
3+
## Properties
4+
Name | Type | Description | Notes
5+
------------ | ------------- | ------------- | -------------
6+
**fields** | [**Array&lt;TemplatestemplateIdaddFieldsFields&gt;**](TemplatestemplateIdaddFieldsFields.md) | |
7+
8+

‎docs/AddFieldsTemplateResponse.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
# DocSpring::AddFieldsTemplateResponse
2+
3+
## Properties
4+
Name | Type | Description | Notes
5+
------------ | ------------- | ------------- | -------------
6+
**new_field_ids** | **Array&lt;Integer&gt;** | | [optional]
7+
**errors** | **Array&lt;String&gt;** | | [optional]
8+
**status** | **String** | | [optional]
9+
10+

‎docs/CreateHtmlTemplateData.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
# DocSpring::CreateHtmlTemplateData
2+
3+
## Properties
4+
Name | Type | Description | Notes
5+
------------ | ------------- | ------------- | -------------
6+
**template** | [**HtmlTemplateData**](HtmlTemplateData.md) | |
7+
8+

‎docs/CreateTemplateData.md

Lines changed: 0 additions & 8 deletions
This file was deleted.

‎docs/CreateTemplateData1.md

Lines changed: 0 additions & 8 deletions
This file was deleted.

‎docs/CreateTemplateFromUploadData.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
# DocSpring::CreateTemplateFromUploadData
2+
3+
## Properties
4+
Name | Type | Description | Notes
5+
------------ | ------------- | ------------- | -------------
6+
**template** | [**UploadTemplateData**](UploadTemplateData.md) | |
7+
8+

‎docs/TemplatesdesccachedUploadTemplate.md renamed to ‎docs/HtmlTemplateData.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# DocSpring::TemplatesdesccachedUploadTemplate
1+
# DocSpring::HtmlTemplateData
22

33
## Properties
44
Name | Type | Description | Notes
@@ -8,7 +8,6 @@ Name | Type | Description | Notes
88
**scss** | **String** | | [optional]
99
**expire_after** | **Float** | | [optional]
1010
**allow_additional_properties** | **BOOLEAN** | | [optional]
11-
**document** | [**TemplatesdesccachedUploadTemplateDocument**](TemplatesdesccachedUploadTemplateDocument.md) | | [optional]
1211
**description** | **String** | | [optional]
1312
**public_submissions** | **BOOLEAN** | | [optional]
1413
**slack_webhook_url** | **String** | | [optional]

‎docs/PDFApi.md

Lines changed: 60 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,7 @@ All URIs are relative to *https://api.docspring.com/api/v1*
44

55
Method | HTTP request | Description
66
------------- | ------------- | -------------
7+
[**add_fields_to_template**](PDFApi.md#add_fields_to_template) | **PUT** /templates/{template_id}/add_fields | Add new fields to a Template
78
[**batch_generate_pdf_v1**](PDFApi.md#batch_generate_pdf_v1) | **POST** /templates/{template_id}/submissions/batch | Generates multiple PDFs
89
[**batch_generate_pdfs**](PDFApi.md#batch_generate_pdfs) | **POST** /submissions/batches | Generates multiple PDFs
910
[**combine_pdfs**](PDFApi.md#combine_pdfs) | **POST** /combined_submissions?v&#x3D;2 | Merge submission PDFs, template PDFs, or custom files
@@ -35,6 +36,57 @@ Method | HTTP request | Description
3536
[**update_template**](PDFApi.md#update_template) | **PUT** /templates/{template_id} | Update a Template
3637

3738

39+
# **add_fields_to_template**
40+
> AddFieldsTemplateResponse add_fields_to_template(template_id, add_fields_data)
41+
42+
Add new fields to a Template
43+
44+
### Example
45+
```ruby
46+
# load the gem
47+
require 'docspring'
48+
# setup authorization
49+
DocSpring.configure do |config|
50+
# Configure HTTP basic authorization: api_token_basic
51+
config.username = 'YOUR USERNAME'
52+
config.password = 'YOUR PASSWORD'
53+
end
54+
55+
api_instance = DocSpring::PDFApi.new
56+
template_id = 'tpl_000000000000000002' # String |
57+
add_fields_data = DocSpring::AddFieldsData.new # AddFieldsData |
58+
59+
begin
60+
#Add new fields to a Template
61+
result = api_instance.add_fields_to_template(template_id, add_fields_data)
62+
p result
63+
rescue DocSpring::ApiError => e
64+
puts "Exception when calling PDFApi->add_fields_to_template: #{e}"
65+
end
66+
```
67+
68+
### Parameters
69+
70+
Name | Type | Description | Notes
71+
------------- | ------------- | ------------- | -------------
72+
**template_id** | **String**| |
73+
**add_fields_data** | [**AddFieldsData**](AddFieldsData.md)| |
74+
75+
### Return type
76+
77+
[**AddFieldsTemplateResponse**](AddFieldsTemplateResponse.md)
78+
79+
### Authorization
80+
81+
[api_token_basic](../README.md#api_token_basic)
82+
83+
### HTTP request headers
84+
85+
- **Content-Type**: application/json
86+
- **Accept**: application/json
87+
88+
89+
3890
# **batch_generate_pdf_v1**
3991
> Array&lt;CreateSubmissionResponse&gt; batch_generate_pdf_v1(template_id, request_body)
4092
@@ -381,7 +433,7 @@ Name | Type | Description | Notes
381433

382434

383435
# **create_html_template**
384-
> PendingTemplate create_html_template(create_template_data1)
436+
> PendingTemplate create_html_template(create_html_template_data)
385437
386438
Create a new HTML template
387439

@@ -397,11 +449,11 @@ DocSpring.configure do |config|
397449
end
398450

399451
api_instance = DocSpring::PDFApi.new
400-
create_template_data1 = DocSpring::CreateTemplateData1.new # CreateTemplateData1 |
452+
create_html_template_data = DocSpring::CreateHtmlTemplateData.new # CreateHtmlTemplateData |
401453

402454
begin
403455
#Create a new HTML template
404-
result = api_instance.create_html_template(create_template_data1)
456+
result = api_instance.create_html_template(create_html_template_data)
405457
p result
406458
rescue DocSpring::ApiError => e
407459
puts "Exception when calling PDFApi->create_html_template: #{e}"
@@ -412,7 +464,7 @@ end
412464

413465
Name | Type | Description | Notes
414466
------------- | ------------- | ------------- | -------------
415-
**create_template_data1** | [**CreateTemplateData1**](CreateTemplateData1.md)| |
467+
**create_html_template_data** | [**CreateHtmlTemplateData**](CreateHtmlTemplateData.md)| |
416468

417469
### Return type
418470

@@ -485,7 +537,7 @@ Name | Type | Description | Notes
485537

486538

487539
# **create_pdf_template_from_upload**
488-
> PendingTemplate create_pdf_template_from_upload(create_template_data)
540+
> PendingTemplate create_pdf_template_from_upload(create_template_from_upload_data)
489541
490542
Create a new PDF template from a cached presign upload
491543

@@ -501,11 +553,11 @@ DocSpring.configure do |config|
501553
end
502554

503555
api_instance = DocSpring::PDFApi.new
504-
create_template_data = DocSpring::CreateTemplateData.new # CreateTemplateData |
556+
create_template_from_upload_data = DocSpring::CreateTemplateFromUploadData.new # CreateTemplateFromUploadData |
505557

506558
begin
507559
#Create a new PDF template from a cached presign upload
508-
result = api_instance.create_pdf_template_from_upload(create_template_data)
560+
result = api_instance.create_pdf_template_from_upload(create_template_from_upload_data)
509561
p result
510562
rescue DocSpring::ApiError => e
511563
puts "Exception when calling PDFApi->create_pdf_template_from_upload: #{e}"
@@ -516,7 +568,7 @@ end
516568

517569
Name | Type | Description | Notes
518570
------------- | ------------- | ------------- | -------------
519-
**create_template_data** | [**CreateTemplateData**](CreateTemplateData.md)| |
571+
**create_template_from_upload_data** | [**CreateTemplateFromUploadData**](CreateTemplateFromUploadData.md)| |
520572

521573
### Return type
522574

‎docs/PendingTemplate.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,7 @@ Name | Type | Description | Notes
1818
**name** | **String** | | [optional]
1919
**template_type** | **String** | | [optional]
2020
**id** | **String** | | [optional]
21+
**locked** | **BOOLEAN** | | [optional]
2122
**redirect_url** | **String** | | [optional]
2223

2324

‎docs/Submission.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,7 @@ Name | Type | Description | Notes
1212
**processed_at** | **String** | | [optional]
1313
**state** | **String** | |
1414
**metadata** | **Object** | | [optional]
15+
**truncated_text** | **Object** | | [optional]
1516
**pdf_hash** | **String** | | [optional]
1617
**download_url** | **String** | | [optional]
1718
**permanent_download_url** | **String** | | [optional]

‎docs/Template.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,7 @@ Name | Type | Description | Notes
2020
**template_type** | **String** | | [optional]
2121
**id** | **String** | | [optional]
2222
**page_dimensions** | **Array&lt;Array&lt;Float&gt;&gt;** | | [optional]
23+
**locked** | **BOOLEAN** | | [optional]
2324
**redirect_url** | **String** | | [optional]
2425
**document_url** | **String** | | [optional]
2526

‎docs/TemplatestemplateIdTemplate.md renamed to ‎docs/TemplateData.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# DocSpring::TemplatestemplateIdTemplate
1+
# DocSpring::TemplateData
22

33
## Properties
44
Name | Type | Description | Notes

‎docs/TemplatesdesccachedUploadTemplateDocument.md

Lines changed: 0 additions & 10 deletions
This file was deleted.

0 commit comments

Comments
 (0)