docspring 1.0.0 → 1.3.1
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 +14 -37
- data/Gemfile +2 -1
- data/Gemfile.lock +37 -32
- data/LICENSE +1 -1
- data/README.md +26 -15
- data/docs/AddFieldsData.md +8 -0
- data/docs/AddFieldsTemplateResponse.md +10 -0
- data/docs/CombinePdfsData.md +4 -4
- data/docs/CombinedSubmission.md +1 -0
- data/docs/CombinedSubmissionData.md +3 -3
- data/docs/{CreateTemplateData.md → CreateHtmlTemplateData.md} +2 -2
- data/docs/CreateSubmissionDataRequestData.md +2 -2
- data/docs/CreateTemplateFromUploadData.md +8 -0
- data/docs/HtmlTemplateData.md +24 -0
- data/docs/PDFApi.md +169 -15
- data/docs/PendingTemplate.md +2 -0
- data/docs/Submission.md +5 -0
- data/docs/SubmissionBatchData.md +2 -2
- data/docs/SubmissionData.md +4 -3
- data/docs/SubmissionDataBatchRequest.md +2 -2
- data/docs/SubmissionDataRequest.md +2 -0
- data/docs/Template.md +2 -0
- data/docs/{Templatesv2Template.md → TemplateData.md} +11 -7
- data/docs/TemplatestemplateIdaddFieldsFields.md +92 -0
- data/docs/UpdateSubmissionDataRequestData.md +9 -9
- data/docs/UpdateTemplateData.md +8 -0
- data/docs/UpdateTemplateResponse.md +9 -0
- data/docs/UploadTemplateData.md +25 -0
- data/docs/{Templatesv2TemplateDocument.md → UploadTemplateDataDocument.md} +2 -2
- data/docs/{Templatesv2TemplateDocumentMetadata.md → UploadTemplateDataDocumentMetadata.md} +1 -1
- data/docspring.gemspec +3 -3
- data/lib/docspring.rb +13 -5
- data/lib/docspring/api/pdf_api.rb +193 -22
- 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 +11 -2
- data/lib/docspring/models/combined_submission_action.rb +1 -6
- data/lib/docspring/models/combined_submission_data.rb +23 -23
- 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_from_upload_data.rb +188 -0
- 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 +1 -1
- data/lib/docspring/models/pending_template.rb +20 -2
- data/lib/docspring/models/rename_folder_data.rb +1 -1
- data/lib/docspring/models/submission.rb +52 -7
- 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 -25
- data/lib/docspring/models/submission_data_batch_request.rb +20 -20
- data/lib/docspring/models/submission_data_request.rb +23 -20
- data/lib/docspring/models/template.rb +20 -2
- data/lib/docspring/models/{templatesv2_template.rb → template_data.rb} +81 -45
- 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 +188 -0
- data/lib/docspring/models/update_template_response.rb +228 -0
- data/lib/docspring/models/upload_template_data.rb +382 -0
- data/lib/docspring/models/{templatesv2_template_document.rb → upload_template_data_document.rb} +3 -3
- data/lib/docspring/models/{templatesv2_template_document_metadata.rb → upload_template_data_document_metadata.rb} +2 -2
- data/lib/docspring/version.rb +2 -2
- data/spec/api/client_integration_spec.rb +14 -2
- data/spec/api/pdf_api_integration_spec.rb +49 -18
- data/spec/api/pdf_api_spec_original.skipped.rb +51 -11
- 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 +7 -1
- 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_html_template_data_spec.rb +41 -0
- 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_data_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 +13 -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 +13 -1
- data/spec/models/submission_data_spec.rb +11 -5
- data/spec/models/submission_spec.rb +32 -2
- data/spec/models/{templatesv2_template_spec.rb → template_data_spec.rb} +40 -16
- data/spec/models/template_spec.rb +13 -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 +41 -0
- data/spec/models/update_template_response_spec.rb +51 -0
- data/spec/models/{templatesv2_template_document_metadata_spec.rb → upload_template_data_document_metadata_spec.rb} +7 -7
- data/spec/models/{templatesv2_template_document_spec.rb → upload_template_data_document_spec.rb} +7 -7
- data/spec/models/upload_template_data_spec.rb +151 -0
- data/spec/spec_helper.rb +1 -1
- metadata +60 -32
- data/.swagger-codegen-ignore +0 -31
- data/.swagger-codegen/VERSION +0 -1
- data/.swagger-revision +0 -1
- data/.travis.yml +0 -8
data/docs/PDFApi.md
CHANGED
@@ -4,6 +4,7 @@ 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
|
@@ -11,8 +12,9 @@ Method | HTTP request | Description
|
|
11
12
|
[**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
13
|
[**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
14
|
[**create_folder**](PDFApi.md#create_folder) | **POST** /folders/ | Create a folder
|
14
|
-
[**
|
15
|
-
[**
|
15
|
+
[**create_html_template**](PDFApi.md#create_html_template) | **POST** /templates?desc=html | Create a new HTML template
|
16
|
+
[**create_pdf_template**](PDFApi.md#create_pdf_template) | **POST** /templates | Create a new PDF template with a form POST file upload
|
17
|
+
[**create_pdf_template_from_upload**](PDFApi.md#create_pdf_template_from_upload) | **POST** /templates?desc=cached_upload | Create a new PDF template from a cached presign upload
|
16
18
|
[**delete_folder**](PDFApi.md#delete_folder) | **DELETE** /folders/{folder_id} | Delete a folder
|
17
19
|
[**expire_combined_submission**](PDFApi.md#expire_combined_submission) | **DELETE** /combined_submissions/{combined_submission_id} | Expire a combined submission
|
18
20
|
[**expire_submission**](PDFApi.md#expire_submission) | **DELETE** /submissions/{submission_id} | Expire a PDF submission
|
@@ -31,6 +33,58 @@ Method | HTTP request | Description
|
|
31
33
|
[**rename_folder**](PDFApi.md#rename_folder) | **POST** /folders/{folder_id}/rename | Rename a folder
|
32
34
|
[**test_authentication**](PDFApi.md#test_authentication) | **GET** /authentication | Test Authentication
|
33
35
|
[**update_data_request**](PDFApi.md#update_data_request) | **PUT** /data_requests/{data_request_id} | Update a submission data request
|
36
|
+
[**update_template**](PDFApi.md#update_template) | **PUT** /templates/{template_id} | Update a Template
|
37
|
+
|
38
|
+
|
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
|
+
|
34
88
|
|
35
89
|
|
36
90
|
# **batch_generate_pdf_v1**
|
@@ -378,10 +432,59 @@ Name | Type | Description | Notes
|
|
378
432
|
|
379
433
|
|
380
434
|
|
381
|
-
# **
|
382
|
-
> PendingTemplate
|
435
|
+
# **create_html_template**
|
436
|
+
> PendingTemplate create_html_template(create_html_template_data)
|
383
437
|
|
384
|
-
|
438
|
+
Create a new HTML template
|
439
|
+
|
440
|
+
### Example
|
441
|
+
```ruby
|
442
|
+
# load the gem
|
443
|
+
require 'docspring'
|
444
|
+
# setup authorization
|
445
|
+
DocSpring.configure do |config|
|
446
|
+
# Configure HTTP basic authorization: api_token_basic
|
447
|
+
config.username = 'YOUR USERNAME'
|
448
|
+
config.password = 'YOUR PASSWORD'
|
449
|
+
end
|
450
|
+
|
451
|
+
api_instance = DocSpring::PDFApi.new
|
452
|
+
create_html_template_data = DocSpring::CreateHtmlTemplateData.new # CreateHtmlTemplateData |
|
453
|
+
|
454
|
+
begin
|
455
|
+
#Create a new HTML template
|
456
|
+
result = api_instance.create_html_template(create_html_template_data)
|
457
|
+
p result
|
458
|
+
rescue DocSpring::ApiError => e
|
459
|
+
puts "Exception when calling PDFApi->create_html_template: #{e}"
|
460
|
+
end
|
461
|
+
```
|
462
|
+
|
463
|
+
### Parameters
|
464
|
+
|
465
|
+
Name | Type | Description | Notes
|
466
|
+
------------- | ------------- | ------------- | -------------
|
467
|
+
**create_html_template_data** | [**CreateHtmlTemplateData**](CreateHtmlTemplateData.md)| |
|
468
|
+
|
469
|
+
### Return type
|
470
|
+
|
471
|
+
[**PendingTemplate**](PendingTemplate.md)
|
472
|
+
|
473
|
+
### Authorization
|
474
|
+
|
475
|
+
[api_token_basic](../README.md#api_token_basic)
|
476
|
+
|
477
|
+
### HTTP request headers
|
478
|
+
|
479
|
+
- **Content-Type**: application/json
|
480
|
+
- **Accept**: application/json
|
481
|
+
|
482
|
+
|
483
|
+
|
484
|
+
# **create_pdf_template**
|
485
|
+
> PendingTemplate create_pdf_template(template_document, template_name, opts)
|
486
|
+
|
487
|
+
Create a new PDF template with a form POST file upload
|
385
488
|
|
386
489
|
### Example
|
387
490
|
```ruby
|
@@ -402,11 +505,11 @@ opts = {
|
|
402
505
|
}
|
403
506
|
|
404
507
|
begin
|
405
|
-
#
|
406
|
-
result = api_instance.
|
508
|
+
#Create a new PDF template with a form POST file upload
|
509
|
+
result = api_instance.create_pdf_template(template_document, template_name, opts)
|
407
510
|
p result
|
408
511
|
rescue DocSpring::ApiError => e
|
409
|
-
puts "Exception when calling PDFApi->
|
512
|
+
puts "Exception when calling PDFApi->create_pdf_template: #{e}"
|
410
513
|
end
|
411
514
|
```
|
412
515
|
|
@@ -433,8 +536,8 @@ Name | Type | Description | Notes
|
|
433
536
|
|
434
537
|
|
435
538
|
|
436
|
-
# **
|
437
|
-
> PendingTemplate
|
539
|
+
# **create_pdf_template_from_upload**
|
540
|
+
> PendingTemplate create_pdf_template_from_upload(create_template_from_upload_data)
|
438
541
|
|
439
542
|
Create a new PDF template from a cached presign upload
|
440
543
|
|
@@ -450,14 +553,14 @@ DocSpring.configure do |config|
|
|
450
553
|
end
|
451
554
|
|
452
555
|
api_instance = DocSpring::PDFApi.new
|
453
|
-
|
556
|
+
create_template_from_upload_data = DocSpring::CreateTemplateFromUploadData.new # CreateTemplateFromUploadData |
|
454
557
|
|
455
558
|
begin
|
456
559
|
#Create a new PDF template from a cached presign upload
|
457
|
-
result = api_instance.
|
560
|
+
result = api_instance.create_pdf_template_from_upload(create_template_from_upload_data)
|
458
561
|
p result
|
459
562
|
rescue DocSpring::ApiError => e
|
460
|
-
puts "Exception when calling PDFApi->
|
563
|
+
puts "Exception when calling PDFApi->create_pdf_template_from_upload: #{e}"
|
461
564
|
end
|
462
565
|
```
|
463
566
|
|
@@ -465,7 +568,7 @@ end
|
|
465
568
|
|
466
569
|
Name | Type | Description | Notes
|
467
570
|
------------- | ------------- | ------------- | -------------
|
468
|
-
**
|
571
|
+
**create_template_from_upload_data** | [**CreateTemplateFromUploadData**](CreateTemplateFromUploadData.md)| |
|
469
572
|
|
470
573
|
### Return type
|
471
574
|
|
@@ -842,7 +945,7 @@ end
|
|
842
945
|
api_instance = DocSpring::PDFApi.new
|
843
946
|
submission_id = 'sub_000000000000000001' # String |
|
844
947
|
opts = {
|
845
|
-
include_data:
|
948
|
+
include_data: true # BOOLEAN |
|
846
949
|
}
|
847
950
|
|
848
951
|
begin
|
@@ -1383,3 +1486,54 @@ Name | Type | Description | Notes
|
|
1383
1486
|
|
1384
1487
|
|
1385
1488
|
|
1489
|
+
# **update_template**
|
1490
|
+
> UpdateTemplateResponse update_template(template_id, update_template_data)
|
1491
|
+
|
1492
|
+
Update a Template
|
1493
|
+
|
1494
|
+
### Example
|
1495
|
+
```ruby
|
1496
|
+
# load the gem
|
1497
|
+
require 'docspring'
|
1498
|
+
# setup authorization
|
1499
|
+
DocSpring.configure do |config|
|
1500
|
+
# Configure HTTP basic authorization: api_token_basic
|
1501
|
+
config.username = 'YOUR USERNAME'
|
1502
|
+
config.password = 'YOUR PASSWORD'
|
1503
|
+
end
|
1504
|
+
|
1505
|
+
api_instance = DocSpring::PDFApi.new
|
1506
|
+
template_id = 'tpl_000000000000000003' # String |
|
1507
|
+
update_template_data = DocSpring::UpdateTemplateData.new # UpdateTemplateData |
|
1508
|
+
|
1509
|
+
begin
|
1510
|
+
#Update a Template
|
1511
|
+
result = api_instance.update_template(template_id, update_template_data)
|
1512
|
+
p result
|
1513
|
+
rescue DocSpring::ApiError => e
|
1514
|
+
puts "Exception when calling PDFApi->update_template: #{e}"
|
1515
|
+
end
|
1516
|
+
```
|
1517
|
+
|
1518
|
+
### Parameters
|
1519
|
+
|
1520
|
+
Name | Type | Description | Notes
|
1521
|
+
------------- | ------------- | ------------- | -------------
|
1522
|
+
**template_id** | **String**| |
|
1523
|
+
**update_template_data** | [**UpdateTemplateData**](UpdateTemplateData.md)| |
|
1524
|
+
|
1525
|
+
### Return type
|
1526
|
+
|
1527
|
+
[**UpdateTemplateResponse**](UpdateTemplateResponse.md)
|
1528
|
+
|
1529
|
+
### Authorization
|
1530
|
+
|
1531
|
+
[api_token_basic](../README.md#api_token_basic)
|
1532
|
+
|
1533
|
+
### HTTP request headers
|
1534
|
+
|
1535
|
+
- **Content-Type**: application/json
|
1536
|
+
- **Accept**: application/json
|
1537
|
+
|
1538
|
+
|
1539
|
+
|
data/docs/PendingTemplate.md
CHANGED
@@ -8,6 +8,7 @@ Name | Type | Description | Notes
|
|
8
8
|
**parent_folder_id** | **String** | | [optional]
|
9
9
|
**expire_after** | **Float** | | [optional]
|
10
10
|
**allow_additional_properties** | **BOOLEAN** | | [optional]
|
11
|
+
**description** | **String** | | [optional]
|
11
12
|
**public_submissions** | **BOOLEAN** | | [optional]
|
12
13
|
**slack_webhook_url** | **String** | | [optional]
|
13
14
|
**path** | **String** | | [optional]
|
@@ -17,6 +18,7 @@ Name | Type | Description | Notes
|
|
17
18
|
**name** | **String** | | [optional]
|
18
19
|
**template_type** | **String** | | [optional]
|
19
20
|
**id** | **String** | | [optional]
|
21
|
+
**locked** | **BOOLEAN** | | [optional]
|
20
22
|
**redirect_url** | **String** | | [optional]
|
21
23
|
|
22
24
|
|
data/docs/Submission.md
CHANGED
@@ -11,11 +11,16 @@ Name | Type | Description | Notes
|
|
11
11
|
**expires_at** | **String** | | [optional]
|
12
12
|
**processed_at** | **String** | | [optional]
|
13
13
|
**state** | **String** | |
|
14
|
+
**data** | **Object** | | [optional]
|
14
15
|
**metadata** | **Object** | | [optional]
|
16
|
+
**truncated_text** | **Object** | | [optional]
|
17
|
+
**pdf_hash** | **String** | | [optional]
|
15
18
|
**download_url** | **String** | | [optional]
|
16
19
|
**permanent_download_url** | **String** | | [optional]
|
17
20
|
**batch_id** | **String** | | [optional]
|
18
21
|
**data_requests** | [**Array<SubmissionDataRequest>**](SubmissionDataRequest.md) | | [optional]
|
19
22
|
**actions** | [**Array<SubmissionAction>**](SubmissionAction.md) | | [optional]
|
23
|
+
**source** | **String** | | [optional]
|
24
|
+
**referrer** | **String** | | [optional]
|
20
25
|
|
21
26
|
|
data/docs/SubmissionBatchData.md
CHANGED
@@ -4,8 +4,8 @@
|
|
4
4
|
Name | Type | Description | Notes
|
5
5
|
------------ | ------------- | ------------- | -------------
|
6
6
|
**metadata** | **Object** | | [optional]
|
7
|
-
**test** | **BOOLEAN** | | [optional]
|
8
|
-
**template_id** | **String** | | [optional]
|
9
7
|
**submissions** | [**Array<SubmissionDataBatchRequest>**](SubmissionDataBatchRequest.md) | |
|
8
|
+
**template_id** | **String** | | [optional]
|
9
|
+
**test** | **BOOLEAN** | | [optional]
|
10
10
|
|
11
11
|
|
data/docs/SubmissionData.md
CHANGED
@@ -3,11 +3,12 @@
|
|
3
3
|
## Properties
|
4
4
|
Name | Type | Description | Notes
|
5
5
|
------------ | ------------- | ------------- | -------------
|
6
|
-
**
|
6
|
+
**css** | **String** | | [optional]
|
7
7
|
**data** | **Object** | |
|
8
|
+
**data_requests** | [**Array<CreateSubmissionDataRequestData>**](CreateSubmissionDataRequestData.md) | | [optional]
|
9
|
+
**field_overrides** | **Object** | | [optional]
|
8
10
|
**html** | **String** | | [optional]
|
9
|
-
**css** | **String** | | [optional]
|
10
11
|
**metadata** | **Object** | | [optional]
|
11
|
-
**
|
12
|
+
**test** | **BOOLEAN** | | [optional]
|
12
13
|
|
13
14
|
|
@@ -5,9 +5,9 @@ Name | Type | Description | Notes
|
|
5
5
|
------------ | ------------- | ------------- | -------------
|
6
6
|
**css** | **String** | | [optional]
|
7
7
|
**metadata** | **Object** | | [optional]
|
8
|
-
**test** | **BOOLEAN** | | [optional]
|
9
8
|
**data** | **Object** | | [optional]
|
10
|
-
**
|
9
|
+
**test** | **BOOLEAN** | | [optional]
|
11
10
|
**html** | **String** | | [optional]
|
11
|
+
**template_id** | **String** | | [optional]
|
12
12
|
|
13
13
|
|
@@ -20,5 +20,7 @@ Name | Type | Description | Notes
|
|
20
20
|
**auth_user_id_hash** | **String** | | [optional]
|
21
21
|
**auth_username_hash** | **String** | | [optional]
|
22
22
|
**auth_phone_number_hash** | **String** | | [optional]
|
23
|
+
**ip_address** | **String** | | [optional]
|
24
|
+
**user_agent** | **String** | | [optional]
|
23
25
|
|
24
26
|
|
data/docs/Template.md
CHANGED
@@ -8,6 +8,7 @@ Name | Type | Description | Notes
|
|
8
8
|
**parent_folder_id** | **String** | | [optional]
|
9
9
|
**expire_after** | **Float** | | [optional]
|
10
10
|
**allow_additional_properties** | **BOOLEAN** | | [optional]
|
11
|
+
**description** | **String** | | [optional]
|
11
12
|
**public_submissions** | **BOOLEAN** | | [optional]
|
12
13
|
**slack_webhook_url** | **String** | | [optional]
|
13
14
|
**path** | **String** | | [optional]
|
@@ -19,6 +20,7 @@ Name | Type | Description | Notes
|
|
19
20
|
**template_type** | **String** | | [optional]
|
20
21
|
**id** | **String** | | [optional]
|
21
22
|
**page_dimensions** | **Array<Array<Float>>** | | [optional]
|
23
|
+
**locked** | **BOOLEAN** | | [optional]
|
22
24
|
**redirect_url** | **String** | | [optional]
|
23
25
|
**document_url** | **String** | | [optional]
|
24
26
|
|
@@ -1,19 +1,23 @@
|
|
1
|
-
# DocSpring::
|
1
|
+
# DocSpring::TemplateData
|
2
2
|
|
3
3
|
## Properties
|
4
4
|
Name | Type | Description | Notes
|
5
5
|
------------ | ------------- | ------------- | -------------
|
6
6
|
**expiration_interval** | **String** | | [optional]
|
7
|
-
**public_web_form** | **BOOLEAN** | | [optional]
|
8
7
|
**webhook_url** | **String** | | [optional]
|
9
|
-
**
|
10
|
-
**expire_submissions** | **BOOLEAN** | | [optional]
|
11
|
-
**expire_after** | **Float** | | [optional]
|
8
|
+
**scss** | **String** | | [optional]
|
12
9
|
**allow_additional_properties** | **BOOLEAN** | | [optional]
|
13
|
-
**
|
14
|
-
**
|
10
|
+
**expire_after** | **Float** | | [optional]
|
11
|
+
**description** | **String** | | [optional]
|
15
12
|
**public_submissions** | **BOOLEAN** | | [optional]
|
16
13
|
**slack_webhook_url** | **String** | | [optional]
|
14
|
+
**header_html** | **String** | | [optional]
|
15
|
+
**public_web_form** | **BOOLEAN** | | [optional]
|
16
|
+
**editable_submissions** | **BOOLEAN** | | [optional]
|
17
|
+
**expire_submissions** | **BOOLEAN** | | [optional]
|
18
|
+
**name** | **String** | | [optional]
|
19
|
+
**footer_html** | **String** | | [optional]
|
20
|
+
**html** | **String** | | [optional]
|
17
21
|
**redirect_url** | **String** | | [optional]
|
18
22
|
|
19
23
|
|
@@ -0,0 +1,92 @@
|
|
1
|
+
# DocSpring::TemplatestemplateIdaddFieldsFields
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**background_color_field_name** | **String** | | [optional]
|
7
|
+
**uppercase** | **BOOLEAN** | | [optional]
|
8
|
+
**metadata** | **String** | | [optional]
|
9
|
+
**barcode_symbology** | **String** | | [optional]
|
10
|
+
**min_length** | **Float** | | [optional]
|
11
|
+
**integer** | **BOOLEAN** | | [optional]
|
12
|
+
**type** | **String** | | [optional]
|
13
|
+
**required** | **BOOLEAN** | | [optional]
|
14
|
+
**comb_value_offset** | **Float** | | [optional]
|
15
|
+
**image_gravity** | **String** | | [optional]
|
16
|
+
**overflow** | **String** | | [optional]
|
17
|
+
**qrcode_color** | **String** | | [optional]
|
18
|
+
**color_field_required** | **BOOLEAN** | | [optional]
|
19
|
+
**background_color_field_required** | **BOOLEAN** | | [optional]
|
20
|
+
**id** | **Float** | | [optional]
|
21
|
+
**image_scale_type** | **String** | | [optional]
|
22
|
+
**exclusive_minimum** | **BOOLEAN** | | [optional]
|
23
|
+
**height** | **Float** | | [optional]
|
24
|
+
**number_condition_range_exclusive_max** | **BOOLEAN** | | [optional]
|
25
|
+
**invert_boolean_condition** | **BOOLEAN** | | [optional]
|
26
|
+
**shape_fill_color_field_name** | **String** | | [optional]
|
27
|
+
**static** | **BOOLEAN** | | [optional]
|
28
|
+
**shape_border_color_field_name** | **String** | | [optional]
|
29
|
+
**v_alignment** | **String** | | [optional]
|
30
|
+
**bold** | **BOOLEAN** | | [optional]
|
31
|
+
**shape_border_width** | **Float** | | [optional]
|
32
|
+
**comb_number_of_cells** | **Float** | | [optional]
|
33
|
+
**shape_border_color** | **String** | | [optional]
|
34
|
+
**comb** | **BOOLEAN** | | [optional]
|
35
|
+
**typeface** | **String** | | [optional]
|
36
|
+
**shape_type** | **String** | | [optional]
|
37
|
+
**condition** | **String** | | [optional]
|
38
|
+
**display_type** | **String** | | [optional]
|
39
|
+
**check_color** | **String** | | [optional]
|
40
|
+
**multiline_lines** | **Float** | | [optional]
|
41
|
+
**multiline** | **BOOLEAN** | | [optional]
|
42
|
+
**true_text** | **String** | | [optional]
|
43
|
+
**name** | **String** | | [optional]
|
44
|
+
**font_size** | **Float** | | [optional]
|
45
|
+
**page** | **Float** | | [optional]
|
46
|
+
**alignment** | **String** | | [optional]
|
47
|
+
**max_length** | **Float** | | [optional]
|
48
|
+
**auto_calculate_max_length** | **BOOLEAN** | | [optional]
|
49
|
+
**color_field_name** | **String** | | [optional]
|
50
|
+
**qrcode_color_field_name** | **String** | | [optional]
|
51
|
+
**number_condition_range_min** | **Float** | | [optional]
|
52
|
+
**color** | **String** | | [optional]
|
53
|
+
**hidden** | **BOOLEAN** | | [optional]
|
54
|
+
**check_color_field_required** | **BOOLEAN** | | [optional]
|
55
|
+
**combined_field_format** | **String** | | [optional]
|
56
|
+
**description** | **String** | | [optional]
|
57
|
+
**shape_border_color_field_required** | **BOOLEAN** | | [optional]
|
58
|
+
**combined_field_names** | **String** | | [optional]
|
59
|
+
**title** | **String** | | [optional]
|
60
|
+
**number_condition_range_exclusive_min** | **BOOLEAN** | | [optional]
|
61
|
+
**combined_field_separator** | **String** | | [optional]
|
62
|
+
**exclusive_maximum** | **BOOLEAN** | | [optional]
|
63
|
+
**default** | **String** | | [optional]
|
64
|
+
**combined_field_type** | **String** | | [optional]
|
65
|
+
**date_time_format** | **String** | | [optional]
|
66
|
+
**qrcode_color_field_required** | **BOOLEAN** | | [optional]
|
67
|
+
**currency** | **BOOLEAN** | | [optional]
|
68
|
+
**false_text** | **String** | | [optional]
|
69
|
+
**strikethrough** | **BOOLEAN** | | [optional]
|
70
|
+
**character_spacing** | **Float** | | [optional]
|
71
|
+
**number_condition_range_max** | **Float** | | [optional]
|
72
|
+
**background_color** | **String** | | [optional]
|
73
|
+
**check_color_field_name** | **String** | | [optional]
|
74
|
+
**check_character** | **String** | | [optional]
|
75
|
+
**rotation** | **Float** | | [optional]
|
76
|
+
**option_list** | **String** | | [optional]
|
77
|
+
**shape_fill_color** | **String** | | [optional]
|
78
|
+
**string_condition_type** | **String** | | [optional]
|
79
|
+
**shape_fill_color_field_required** | **BOOLEAN** | | [optional]
|
80
|
+
**decimal_places** | **Float** | | [optional]
|
81
|
+
**include_time** | **BOOLEAN** | | [optional]
|
82
|
+
**width** | **Float** | | [optional]
|
83
|
+
**x** | **Float** | | [optional]
|
84
|
+
**maximum** | **Float** | | [optional]
|
85
|
+
**y** | **Float** | | [optional]
|
86
|
+
**signature_allow_draw** | **BOOLEAN** | | [optional]
|
87
|
+
**number_condition_type** | **String** | | [optional]
|
88
|
+
**opacity** | **Float** | | [optional]
|
89
|
+
**minimum** | **Float** | | [optional]
|
90
|
+
**signature_allow_type** | **BOOLEAN** | | [optional]
|
91
|
+
|
92
|
+
|