docspring 1.4.1 → 2.0.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/.gitlab-ci.yml +26 -0
- data/.openapi-generator/FILES +220 -0
- data/.openapi-generator/VERSION +1 -1
- data/.rubocop.yml +6 -12
- data/.travis.yml +11 -0
- data/CHANGELOG.md +5 -0
- data/Gemfile +5 -1
- data/Gemfile.lock +85 -48
- data/README.md +43 -18
- data/docs/AddFieldsData.md +13 -3
- data/docs/AddFieldsTemplateResponse.md +17 -5
- data/docs/AuthenticationError.md +15 -4
- data/docs/AuthenticationSuccessResponse.md +13 -3
- data/docs/CombinePdfsData.md +23 -8
- data/docs/CombinedSubmission.md +37 -13
- data/docs/CombinedSubmissionAction.md +23 -8
- data/docs/CombinedSubmissionData.md +21 -7
- data/docs/CopyTemplateData.md +15 -4
- data/docs/CreateCombinedSubmissionResponse.md +17 -5
- data/docs/CreateCustomFileData.md +13 -3
- data/docs/CreateCustomFileResponse.md +17 -5
- data/docs/CreateFolderAttributes.md +20 -0
- data/docs/CreateFolderData.md +13 -3
- data/docs/CreateHtmlTemplateData.md +13 -3
- data/docs/CreateSubmissionBatchResponse.md +21 -7
- data/docs/CreateSubmissionBatchSubmissionsResponse.md +17 -5
- data/docs/CreateSubmissionData.md +36 -0
- data/docs/CreateSubmissionDataRequestData.md +37 -15
- data/docs/CreateSubmissionDataRequestEventRequest.md +24 -0
- data/docs/CreateSubmissionDataRequestEventResponse.md +22 -0
- data/docs/CreateSubmissionDataRequestTokenResponse.md +17 -5
- data/docs/CreateSubmissionResponse.md +17 -5
- data/docs/CreateTemplateFromUploadData.md +13 -3
- data/docs/DataRequestToken.md +24 -0
- data/docs/DeleteTemplateResponse.md +20 -0
- data/docs/ErrorResponse.md +20 -0
- data/docs/Folder.md +19 -6
- data/docs/FullTemplate.md +94 -0
- data/docs/HtmlTemplateData.md +51 -19
- data/docs/HtmlTemplateDataWebhookOptions.md +18 -0
- data/docs/InvalidRequest.md +15 -4
- data/docs/InvalidRequestSingleError.md +20 -0
- data/docs/ListSubmissionsResponse.md +17 -5
- data/docs/MoveFolderData.md +13 -3
- data/docs/MoveTemplateData.md +13 -3
- data/docs/PDFApi.md +1598 -523
- data/docs/PendingTemplate.md +45 -19
- data/docs/PreviewPdfResponse.md +20 -0
- data/docs/PublishTemplateVersion404Response.md +20 -0
- data/docs/PublishTemplateVersion422Response.md +20 -0
- data/docs/PublishTemplateVersionResponse.md +20 -0
- data/docs/PublishTemplateVersionResponseResult.md +24 -0
- data/docs/PublishVersionData.md +20 -0
- data/docs/RenameFolderData.md +13 -3
- data/docs/RestoreTemplateVersionResponse.md +18 -0
- data/docs/RestoreVersionData.md +18 -0
- data/docs/Submission.md +49 -21
- data/docs/SubmissionAction.md +23 -8
- data/docs/SubmissionBatch.md +29 -11
- data/docs/SubmissionBatchData.md +21 -6
- data/docs/SubmissionData.md +23 -10
- data/docs/SubmissionDataBatchRequest.md +25 -8
- data/docs/SubmissionDataRequest.md +53 -22
- data/docs/SubmissionDataRequestEvent.md +30 -0
- data/docs/Template.md +51 -22
- data/docs/TemplateData.md +49 -18
- data/docs/TemplateDefaults.md +22 -0
- data/docs/TemplateDocument.md +22 -0
- data/docs/TemplateDocumentMetadata.md +22 -0
- data/docs/TemplateSchema.md +34 -0
- data/docs/UpdateDataRequestResponse.md +17 -5
- data/docs/UpdateSubmissionDataRequestData.md +37 -15
- data/docs/UpdateTemplateData.md +13 -3
- data/docs/UpdateTemplateResponse.md +15 -4
- data/docs/UploadPresign.md +24 -0
- data/docs/UploadTemplateData.md +53 -20
- data/docspring.gemspec +14 -11
- data/git_push.sh +11 -9
- data/lib/docspring/api/pdf_api.rb +1344 -539
- data/lib/docspring/api_client.rb +106 -98
- data/lib/docspring/api_error.rb +22 -2
- data/lib/docspring/configuration.rb +127 -16
- data/lib/docspring/models/add_fields_data.rb +59 -26
- data/lib/docspring/models/add_fields_template_response.rb +81 -43
- data/lib/docspring/models/authentication_error.rb +62 -29
- data/lib/docspring/models/authentication_success_response.rb +66 -28
- data/lib/docspring/models/combine_pdfs_data.rb +65 -32
- data/lib/docspring/models/combined_submission.rb +165 -75
- data/lib/docspring/models/combined_submission_action.rb +83 -39
- data/lib/docspring/models/combined_submission_data.rb +63 -30
- data/lib/docspring/models/copy_template_data.rb +59 -26
- data/lib/docspring/models/create_combined_submission_response.rb +86 -41
- data/lib/docspring/models/create_custom_file_data.rb +58 -25
- data/lib/docspring/models/create_custom_file_response.rb +86 -41
- data/lib/docspring/models/create_folder_attributes.rb +230 -0
- data/lib/docspring/models/create_folder_data.rb +59 -26
- data/lib/docspring/models/create_html_template_data.rb +58 -25
- data/lib/docspring/models/create_submission_batch_response.rb +104 -52
- data/lib/docspring/models/create_submission_batch_submissions_response.rb +79 -41
- data/lib/docspring/models/create_submission_data.rb +304 -0
- data/lib/docspring/models/create_submission_data_request_data.rb +139 -90
- data/lib/docspring/models/create_submission_data_request_event_request.rb +297 -0
- data/lib/docspring/models/create_submission_data_request_event_response.rb +282 -0
- data/lib/docspring/models/create_submission_data_request_token_response.rb +85 -40
- data/lib/docspring/models/create_submission_response.rb +86 -41
- data/lib/docspring/models/create_template_from_upload_data.rb +58 -25
- data/lib/docspring/models/{custom_file.rb → data_request_token.rb} +110 -33
- data/lib/docspring/models/delete_template_response.rb +266 -0
- data/lib/docspring/models/{error.rb → error_response.rb} +65 -30
- data/lib/docspring/models/folder.rb +78 -46
- data/lib/docspring/models/{template1.rb → full_template.rb} +476 -240
- data/lib/docspring/models/html_template_data.rb +180 -110
- data/lib/docspring/models/{folders_folder.rb → html_template_data_webhook_options.rb} +63 -41
- data/lib/docspring/models/invalid_request.rb +64 -29
- data/lib/docspring/models/invalid_request_single_error.rb +271 -0
- data/lib/docspring/models/list_submissions_response.rb +87 -39
- data/lib/docspring/models/move_folder_data.rb +56 -25
- data/lib/docspring/models/move_template_data.rb +58 -25
- data/lib/docspring/models/pending_template.rb +221 -118
- data/lib/docspring/models/preview_pdf_response.rb +264 -0
- data/lib/docspring/models/publish_template_version404_response.rb +271 -0
- data/lib/docspring/models/publish_template_version422_response.rb +273 -0
- data/lib/docspring/models/publish_template_version_response.rb +271 -0
- data/lib/docspring/models/publish_template_version_response_result.rb +263 -0
- data/lib/docspring/models/publish_version_data.rb +230 -0
- data/lib/docspring/models/rename_folder_data.rb +58 -25
- data/lib/docspring/models/restore_template_version_response.rb +255 -0
- data/lib/docspring/models/{create_submission_data_request_token_response_token.rb → restore_version_data.rb} +69 -58
- data/lib/docspring/models/submission.rb +98 -49
- data/lib/docspring/models/submission_action.rb +83 -39
- data/lib/docspring/models/submission_batch.rb +158 -75
- data/lib/docspring/models/submission_batch_data.rb +74 -30
- data/lib/docspring/models/submission_data.rb +65 -50
- data/lib/docspring/models/submission_data_batch_request.rb +100 -49
- data/lib/docspring/models/submission_data_request.rb +123 -54
- data/lib/docspring/models/submission_data_request_event.rb +309 -0
- data/lib/docspring/models/template.rb +267 -132
- data/lib/docspring/models/template_data.rb +173 -105
- data/lib/docspring/models/{template1_defaults.rb → template_defaults.rb} +77 -29
- data/lib/docspring/models/{upload_template_data_document.rb → template_document.rb} +91 -39
- data/lib/docspring/models/{upload_template_data_document_metadata.rb → template_document_metadata.rb} +94 -42
- data/lib/docspring/models/template_schema.rb +288 -0
- data/lib/docspring/models/update_data_request_response.rb +86 -41
- data/lib/docspring/models/update_submission_data_request_data.rb +82 -43
- data/lib/docspring/models/update_template_data.rb +58 -25
- data/lib/docspring/models/update_template_response.rb +79 -41
- data/lib/docspring/models/upload_presign.rb +296 -0
- data/lib/docspring/models/upload_template_data.rb +186 -116
- data/lib/docspring/version.rb +3 -3
- data/lib/docspring.rb +29 -12
- data/spec/api/client_integration_spec.rb +26 -19
- data/spec/api/pdf_api_integration_spec.rb +21 -19
- data/spec/api/pdf_api_spec_original.skipped.rb +427 -118
- data/spec/models/add_fields_data_spec.rb +8 -13
- data/spec/models/add_fields_template_response_spec.rb +16 -21
- data/spec/models/authentication_error_spec.rb +10 -15
- data/spec/models/authentication_success_response_spec.rb +9 -14
- data/spec/models/combine_pdfs_data_spec.rb +13 -18
- data/spec/models/combined_submission_action_spec.rb +16 -21
- data/spec/models/combined_submission_data_spec.rb +12 -17
- data/spec/models/combined_submission_spec.rb +42 -35
- data/spec/models/copy_template_data_spec.rb +9 -14
- data/spec/models/create_combined_submission_response_spec.rb +16 -21
- data/spec/models/create_custom_file_data_spec.rb +8 -13
- data/spec/models/create_custom_file_response_spec.rb +16 -21
- data/spec/models/create_folder_attributes_spec.rb +42 -0
- data/spec/models/create_folder_data_spec.rb +8 -13
- data/spec/models/create_html_template_data_spec.rb +8 -13
- data/spec/models/create_submission_batch_response_spec.rb +21 -26
- data/spec/models/create_submission_batch_submissions_response_spec.rb +16 -21
- data/spec/models/create_submission_data_request_data_spec.rb +33 -38
- data/spec/models/create_submission_data_request_event_request_spec.rb +62 -0
- data/spec/models/create_submission_data_request_event_response_spec.rb +52 -0
- data/spec/models/create_submission_data_request_token_response_spec.rb +15 -20
- data/spec/models/create_submission_data_spec.rb +90 -0
- data/spec/models/create_submission_response_spec.rb +16 -21
- data/spec/models/create_template_from_upload_data_spec.rb +8 -13
- data/spec/models/data_request_token_spec.rb +54 -0
- data/spec/models/delete_template_response_spec.rb +46 -0
- data/spec/models/error_response_spec.rb +46 -0
- data/spec/models/folder_spec.rb +15 -20
- data/spec/models/full_template_spec.rb +268 -0
- data/spec/models/html_template_data_spec.rb +62 -49
- data/spec/models/html_template_data_webhook_options_spec.rb +36 -0
- data/spec/models/invalid_request_single_error_spec.rb +46 -0
- data/spec/models/invalid_request_spec.rb +10 -15
- data/spec/models/list_submissions_response_spec.rb +13 -18
- data/spec/models/move_folder_data_spec.rb +8 -13
- data/spec/models/move_template_data_spec.rb +8 -13
- data/spec/models/pending_template_spec.rb +45 -50
- data/spec/models/preview_pdf_response_spec.rb +46 -0
- data/spec/models/publish_template_version404_response_spec.rb +46 -0
- data/spec/models/publish_template_version422_response_spec.rb +46 -0
- data/spec/models/publish_template_version_response_result_spec.rb +54 -0
- data/spec/models/publish_template_version_response_spec.rb +46 -0
- data/spec/models/publish_version_data_spec.rb +42 -0
- data/spec/models/rename_folder_data_spec.rb +8 -13
- data/spec/models/restore_template_version_response_spec.rb +40 -0
- data/spec/models/restore_version_data_spec.rb +36 -0
- data/spec/models/submission_action_spec.rb +16 -21
- data/spec/models/submission_batch_data_spec.rb +17 -16
- data/spec/models/submission_batch_spec.rb +29 -34
- data/spec/models/submission_data_batch_request_spec.rb +24 -23
- data/spec/models/submission_data_request_event_spec.rb +72 -0
- data/spec/models/submission_data_request_spec.rb +36 -35
- data/spec/models/submission_data_spec.rb +13 -30
- data/spec/models/submission_spec.rb +27 -32
- data/spec/models/template_data_spec.rb +59 -46
- data/spec/models/template_defaults_spec.rb +48 -0
- data/spec/models/template_document_metadata_spec.rb +52 -0
- data/spec/models/template_document_spec.rb +52 -0
- data/spec/models/template_schema_spec.rb +84 -0
- data/spec/models/template_spec.rb +50 -55
- data/spec/models/update_data_request_response_spec.rb +16 -21
- data/spec/models/update_submission_data_request_data_spec.rb +22 -27
- data/spec/models/update_template_data_spec.rb +8 -13
- data/spec/models/update_template_response_spec.rb +14 -19
- data/spec/models/upload_presign_spec.rb +58 -0
- data/spec/models/upload_template_data_spec.rb +64 -51
- data/spec/spec_helper.rb +5 -5
- metadata +108 -132
- data/docs/CreateSubmissionDataRequestTokenResponseToken.md +0 -11
- data/docs/CustomFile.md +0 -9
- data/docs/Error.md +0 -9
- data/docs/FoldersFolder.md +0 -9
- data/docs/Template1.md +0 -46
- data/docs/Template1Defaults.md +0 -10
- data/docs/TemplatestemplateIdaddFieldsFields.md +0 -92
- data/docs/UploadTemplateDataDocument.md +0 -10
- data/docs/UploadTemplateDataDocumentMetadata.md +0 -10
- data/lib/docspring/models/templatestemplate_idadd_fields_fields.rb +0 -1306
- data/spec/api_client_spec.rb +0 -226
- data/spec/configuration_spec.rb +0 -53
- data/spec/models/create_submission_data_request_token_response_token_spec.rb +0 -59
- data/spec/models/custom_file_spec.rb +0 -47
- data/spec/models/error_spec.rb +0 -51
- data/spec/models/folders_folder_spec.rb +0 -47
- data/spec/models/template1_defaults_spec.rb +0 -53
- data/spec/models/template1_spec.rb +0 -273
- data/spec/models/templatestemplate_idadd_fields_fields_spec.rb +0 -589
- data/spec/models/upload_template_data_document_metadata_spec.rb +0 -57
- data/spec/models/upload_template_data_document_spec.rb +0 -57
data/README.md
CHANGED
@@ -7,7 +7,8 @@ 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:
|
10
|
+
- Package version: 2.0.0
|
11
|
+
- Generator version: 7.11.0
|
11
12
|
- Build package: com.docspring.codegen.DocSpringRubyClientCodegen
|
12
13
|
|
13
14
|
## Installation
|
@@ -23,15 +24,16 @@ gem build docspring.gemspec
|
|
23
24
|
Then either install the gem locally:
|
24
25
|
|
25
26
|
```shell
|
26
|
-
gem install ./docspring-
|
27
|
+
gem install ./docspring-2.0.0.gem
|
27
28
|
```
|
28
|
-
|
29
|
+
|
30
|
+
(for development, run `gem install --dev ./docspring-2.0.0.gem` to install the development dependencies)
|
29
31
|
|
30
32
|
or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
|
31
33
|
|
32
34
|
Finally add this to the Gemfile:
|
33
35
|
|
34
|
-
gem 'docspring', '~>
|
36
|
+
gem 'docspring', '~> 2.0.0'
|
35
37
|
|
36
38
|
### Install from Git
|
37
39
|
|
@@ -50,6 +52,7 @@ ruby -Ilib script.rb
|
|
50
52
|
## Getting Started
|
51
53
|
|
52
54
|
Please follow the [installation](#installation) procedure and then run the following code:
|
55
|
+
|
53
56
|
```ruby
|
54
57
|
# Load the gem
|
55
58
|
require 'docspring'
|
@@ -57,17 +60,17 @@ require 'docspring'
|
|
57
60
|
# Setup authorization
|
58
61
|
DocSpring.configure do |config|
|
59
62
|
# Configure HTTP basic authorization: api_token_basic
|
60
|
-
config.username = '
|
61
|
-
config.password = '
|
63
|
+
config.username = 'YOUR_USERNAME'
|
64
|
+
config.password = 'YOUR_PASSWORD'
|
62
65
|
end
|
63
66
|
|
64
67
|
api_instance = DocSpring::PDFApi.new
|
65
68
|
template_id = 'tpl_000000000000000002' # String |
|
66
|
-
|
69
|
+
data = DocSpring::AddFieldsData.new({fields: [3.56]}) # AddFieldsData |
|
67
70
|
|
68
71
|
begin
|
69
72
|
#Add new fields to a Template
|
70
|
-
result = api_instance.add_fields_to_template(template_id,
|
73
|
+
result = api_instance.add_fields_to_template(template_id, data)
|
71
74
|
p result
|
72
75
|
rescue DocSpring::ApiError => e
|
73
76
|
puts "Exception when calling PDFApi->add_fields_to_template: #{e}"
|
@@ -88,15 +91,18 @@ Class | Method | HTTP request | Description
|
|
88
91
|
*DocSpring::PDFApi* | [**combine_submissions**](docs/PDFApi.md#combine_submissions) | **POST** /combined_submissions | Merge generated PDFs together
|
89
92
|
*DocSpring::PDFApi* | [**copy_template**](docs/PDFApi.md#copy_template) | **POST** /templates/{template_id}/copy | Copy a Template
|
90
93
|
*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
|
94
|
+
*DocSpring::PDFApi* | [**create_data_request_event**](docs/PDFApi.md#create_data_request_event) | **POST** /data_requests/{data_request_id}/events | Creates a new event for emailing a signee a request for signature
|
91
95
|
*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
|
92
96
|
*DocSpring::PDFApi* | [**create_folder**](docs/PDFApi.md#create_folder) | **POST** /folders/ | Create a folder
|
93
97
|
*DocSpring::PDFApi* | [**create_html_template**](docs/PDFApi.md#create_html_template) | **POST** /templates?desc=html | Create a new HTML template
|
94
98
|
*DocSpring::PDFApi* | [**create_pdf_template**](docs/PDFApi.md#create_pdf_template) | **POST** /templates | Create a new PDF template with a form POST file upload
|
95
99
|
*DocSpring::PDFApi* | [**create_pdf_template_from_upload**](docs/PDFApi.md#create_pdf_template_from_upload) | **POST** /templates?desc=cached_upload | Create a new PDF template from a cached presign upload
|
96
100
|
*DocSpring::PDFApi* | [**delete_folder**](docs/PDFApi.md#delete_folder) | **DELETE** /folders/{folder_id} | Delete a folder
|
101
|
+
*DocSpring::PDFApi* | [**delete_template**](docs/PDFApi.md#delete_template) | **DELETE** /templates/{template_id} | Delete a template
|
97
102
|
*DocSpring::PDFApi* | [**expire_combined_submission**](docs/PDFApi.md#expire_combined_submission) | **DELETE** /combined_submissions/{combined_submission_id} | Expire a combined submission
|
98
103
|
*DocSpring::PDFApi* | [**expire_submission**](docs/PDFApi.md#expire_submission) | **DELETE** /submissions/{submission_id} | Expire a PDF submission
|
99
104
|
*DocSpring::PDFApi* | [**generate_pdf**](docs/PDFApi.md#generate_pdf) | **POST** /templates/{template_id}/submissions | Generates a new PDF
|
105
|
+
*DocSpring::PDFApi* | [**generate_preview**](docs/PDFApi.md#generate_preview) | **POST** /submissions/{submission_id}/generate_preview | Generated a preview PDF for partially completed data requests
|
100
106
|
*DocSpring::PDFApi* | [**get_combined_submission**](docs/PDFApi.md#get_combined_submission) | **GET** /combined_submissions/{combined_submission_id} | Check the status of a combined submission (merged PDFs)
|
101
107
|
*DocSpring::PDFApi* | [**get_data_request**](docs/PDFApi.md#get_data_request) | **GET** /data_requests/{data_request_id} | Look up a submission data request
|
102
108
|
*DocSpring::PDFApi* | [**get_full_template**](docs/PDFApi.md#get_full_template) | **GET** /templates/{template_id}?full=true | Fetch the full template attributes
|
@@ -105,13 +111,16 @@ Class | Method | HTTP request | Description
|
|
105
111
|
*DocSpring::PDFApi* | [**get_submission_batch**](docs/PDFApi.md#get_submission_batch) | **GET** /submissions/batches/{submission_batch_id} | Check the status of a submission batch job
|
106
112
|
*DocSpring::PDFApi* | [**get_template**](docs/PDFApi.md#get_template) | **GET** /templates/{template_id} | Check the status of an uploaded template
|
107
113
|
*DocSpring::PDFApi* | [**get_template_schema**](docs/PDFApi.md#get_template_schema) | **GET** /templates/{template_id}/schema | Fetch the JSON schema for a template
|
114
|
+
*DocSpring::PDFApi* | [**list_combined_submissions**](docs/PDFApi.md#list_combined_submissions) | **GET** /combined_submissions | Get a list of all combined submissions
|
108
115
|
*DocSpring::PDFApi* | [**list_folders**](docs/PDFApi.md#list_folders) | **GET** /folders/ | Get a list of all folders
|
109
116
|
*DocSpring::PDFApi* | [**list_submissions**](docs/PDFApi.md#list_submissions) | **GET** /submissions | List all submissions
|
110
|
-
*DocSpring::PDFApi* | [**
|
117
|
+
*DocSpring::PDFApi* | [**list_template_submissions**](docs/PDFApi.md#list_template_submissions) | **GET** /templates/{template_id}/submissions | List all submissions for a given template
|
111
118
|
*DocSpring::PDFApi* | [**list_templates**](docs/PDFApi.md#list_templates) | **GET** /templates | Get a list of all templates
|
112
119
|
*DocSpring::PDFApi* | [**move_folder_to_folder**](docs/PDFApi.md#move_folder_to_folder) | **POST** /folders/{folder_id}/move | Move a folder
|
113
120
|
*DocSpring::PDFApi* | [**move_template_to_folder**](docs/PDFApi.md#move_template_to_folder) | **POST** /templates/{template_id}/move | Move Template to folder
|
121
|
+
*DocSpring::PDFApi* | [**publish_template_version**](docs/PDFApi.md#publish_template_version) | **POST** /templates/{template_id}/publish_version | Publish a template version
|
114
122
|
*DocSpring::PDFApi* | [**rename_folder**](docs/PDFApi.md#rename_folder) | **POST** /folders/{folder_id}/rename | Rename a folder
|
123
|
+
*DocSpring::PDFApi* | [**restore_template_version**](docs/PDFApi.md#restore_template_version) | **POST** /templates/{template_id}/restore_version | Restore a template version
|
115
124
|
*DocSpring::PDFApi* | [**test_authentication**](docs/PDFApi.md#test_authentication) | **GET** /authentication | Test Authentication
|
116
125
|
*DocSpring::PDFApi* | [**update_data_request**](docs/PDFApi.md#update_data_request) | **PUT** /data_requests/{data_request_id} | Update a submission data request
|
117
126
|
*DocSpring::PDFApi* | [**update_template**](docs/PDFApi.md#update_template) | **PUT** /templates/{template_id} | Update a Template
|
@@ -131,26 +140,40 @@ Class | Method | HTTP request | Description
|
|
131
140
|
- [DocSpring::CreateCombinedSubmissionResponse](docs/CreateCombinedSubmissionResponse.md)
|
132
141
|
- [DocSpring::CreateCustomFileData](docs/CreateCustomFileData.md)
|
133
142
|
- [DocSpring::CreateCustomFileResponse](docs/CreateCustomFileResponse.md)
|
143
|
+
- [DocSpring::CreateFolderAttributes](docs/CreateFolderAttributes.md)
|
134
144
|
- [DocSpring::CreateFolderData](docs/CreateFolderData.md)
|
135
145
|
- [DocSpring::CreateHtmlTemplateData](docs/CreateHtmlTemplateData.md)
|
136
146
|
- [DocSpring::CreateSubmissionBatchResponse](docs/CreateSubmissionBatchResponse.md)
|
137
147
|
- [DocSpring::CreateSubmissionBatchSubmissionsResponse](docs/CreateSubmissionBatchSubmissionsResponse.md)
|
148
|
+
- [DocSpring::CreateSubmissionData](docs/CreateSubmissionData.md)
|
138
149
|
- [DocSpring::CreateSubmissionDataRequestData](docs/CreateSubmissionDataRequestData.md)
|
150
|
+
- [DocSpring::CreateSubmissionDataRequestEventRequest](docs/CreateSubmissionDataRequestEventRequest.md)
|
151
|
+
- [DocSpring::CreateSubmissionDataRequestEventResponse](docs/CreateSubmissionDataRequestEventResponse.md)
|
139
152
|
- [DocSpring::CreateSubmissionDataRequestTokenResponse](docs/CreateSubmissionDataRequestTokenResponse.md)
|
140
|
-
- [DocSpring::CreateSubmissionDataRequestTokenResponseToken](docs/CreateSubmissionDataRequestTokenResponseToken.md)
|
141
153
|
- [DocSpring::CreateSubmissionResponse](docs/CreateSubmissionResponse.md)
|
142
154
|
- [DocSpring::CreateTemplateFromUploadData](docs/CreateTemplateFromUploadData.md)
|
143
|
-
- [DocSpring::
|
144
|
-
- [DocSpring::
|
155
|
+
- [DocSpring::DataRequestToken](docs/DataRequestToken.md)
|
156
|
+
- [DocSpring::DeleteTemplateResponse](docs/DeleteTemplateResponse.md)
|
157
|
+
- [DocSpring::ErrorResponse](docs/ErrorResponse.md)
|
145
158
|
- [DocSpring::Folder](docs/Folder.md)
|
146
|
-
- [DocSpring::
|
159
|
+
- [DocSpring::FullTemplate](docs/FullTemplate.md)
|
147
160
|
- [DocSpring::HtmlTemplateData](docs/HtmlTemplateData.md)
|
161
|
+
- [DocSpring::HtmlTemplateDataWebhookOptions](docs/HtmlTemplateDataWebhookOptions.md)
|
148
162
|
- [DocSpring::InvalidRequest](docs/InvalidRequest.md)
|
163
|
+
- [DocSpring::InvalidRequestSingleError](docs/InvalidRequestSingleError.md)
|
149
164
|
- [DocSpring::ListSubmissionsResponse](docs/ListSubmissionsResponse.md)
|
150
165
|
- [DocSpring::MoveFolderData](docs/MoveFolderData.md)
|
151
166
|
- [DocSpring::MoveTemplateData](docs/MoveTemplateData.md)
|
152
167
|
- [DocSpring::PendingTemplate](docs/PendingTemplate.md)
|
168
|
+
- [DocSpring::PreviewPdfResponse](docs/PreviewPdfResponse.md)
|
169
|
+
- [DocSpring::PublishTemplateVersion404Response](docs/PublishTemplateVersion404Response.md)
|
170
|
+
- [DocSpring::PublishTemplateVersion422Response](docs/PublishTemplateVersion422Response.md)
|
171
|
+
- [DocSpring::PublishTemplateVersionResponse](docs/PublishTemplateVersionResponse.md)
|
172
|
+
- [DocSpring::PublishTemplateVersionResponseResult](docs/PublishTemplateVersionResponseResult.md)
|
173
|
+
- [DocSpring::PublishVersionData](docs/PublishVersionData.md)
|
153
174
|
- [DocSpring::RenameFolderData](docs/RenameFolderData.md)
|
175
|
+
- [DocSpring::RestoreTemplateVersionResponse](docs/RestoreTemplateVersionResponse.md)
|
176
|
+
- [DocSpring::RestoreVersionData](docs/RestoreVersionData.md)
|
154
177
|
- [DocSpring::Submission](docs/Submission.md)
|
155
178
|
- [DocSpring::SubmissionAction](docs/SubmissionAction.md)
|
156
179
|
- [DocSpring::SubmissionBatch](docs/SubmissionBatch.md)
|
@@ -158,23 +181,25 @@ Class | Method | HTTP request | Description
|
|
158
181
|
- [DocSpring::SubmissionData](docs/SubmissionData.md)
|
159
182
|
- [DocSpring::SubmissionDataBatchRequest](docs/SubmissionDataBatchRequest.md)
|
160
183
|
- [DocSpring::SubmissionDataRequest](docs/SubmissionDataRequest.md)
|
184
|
+
- [DocSpring::SubmissionDataRequestEvent](docs/SubmissionDataRequestEvent.md)
|
161
185
|
- [DocSpring::Template](docs/Template.md)
|
162
|
-
- [DocSpring::Template1](docs/Template1.md)
|
163
|
-
- [DocSpring::Template1Defaults](docs/Template1Defaults.md)
|
164
186
|
- [DocSpring::TemplateData](docs/TemplateData.md)
|
165
|
-
- [DocSpring::
|
187
|
+
- [DocSpring::TemplateDefaults](docs/TemplateDefaults.md)
|
188
|
+
- [DocSpring::TemplateDocument](docs/TemplateDocument.md)
|
189
|
+
- [DocSpring::TemplateDocumentMetadata](docs/TemplateDocumentMetadata.md)
|
190
|
+
- [DocSpring::TemplateSchema](docs/TemplateSchema.md)
|
166
191
|
- [DocSpring::UpdateDataRequestResponse](docs/UpdateDataRequestResponse.md)
|
167
192
|
- [DocSpring::UpdateSubmissionDataRequestData](docs/UpdateSubmissionDataRequestData.md)
|
168
193
|
- [DocSpring::UpdateTemplateData](docs/UpdateTemplateData.md)
|
169
194
|
- [DocSpring::UpdateTemplateResponse](docs/UpdateTemplateResponse.md)
|
195
|
+
- [DocSpring::UploadPresign](docs/UploadPresign.md)
|
170
196
|
- [DocSpring::UploadTemplateData](docs/UploadTemplateData.md)
|
171
|
-
- [DocSpring::UploadTemplateDataDocument](docs/UploadTemplateDataDocument.md)
|
172
|
-
- [DocSpring::UploadTemplateDataDocumentMetadata](docs/UploadTemplateDataDocumentMetadata.md)
|
173
197
|
|
174
198
|
|
175
199
|
## Documentation for Authorization
|
176
200
|
|
177
201
|
|
202
|
+
Authentication schemes defined for the API:
|
178
203
|
### api_token_basic
|
179
204
|
|
180
205
|
- **Type**: HTTP basic authentication
|
data/docs/AddFieldsData.md
CHANGED
@@ -1,8 +1,18 @@
|
|
1
1
|
# DocSpring::AddFieldsData
|
2
2
|
|
3
3
|
## Properties
|
4
|
-
Name | Type | Description | Notes
|
5
|
-
------------ | ------------- | ------------- | -------------
|
6
|
-
**fields** | [**Array<TemplatestemplateIdaddFieldsFields>**](TemplatestemplateIdaddFieldsFields.md) | |
|
7
4
|
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **fields** | **Array<Object>** | | |
|
8
|
+
|
9
|
+
## Example
|
10
|
+
|
11
|
+
```ruby
|
12
|
+
require 'docspring'
|
13
|
+
|
14
|
+
instance = DocSpring::AddFieldsData.new(
|
15
|
+
fields: null
|
16
|
+
)
|
17
|
+
```
|
8
18
|
|
@@ -1,10 +1,22 @@
|
|
1
1
|
# DocSpring::AddFieldsTemplateResponse
|
2
2
|
|
3
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
4
|
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **status** | **String** | | |
|
8
|
+
| **errors** | **Array<String>** | | [optional] |
|
9
|
+
| **new_field_ids** | **Array<Integer>** | | [optional] |
|
10
|
+
|
11
|
+
## Example
|
12
|
+
|
13
|
+
```ruby
|
14
|
+
require 'docspring'
|
15
|
+
|
16
|
+
instance = DocSpring::AddFieldsTemplateResponse.new(
|
17
|
+
status: null,
|
18
|
+
errors: null,
|
19
|
+
new_field_ids: null
|
20
|
+
)
|
21
|
+
```
|
10
22
|
|
data/docs/AuthenticationError.md
CHANGED
@@ -1,9 +1,20 @@
|
|
1
1
|
# DocSpring::AuthenticationError
|
2
2
|
|
3
3
|
## Properties
|
4
|
-
Name | Type | Description | Notes
|
5
|
-
------------ | ------------- | ------------- | -------------
|
6
|
-
**status** | **String** | | [optional]
|
7
|
-
**error** | **String** | |
|
8
4
|
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **status** | **String** | | [optional] |
|
8
|
+
| **error** | **String** | | |
|
9
|
+
|
10
|
+
## Example
|
11
|
+
|
12
|
+
```ruby
|
13
|
+
require 'docspring'
|
14
|
+
|
15
|
+
instance = DocSpring::AuthenticationError.new(
|
16
|
+
status: null,
|
17
|
+
error: null
|
18
|
+
)
|
19
|
+
```
|
9
20
|
|
@@ -1,8 +1,18 @@
|
|
1
1
|
# DocSpring::AuthenticationSuccessResponse
|
2
2
|
|
3
3
|
## Properties
|
4
|
-
Name | Type | Description | Notes
|
5
|
-
------------ | ------------- | ------------- | -------------
|
6
|
-
**status** | **String** | | [optional]
|
7
4
|
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **status** | **String** | | |
|
8
|
+
|
9
|
+
## Example
|
10
|
+
|
11
|
+
```ruby
|
12
|
+
require 'docspring'
|
13
|
+
|
14
|
+
instance = DocSpring::AuthenticationSuccessResponse.new(
|
15
|
+
status: null
|
16
|
+
)
|
17
|
+
```
|
8
18
|
|
data/docs/CombinePdfsData.md
CHANGED
@@ -1,13 +1,28 @@
|
|
1
1
|
# DocSpring::CombinePdfsData
|
2
2
|
|
3
3
|
## Properties
|
4
|
-
Name | Type | Description | Notes
|
5
|
-
------------ | ------------- | ------------- | -------------
|
6
|
-
**delete_custom_files** | **BOOLEAN** | | [optional]
|
7
|
-
**expires_in** | **Integer** | | [optional]
|
8
|
-
**metadata** | **Object** | | [optional]
|
9
|
-
**password** | **String** | | [optional]
|
10
|
-
**source_pdfs** | **Array<Object>** | |
|
11
|
-
**test** | **BOOLEAN** | | [optional]
|
12
4
|
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **delete_custom_files** | **Boolean** | | [optional] |
|
8
|
+
| **expires_in** | **Integer** | | [optional] |
|
9
|
+
| **metadata** | **Object** | | [optional] |
|
10
|
+
| **password** | **String** | | [optional] |
|
11
|
+
| **source_pdfs** | **Array<Object>** | | |
|
12
|
+
| **test** | **Boolean** | | [optional] |
|
13
|
+
|
14
|
+
## Example
|
15
|
+
|
16
|
+
```ruby
|
17
|
+
require 'docspring'
|
18
|
+
|
19
|
+
instance = DocSpring::CombinePdfsData.new(
|
20
|
+
delete_custom_files: null,
|
21
|
+
expires_in: null,
|
22
|
+
metadata: null,
|
23
|
+
password: null,
|
24
|
+
source_pdfs: null,
|
25
|
+
test: null
|
26
|
+
)
|
27
|
+
```
|
13
28
|
|
data/docs/CombinedSubmission.md
CHANGED
@@ -1,18 +1,42 @@
|
|
1
1
|
# DocSpring::CombinedSubmission
|
2
2
|
|
3
3
|
## Properties
|
4
|
-
Name | Type | Description | Notes
|
5
|
-
------------ | ------------- | ------------- | -------------
|
6
|
-
**metadata** | **Object** | | [optional]
|
7
|
-
**password** | **String** | | [optional]
|
8
|
-
**expired** | **BOOLEAN** | | [optional]
|
9
|
-
**expires_at** | **String** | | [optional]
|
10
|
-
**source_pdfs** | **Array<Object>** | | [optional]
|
11
|
-
**pdf_hash** | **String** | | [optional]
|
12
|
-
**download_url** | **String** | | [optional]
|
13
|
-
**submission_ids** | **Array<String>** | | [optional]
|
14
|
-
**id** | **String** | | [optional]
|
15
|
-
**state** | **String** | | [optional]
|
16
|
-
**actions** | [**Array<CombinedSubmissionAction>**](CombinedSubmissionAction.md) | | [optional]
|
17
4
|
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **id** | **String** | | |
|
8
|
+
| **expired** | **Boolean** | | |
|
9
|
+
| **expires_in** | **Integer** | | [optional] |
|
10
|
+
| **expires_at** | **String** | | [optional] |
|
11
|
+
| **state** | **String** | | |
|
12
|
+
| **error_message** | **String** | | [optional] |
|
13
|
+
| **metadata** | **Object** | | [optional] |
|
14
|
+
| **password** | **String** | | [optional] |
|
15
|
+
| **submission_ids** | **Array<String>** | | |
|
16
|
+
| **source_pdfs** | **Array<Object>** | | |
|
17
|
+
| **download_url** | **String** | | [optional] |
|
18
|
+
| **pdf_hash** | **String** | | [optional] |
|
19
|
+
| **actions** | [**Array<CombinedSubmissionAction>**](CombinedSubmissionAction.md) | | [optional] |
|
20
|
+
|
21
|
+
## Example
|
22
|
+
|
23
|
+
```ruby
|
24
|
+
require 'docspring'
|
25
|
+
|
26
|
+
instance = DocSpring::CombinedSubmission.new(
|
27
|
+
id: null,
|
28
|
+
expired: null,
|
29
|
+
expires_in: null,
|
30
|
+
expires_at: null,
|
31
|
+
state: null,
|
32
|
+
error_message: null,
|
33
|
+
metadata: null,
|
34
|
+
password: null,
|
35
|
+
submission_ids: null,
|
36
|
+
source_pdfs: null,
|
37
|
+
download_url: null,
|
38
|
+
pdf_hash: null,
|
39
|
+
actions: null
|
40
|
+
)
|
41
|
+
```
|
18
42
|
|
@@ -1,13 +1,28 @@
|
|
1
1
|
# DocSpring::CombinedSubmissionAction
|
2
2
|
|
3
3
|
## Properties
|
4
|
-
Name | Type | Description | Notes
|
5
|
-
------------ | ------------- | ------------- | -------------
|
6
|
-
**id** | **String** | |
|
7
|
-
**integration_id** | **String** | |
|
8
|
-
**state** | **String** | |
|
9
|
-
**action_category** | **String** | |
|
10
|
-
**action_type** | **String** | |
|
11
|
-
**result_data** | **Object** | |
|
12
4
|
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **id** | **String** | | |
|
8
|
+
| **integration_id** | **String** | | |
|
9
|
+
| **state** | **String** | | |
|
10
|
+
| **action_category** | **String** | | |
|
11
|
+
| **action_type** | **String** | | |
|
12
|
+
| **result_data** | **Object** | | |
|
13
|
+
|
14
|
+
## Example
|
15
|
+
|
16
|
+
```ruby
|
17
|
+
require 'docspring'
|
18
|
+
|
19
|
+
instance = DocSpring::CombinedSubmissionAction.new(
|
20
|
+
id: null,
|
21
|
+
integration_id: null,
|
22
|
+
state: null,
|
23
|
+
action_category: null,
|
24
|
+
action_type: null,
|
25
|
+
result_data: null
|
26
|
+
)
|
27
|
+
```
|
13
28
|
|
@@ -1,12 +1,26 @@
|
|
1
1
|
# DocSpring::CombinedSubmissionData
|
2
2
|
|
3
3
|
## Properties
|
4
|
-
Name | Type | Description | Notes
|
5
|
-
------------ | ------------- | ------------- | -------------
|
6
|
-
**expires_in** | **Integer** | | [optional]
|
7
|
-
**metadata** | **Object** | | [optional]
|
8
|
-
**password** | **String** | | [optional]
|
9
|
-
**submission_ids** | **Array<String>** | |
|
10
|
-
**test** | **BOOLEAN** | | [optional]
|
11
4
|
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **expires_in** | **Integer** | | [optional] |
|
8
|
+
| **metadata** | **Object** | | [optional] |
|
9
|
+
| **password** | **String** | | [optional] |
|
10
|
+
| **submission_ids** | **Array<String>** | | |
|
11
|
+
| **test** | **Boolean** | | [optional] |
|
12
|
+
|
13
|
+
## Example
|
14
|
+
|
15
|
+
```ruby
|
16
|
+
require 'docspring'
|
17
|
+
|
18
|
+
instance = DocSpring::CombinedSubmissionData.new(
|
19
|
+
expires_in: null,
|
20
|
+
metadata: null,
|
21
|
+
password: null,
|
22
|
+
submission_ids: null,
|
23
|
+
test: null
|
24
|
+
)
|
25
|
+
```
|
12
26
|
|
data/docs/CopyTemplateData.md
CHANGED
@@ -1,9 +1,20 @@
|
|
1
1
|
# DocSpring::CopyTemplateData
|
2
2
|
|
3
3
|
## Properties
|
4
|
-
Name | Type | Description | Notes
|
5
|
-
------------ | ------------- | ------------- | -------------
|
6
|
-
**name** | **String** | | [optional]
|
7
|
-
**parent_folder_id** | **String** | |
|
8
4
|
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **name** | **String** | | [optional] |
|
8
|
+
| **parent_folder_id** | **String** | | |
|
9
|
+
|
10
|
+
## Example
|
11
|
+
|
12
|
+
```ruby
|
13
|
+
require 'docspring'
|
14
|
+
|
15
|
+
instance = DocSpring::CopyTemplateData.new(
|
16
|
+
name: null,
|
17
|
+
parent_folder_id: null
|
18
|
+
)
|
19
|
+
```
|
9
20
|
|
@@ -1,10 +1,22 @@
|
|
1
1
|
# DocSpring::CreateCombinedSubmissionResponse
|
2
2
|
|
3
3
|
## Properties
|
4
|
-
Name | Type | Description | Notes
|
5
|
-
------------ | ------------- | ------------- | -------------
|
6
|
-
**combined_submission** | [**CombinedSubmission**](CombinedSubmission.md) | | [optional]
|
7
|
-
**errors** | **Array<String>** | | [optional]
|
8
|
-
**status** | **String** | | [optional]
|
9
4
|
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **status** | **String** | | |
|
8
|
+
| **errors** | **Array<String>** | | [optional] |
|
9
|
+
| **combined_submission** | [**CombinedSubmission**](CombinedSubmission.md) | | |
|
10
|
+
|
11
|
+
## Example
|
12
|
+
|
13
|
+
```ruby
|
14
|
+
require 'docspring'
|
15
|
+
|
16
|
+
instance = DocSpring::CreateCombinedSubmissionResponse.new(
|
17
|
+
status: null,
|
18
|
+
errors: null,
|
19
|
+
combined_submission: null
|
20
|
+
)
|
21
|
+
```
|
10
22
|
|
@@ -1,8 +1,18 @@
|
|
1
1
|
# DocSpring::CreateCustomFileData
|
2
2
|
|
3
3
|
## Properties
|
4
|
-
Name | Type | Description | Notes
|
5
|
-
------------ | ------------- | ------------- | -------------
|
6
|
-
**cache_id** | **String** | |
|
7
4
|
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **cache_id** | **String** | | |
|
8
|
+
|
9
|
+
## Example
|
10
|
+
|
11
|
+
```ruby
|
12
|
+
require 'docspring'
|
13
|
+
|
14
|
+
instance = DocSpring::CreateCustomFileData.new(
|
15
|
+
cache_id: null
|
16
|
+
)
|
17
|
+
```
|
8
18
|
|
@@ -1,10 +1,22 @@
|
|
1
1
|
# DocSpring::CreateCustomFileResponse
|
2
2
|
|
3
3
|
## Properties
|
4
|
-
Name | Type | Description | Notes
|
5
|
-
------------ | ------------- | ------------- | -------------
|
6
|
-
**custom_file** | [**CustomFile**](CustomFile.md) | | [optional]
|
7
|
-
**errors** | **Array<String>** | | [optional]
|
8
|
-
**status** | **String** | | [optional]
|
9
4
|
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **status** | **String** | | |
|
8
|
+
| **errors** | **Array<String>** | | [optional] |
|
9
|
+
| **custom_file** | **Object** | | |
|
10
|
+
|
11
|
+
## Example
|
12
|
+
|
13
|
+
```ruby
|
14
|
+
require 'docspring'
|
15
|
+
|
16
|
+
instance = DocSpring::CreateCustomFileResponse.new(
|
17
|
+
status: null,
|
18
|
+
errors: null,
|
19
|
+
custom_file: null
|
20
|
+
)
|
21
|
+
```
|
10
22
|
|
@@ -0,0 +1,20 @@
|
|
1
|
+
# DocSpring::CreateFolderAttributes
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **name** | **String** | | |
|
8
|
+
| **parent_folder_id** | **String** | | [optional] |
|
9
|
+
|
10
|
+
## Example
|
11
|
+
|
12
|
+
```ruby
|
13
|
+
require 'docspring'
|
14
|
+
|
15
|
+
instance = DocSpring::CreateFolderAttributes.new(
|
16
|
+
name: null,
|
17
|
+
parent_folder_id: null
|
18
|
+
)
|
19
|
+
```
|
20
|
+
|
data/docs/CreateFolderData.md
CHANGED
@@ -1,8 +1,18 @@
|
|
1
1
|
# DocSpring::CreateFolderData
|
2
2
|
|
3
3
|
## Properties
|
4
|
-
Name | Type | Description | Notes
|
5
|
-
------------ | ------------- | ------------- | -------------
|
6
|
-
**folder** | [**FoldersFolder**](FoldersFolder.md) | |
|
7
4
|
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **folder** | [**CreateFolderAttributes**](CreateFolderAttributes.md) | | |
|
8
|
+
|
9
|
+
## Example
|
10
|
+
|
11
|
+
```ruby
|
12
|
+
require 'docspring'
|
13
|
+
|
14
|
+
instance = DocSpring::CreateFolderData.new(
|
15
|
+
folder: null
|
16
|
+
)
|
17
|
+
```
|
8
18
|
|
@@ -1,8 +1,18 @@
|
|
1
1
|
# DocSpring::CreateHtmlTemplateData
|
2
2
|
|
3
3
|
## Properties
|
4
|
-
Name | Type | Description | Notes
|
5
|
-
------------ | ------------- | ------------- | -------------
|
6
|
-
**template** | [**HtmlTemplateData**](HtmlTemplateData.md) | |
|
7
4
|
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **template** | [**HtmlTemplateData**](HtmlTemplateData.md) | | |
|
8
|
+
|
9
|
+
## Example
|
10
|
+
|
11
|
+
```ruby
|
12
|
+
require 'docspring'
|
13
|
+
|
14
|
+
instance = DocSpring::CreateHtmlTemplateData.new(
|
15
|
+
template: null
|
16
|
+
)
|
17
|
+
```
|
8
18
|
|
@@ -1,12 +1,26 @@
|
|
1
1
|
# DocSpring::CreateSubmissionBatchResponse
|
2
2
|
|
3
3
|
## Properties
|
4
|
-
Name | Type | Description | Notes
|
5
|
-
------------ | ------------- | ------------- | -------------
|
6
|
-
**submission_batch** | [**SubmissionBatch**](SubmissionBatch.md) | | [optional]
|
7
|
-
**submissions** | [**Array<CreateSubmissionBatchSubmissionsResponse>**](CreateSubmissionBatchSubmissionsResponse.md) | | [optional]
|
8
|
-
**error** | **String** | | [optional]
|
9
|
-
**errors** | **Array<String>** | | [optional]
|
10
|
-
**status** | **String** | | [optional]
|
11
4
|
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **status** | **String** | | |
|
8
|
+
| **error** | **String** | | [optional] |
|
9
|
+
| **errors** | **Array<String>** | | [optional] |
|
10
|
+
| **submission_batch** | [**SubmissionBatch**](SubmissionBatch.md) | | |
|
11
|
+
| **submissions** | [**Array<CreateSubmissionBatchSubmissionsResponse>**](CreateSubmissionBatchSubmissionsResponse.md) | | |
|
12
|
+
|
13
|
+
## Example
|
14
|
+
|
15
|
+
```ruby
|
16
|
+
require 'docspring'
|
17
|
+
|
18
|
+
instance = DocSpring::CreateSubmissionBatchResponse.new(
|
19
|
+
status: null,
|
20
|
+
error: null,
|
21
|
+
errors: null,
|
22
|
+
submission_batch: null,
|
23
|
+
submissions: null
|
24
|
+
)
|
25
|
+
```
|
12
26
|
|
@@ -1,10 +1,22 @@
|
|
1
1
|
# DocSpring::CreateSubmissionBatchSubmissionsResponse
|
2
2
|
|
3
3
|
## Properties
|
4
|
-
Name | Type | Description | Notes
|
5
|
-
------------ | ------------- | ------------- | -------------
|
6
|
-
**submission** | [**Submission**](Submission.md) | | [optional]
|
7
|
-
**errors** | **Array<String>** | | [optional]
|
8
|
-
**status** | **String** | | [optional]
|
9
4
|
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **status** | **String** | | |
|
8
|
+
| **errors** | **Array<String>** | | [optional] |
|
9
|
+
| **submission** | [**Submission**](Submission.md) | | [optional] |
|
10
|
+
|
11
|
+
## Example
|
12
|
+
|
13
|
+
```ruby
|
14
|
+
require 'docspring'
|
15
|
+
|
16
|
+
instance = DocSpring::CreateSubmissionBatchSubmissionsResponse.new(
|
17
|
+
status: null,
|
18
|
+
errors: null,
|
19
|
+
submission: null
|
20
|
+
)
|
21
|
+
```
|
10
22
|
|