Skip to content

Commit 14f04c0

Browse files
ndbroadbentndbroadbent
committed
Updated on 2020-09-21 19:09:14. Version: 1.2.0
1 parent 6014d9c commit 14f04c0

49 files changed

Lines changed: 6766 additions & 151 deletions

Some content is hidden

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

‎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

‎README.md‎

Lines changed: 16 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ DocSpring is a service that helps you fill out and sign PDF templates.
44
This PHP package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
55

66
- API version: v1
7-
- Package version: 1.1.0
7+
- Package version: 1.2.0
88
- Build package: com.docspring.codegen.DocSpringPhpClientCodegen
99

1010
## Requirements
@@ -68,14 +68,14 @@ $apiInstance = new DocSpring\Api\PDFApi(
6868
new GuzzleHttp\Client(),
6969
$config
7070
);
71-
$template_id = tpl_000000000000000001; // string |
72-
$request_body = array(new \DocSpring\Model\array()); // object[] |
71+
$template_id = tpl_000000000000000002; // string |
72+
$add_fields_data = new \DocSpring\Model\AddFieldsData(); // \DocSpring\Model\AddFieldsData |
7373

7474
try {
75-
$result = $apiInstance->batchGeneratePdfV1($template_id, $request_body);
75+
$result = $apiInstance->addFieldsToTemplate($template_id, $add_fields_data);
7676
print_r($result);
7777
} catch (Exception $e) {
78-
echo 'Exception when calling PDFApi->batchGeneratePdfV1: ', $e->getMessage(), PHP_EOL;
78+
echo 'Exception when calling PDFApi->addFieldsToTemplate: ', $e->getMessage(), PHP_EOL;
7979
}
8080

8181
?>
@@ -87,6 +87,7 @@ All URIs are relative to *https://api.docspring.com/api/v1*
8787

8888
Class | Method | HTTP request | Description
8989
------------ | ------------- | ------------- | -------------
90+
*PDFApi* | [**addFieldsToTemplate**](docs/Api/PDFApi.md#addfieldstotemplate) | **PUT** /templates/{template_id}/add_fields | Add new fields to a Template
9091
*PDFApi* | [**batchGeneratePdfV1**](docs/Api/PDFApi.md#batchgeneratepdfv1) | **POST** /templates/{template_id}/submissions/batch | Generates multiple PDFs
9192
*PDFApi* | [**batchGeneratePdfs**](docs/Api/PDFApi.md#batchgeneratepdfs) | **POST** /submissions/batches | Generates multiple PDFs
9293
*PDFApi* | [**combinePdfs**](docs/Api/PDFApi.md#combinepdfs) | **POST** /combined_submissions?v=2 | Merge submission PDFs, template PDFs, or custom files
@@ -120,6 +121,8 @@ Class | Method | HTTP request | Description
120121

121122
## Documentation For Models
122123

124+
- [AddFieldsData](docs/Model/AddFieldsData.md)
125+
- [AddFieldsTemplateResponse](docs/Model/AddFieldsTemplateResponse.md)
123126
- [AuthenticationError](docs/Model/AuthenticationError.md)
124127
- [AuthenticationSuccessResponse](docs/Model/AuthenticationSuccessResponse.md)
125128
- [CombinePdfsData](docs/Model/CombinePdfsData.md)
@@ -130,18 +133,19 @@ Class | Method | HTTP request | Description
130133
- [CreateCustomFileData](docs/Model/CreateCustomFileData.md)
131134
- [CreateCustomFileResponse](docs/Model/CreateCustomFileResponse.md)
132135
- [CreateFolderData](docs/Model/CreateFolderData.md)
136+
- [CreateHtmlTemplateData](docs/Model/CreateHtmlTemplateData.md)
133137
- [CreateSubmissionBatchResponse](docs/Model/CreateSubmissionBatchResponse.md)
134138
- [CreateSubmissionBatchSubmissionsResponse](docs/Model/CreateSubmissionBatchSubmissionsResponse.md)
135139
- [CreateSubmissionDataRequestData](docs/Model/CreateSubmissionDataRequestData.md)
136140
- [CreateSubmissionDataRequestTokenResponse](docs/Model/CreateSubmissionDataRequestTokenResponse.md)
137141
- [CreateSubmissionDataRequestTokenResponseToken](docs/Model/CreateSubmissionDataRequestTokenResponseToken.md)
138142
- [CreateSubmissionResponse](docs/Model/CreateSubmissionResponse.md)
139-
- [CreateTemplateData](docs/Model/CreateTemplateData.md)
140-
- [CreateTemplateData1](docs/Model/CreateTemplateData1.md)
143+
- [CreateTemplateFromUploadData](docs/Model/CreateTemplateFromUploadData.md)
141144
- [CustomFile](docs/Model/CustomFile.md)
142145
- [Error](docs/Model/Error.md)
143146
- [Folder](docs/Model/Folder.md)
144147
- [FoldersFolder](docs/Model/FoldersFolder.md)
148+
- [HtmlTemplateData](docs/Model/HtmlTemplateData.md)
145149
- [InvalidRequest](docs/Model/InvalidRequest.md)
146150
- [MoveFolderData](docs/Model/MoveFolderData.md)
147151
- [MoveTemplateData](docs/Model/MoveTemplateData.md)
@@ -155,14 +159,15 @@ Class | Method | HTTP request | Description
155159
- [SubmissionDataBatchRequest](docs/Model/SubmissionDataBatchRequest.md)
156160
- [SubmissionDataRequest](docs/Model/SubmissionDataRequest.md)
157161
- [Template](docs/Model/Template.md)
158-
- [TemplatesdesccachedUploadTemplate](docs/Model/TemplatesdesccachedUploadTemplate.md)
159-
- [TemplatesdesccachedUploadTemplateDocument](docs/Model/TemplatesdesccachedUploadTemplateDocument.md)
160-
- [TemplatesdesccachedUploadTemplateDocumentMetadata](docs/Model/TemplatesdesccachedUploadTemplateDocumentMetadata.md)
161-
- [TemplatestemplateIdTemplate](docs/Model/TemplatestemplateIdTemplate.md)
162+
- [TemplateData](docs/Model/TemplateData.md)
163+
- [TemplatestemplateIdaddFieldsFields](docs/Model/TemplatestemplateIdaddFieldsFields.md)
162164
- [UpdateDataRequestResponse](docs/Model/UpdateDataRequestResponse.md)
163165
- [UpdateSubmissionDataRequestData](docs/Model/UpdateSubmissionDataRequestData.md)
164166
- [UpdateTemplateData](docs/Model/UpdateTemplateData.md)
165167
- [UpdateTemplateResponse](docs/Model/UpdateTemplateResponse.md)
168+
- [UploadTemplateData](docs/Model/UploadTemplateData.md)
169+
- [UploadTemplateDataDocument](docs/Model/UploadTemplateDataDocument.md)
170+
- [UploadTemplateDataDocumentMetadata](docs/Model/UploadTemplateDataDocumentMetadata.md)
166171

167172

168173
## Documentation For Authorization

‎composer.json‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "docspring/docspring",
3-
"version": "1.1.0",
3+
"version": "1.2.0",
44
"description": "",
55
"keywords": [
66
"openapitools",

‎docs/Api/PDFApi.md‎

Lines changed: 65 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+
[**addFieldsToTemplate**](PDFApi.md#addFieldsToTemplate) | **PUT** /templates/{template_id}/add_fields | Add new fields to a Template
78
[**batchGeneratePdfV1**](PDFApi.md#batchGeneratePdfV1) | **POST** /templates/{template_id}/submissions/batch | Generates multiple PDFs
89
[**batchGeneratePdfs**](PDFApi.md#batchGeneratePdfs) | **POST** /submissions/batches | Generates multiple PDFs
910
[**combinePdfs**](PDFApi.md#combinePdfs) | **POST** /combined_submissions?v=2 | Merge submission PDFs, template PDFs, or custom files
@@ -35,6 +36,62 @@ Method | HTTP request | Description
3536
[**updateTemplate**](PDFApi.md#updateTemplate) | **PUT** /templates/{template_id} | Update a Template
3637

3738

39+
# **addFieldsToTemplate**
40+
> \DocSpring\Model\AddFieldsTemplateResponse addFieldsToTemplate($template_id, $add_fields_data)
41+
42+
Add new fields to a Template
43+
44+
### Example
45+
```php
46+
<?php
47+
require_once(__DIR__ . '/vendor/autoload.php');
48+
49+
// Configure HTTP basic authorization: api_token_basic
50+
$config = DocSpring\Configuration::getDefaultConfiguration()
51+
->setUsername('YOUR_USERNAME')
52+
->setPassword('YOUR_PASSWORD');
53+
54+
55+
$apiInstance = new DocSpring\Api\PDFApi(
56+
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
57+
// This is optional, `GuzzleHttp\Client` will be used as default.
58+
new GuzzleHttp\Client(),
59+
$config
60+
);
61+
$template_id = tpl_000000000000000002; // string |
62+
$add_fields_data = new \DocSpring\Model\AddFieldsData(); // \DocSpring\Model\AddFieldsData |
63+
64+
try {
65+
$result = $apiInstance->addFieldsToTemplate($template_id, $add_fields_data);
66+
print_r($result);
67+
} catch (Exception $e) {
68+
echo 'Exception when calling PDFApi->addFieldsToTemplate: ', $e->getMessage(), PHP_EOL;
69+
}
70+
?>
71+
```
72+
73+
### Parameters
74+
75+
Name | Type | Description | Notes
76+
------------- | ------------- | ------------- | -------------
77+
**template_id** | **string**| |
78+
**add_fields_data** | [**\DocSpring\Model\AddFieldsData**](../Model/AddFieldsData.md)| |
79+
80+
### Return type
81+
82+
[**\DocSpring\Model\AddFieldsTemplateResponse**](../Model/AddFieldsTemplateResponse.md)
83+
84+
### Authorization
85+
86+
[api_token_basic](../../README.md#api_token_basic)
87+
88+
### HTTP request headers
89+
90+
- **Content-Type**: application/json
91+
- **Accept**: application/json
92+
93+
[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md)
94+
3895
# **batchGeneratePdfV1**
3996
> \DocSpring\Model\CreateSubmissionResponse[] batchGeneratePdfV1($template_id, $request_body)
4097
@@ -416,7 +473,7 @@ Name | Type | Description | Notes
416473
[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md)
417474

418475
# **createHTMLTemplate**
419-
> \DocSpring\Model\PendingTemplate createHTMLTemplate($create_template_data1)
476+
> \DocSpring\Model\PendingTemplate createHTMLTemplate($create_html_template_data)
420477
421478
Create a new HTML template
422479

@@ -437,10 +494,10 @@ $apiInstance = new DocSpring\Api\PDFApi(
437494
new GuzzleHttp\Client(),
438495
$config
439496
);
440-
$create_template_data1 = new \DocSpring\Model\CreateTemplateData1(); // \DocSpring\Model\CreateTemplateData1 |
497+
$create_html_template_data = new \DocSpring\Model\CreateHtmlTemplateData(); // \DocSpring\Model\CreateHtmlTemplateData |
441498

442499
try {
443-
$result = $apiInstance->createHTMLTemplate($create_template_data1);
500+
$result = $apiInstance->createHTMLTemplate($create_html_template_data);
444501
print_r($result);
445502
} catch (Exception $e) {
446503
echo 'Exception when calling PDFApi->createHTMLTemplate: ', $e->getMessage(), PHP_EOL;
@@ -452,7 +509,7 @@ try {
452509

453510
Name | Type | Description | Notes
454511
------------- | ------------- | ------------- | -------------
455-
**create_template_data1** | [**\DocSpring\Model\CreateTemplateData1**](../Model/CreateTemplateData1.md)| |
512+
**create_html_template_data** | [**\DocSpring\Model\CreateHtmlTemplateData**](../Model/CreateHtmlTemplateData.md)| |
456513

457514
### Return type
458515

@@ -528,7 +585,7 @@ Name | Type | Description | Notes
528585
[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md)
529586

530587
# **createPDFTemplateFromUpload**
531-
> \DocSpring\Model\PendingTemplate createPDFTemplateFromUpload($create_template_data)
588+
> \DocSpring\Model\PendingTemplate createPDFTemplateFromUpload($create_template_from_upload_data)
532589
533590
Create a new PDF template from a cached presign upload
534591

@@ -549,10 +606,10 @@ $apiInstance = new DocSpring\Api\PDFApi(
549606
new GuzzleHttp\Client(),
550607
$config
551608
);
552-
$create_template_data = new \DocSpring\Model\CreateTemplateData(); // \DocSpring\Model\CreateTemplateData |
609+
$create_template_from_upload_data = new \DocSpring\Model\CreateTemplateFromUploadData(); // \DocSpring\Model\CreateTemplateFromUploadData |
553610

554611
try {
555-
$result = $apiInstance->createPDFTemplateFromUpload($create_template_data);
612+
$result = $apiInstance->createPDFTemplateFromUpload($create_template_from_upload_data);
556613
print_r($result);
557614
} catch (Exception $e) {
558615
echo 'Exception when calling PDFApi->createPDFTemplateFromUpload: ', $e->getMessage(), PHP_EOL;
@@ -564,7 +621,7 @@ try {
564621

565622
Name | Type | Description | Notes
566623
------------- | ------------- | ------------- | -------------
567-
**create_template_data** | [**\DocSpring\Model\CreateTemplateData**](../Model/CreateTemplateData.md)| |
624+
**create_template_from_upload_data** | [**\DocSpring\Model\CreateTemplateFromUploadData**](../Model/CreateTemplateFromUploadData.md)| |
568625

569626
### Return type
570627

docs/Model/CreateTemplateData.md renamed to docs/Model/AddFieldsData.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
1-
# CreateTemplateData
1+
# AddFieldsData
22

33
## Properties
44
Name | Type | Description | Notes
55
------------ | ------------- | ------------- | -------------
6-
**template** | [**\DocSpring\Model\TemplatesdesccachedUploadTemplate**](TemplatesdesccachedUploadTemplate.md) | |
6+
**fields** | [**\DocSpring\Model\TemplatestemplateIdaddFieldsFields[]**](TemplatestemplateIdaddFieldsFields.md) | |
77

88
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
99

‎docs/Model/AddFieldsTemplateResponse.md‎

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
# AddFieldsTemplateResponse
2+
3+
## Properties
4+
Name | Type | Description | Notes
5+
------------ | ------------- | ------------- | -------------
6+
**new_field_ids** | **int[]** | | [optional]
7+
**errors** | **string[]** | | [optional]
8+
**status** | **string** | | [optional]
9+
10+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
11+
12+

docs/Model/CreateTemplateData1.md renamed to docs/Model/CreateHtmlTemplateData.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
1-
# CreateTemplateData1
1+
# CreateHtmlTemplateData
22

33
## Properties
44
Name | Type | Description | Notes
55
------------ | ------------- | ------------- | -------------
6-
**template** | [**\DocSpring\Model\TemplatesdesccachedUploadTemplate**](TemplatesdesccachedUploadTemplate.md) | |
6+
**template** | [**\DocSpring\Model\HtmlTemplateData**](HtmlTemplateData.md) | |
77

88
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
99

‎docs/Model/CreateTemplateFromUploadData.md‎

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
# CreateTemplateFromUploadData
2+
3+
## Properties
4+
Name | Type | Description | Notes
5+
------------ | ------------- | ------------- | -------------
6+
**template** | [**\DocSpring\Model\UploadTemplateData**](UploadTemplateData.md) | |
7+
8+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
9+
10+

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

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# TemplatesdesccachedUploadTemplate
1+
# 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** | **bool** | | [optional]
11-
**document** | [**\DocSpring\Model\TemplatesdesccachedUploadTemplateDocument**](TemplatesdesccachedUploadTemplateDocument.md) | | [optional]
1211
**description** | **string** | | [optional]
1312
**public_submissions** | **bool** | | [optional]
1413
**slack_webhook_url** | **string** | | [optional]

‎docs/Model/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** | **bool** | | [optional]
2122
**redirect_url** | **string** | | [optional]
2223

2324
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

0 commit comments

Comments
 (0)