docspring 1.4.1 → 2.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- 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/docs/PDFApi.md
CHANGED
|
@@ -2,52 +2,60 @@
|
|
|
2
2
|
|
|
3
3
|
All URIs are relative to *https://api.docspring.com/api/v1*
|
|
4
4
|
|
|
5
|
-
Method | HTTP request | Description
|
|
6
|
-
|
|
7
|
-
[**add_fields_to_template**](PDFApi.md#add_fields_to_template) | **PUT** /templates/{template_id}/add_fields | Add new fields to a Template
|
|
8
|
-
[**batch_generate_pdf_v1**](PDFApi.md#batch_generate_pdf_v1) | **POST** /templates/{template_id}/submissions/batch | Generates multiple PDFs
|
|
9
|
-
[**batch_generate_pdfs**](PDFApi.md#batch_generate_pdfs) | **POST** /submissions/batches | Generates multiple PDFs
|
|
10
|
-
[**combine_pdfs**](PDFApi.md#combine_pdfs) | **POST** /combined_submissions?v=2 | Merge submission PDFs, template PDFs, or custom files
|
|
11
|
-
[**combine_submissions**](PDFApi.md#combine_submissions) | **POST** /combined_submissions | Merge generated PDFs together
|
|
12
|
-
[**copy_template**](PDFApi.md#copy_template) | **POST** /templates/{template_id}/copy | Copy a Template
|
|
13
|
-
[**create_custom_file_from_upload**](PDFApi.md#create_custom_file_from_upload) | **POST** /custom_files | Create a new custom file from a cached presign upload
|
|
14
|
-
[**
|
|
15
|
-
[**
|
|
16
|
-
[**
|
|
17
|
-
[**
|
|
18
|
-
[**
|
|
19
|
-
[**
|
|
20
|
-
[**
|
|
21
|
-
[**
|
|
22
|
-
[**
|
|
23
|
-
[**
|
|
24
|
-
[**
|
|
25
|
-
[**
|
|
26
|
-
[**
|
|
27
|
-
[**
|
|
28
|
-
[**
|
|
29
|
-
[**
|
|
30
|
-
[**
|
|
31
|
-
[**
|
|
32
|
-
[**
|
|
33
|
-
[**
|
|
34
|
-
[**
|
|
35
|
-
[**
|
|
36
|
-
[**
|
|
37
|
-
[**
|
|
38
|
-
[**
|
|
39
|
-
[**
|
|
40
|
-
[**
|
|
41
|
-
|
|
42
|
-
|
|
43
|
-
# **
|
|
44
|
-
|
|
5
|
+
| Method | HTTP request | Description |
|
|
6
|
+
| ------ | ------------ | ----------- |
|
|
7
|
+
| [**add_fields_to_template**](PDFApi.md#add_fields_to_template) | **PUT** /templates/{template_id}/add_fields | Add new fields to a Template |
|
|
8
|
+
| [**batch_generate_pdf_v1**](PDFApi.md#batch_generate_pdf_v1) | **POST** /templates/{template_id}/submissions/batch | Generates multiple PDFs |
|
|
9
|
+
| [**batch_generate_pdfs**](PDFApi.md#batch_generate_pdfs) | **POST** /submissions/batches | Generates multiple PDFs |
|
|
10
|
+
| [**combine_pdfs**](PDFApi.md#combine_pdfs) | **POST** /combined_submissions?v=2 | Merge submission PDFs, template PDFs, or custom files |
|
|
11
|
+
| [**combine_submissions**](PDFApi.md#combine_submissions) | **POST** /combined_submissions | Merge generated PDFs together |
|
|
12
|
+
| [**copy_template**](PDFApi.md#copy_template) | **POST** /templates/{template_id}/copy | Copy a Template |
|
|
13
|
+
| [**create_custom_file_from_upload**](PDFApi.md#create_custom_file_from_upload) | **POST** /custom_files | Create a new custom file from a cached presign upload |
|
|
14
|
+
| [**create_data_request_event**](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 |
|
|
15
|
+
| [**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 |
|
|
16
|
+
| [**create_folder**](PDFApi.md#create_folder) | **POST** /folders/ | Create a folder |
|
|
17
|
+
| [**create_html_template**](PDFApi.md#create_html_template) | **POST** /templates?desc=html | Create a new HTML template |
|
|
18
|
+
| [**create_pdf_template**](PDFApi.md#create_pdf_template) | **POST** /templates | Create a new PDF template with a form POST file upload |
|
|
19
|
+
| [**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 |
|
|
20
|
+
| [**delete_folder**](PDFApi.md#delete_folder) | **DELETE** /folders/{folder_id} | Delete a folder |
|
|
21
|
+
| [**delete_template**](PDFApi.md#delete_template) | **DELETE** /templates/{template_id} | Delete a template |
|
|
22
|
+
| [**expire_combined_submission**](PDFApi.md#expire_combined_submission) | **DELETE** /combined_submissions/{combined_submission_id} | Expire a combined submission |
|
|
23
|
+
| [**expire_submission**](PDFApi.md#expire_submission) | **DELETE** /submissions/{submission_id} | Expire a PDF submission |
|
|
24
|
+
| [**generate_pdf**](PDFApi.md#generate_pdf) | **POST** /templates/{template_id}/submissions | Generates a new PDF |
|
|
25
|
+
| [**generate_preview**](PDFApi.md#generate_preview) | **POST** /submissions/{submission_id}/generate_preview | Generated a preview PDF for partially completed data requests |
|
|
26
|
+
| [**get_combined_submission**](PDFApi.md#get_combined_submission) | **GET** /combined_submissions/{combined_submission_id} | Check the status of a combined submission (merged PDFs) |
|
|
27
|
+
| [**get_data_request**](PDFApi.md#get_data_request) | **GET** /data_requests/{data_request_id} | Look up a submission data request |
|
|
28
|
+
| [**get_full_template**](PDFApi.md#get_full_template) | **GET** /templates/{template_id}?full=true | Fetch the full template attributes |
|
|
29
|
+
| [**get_presign_url**](PDFApi.md#get_presign_url) | **GET** /uploads/presign | Get a presigned URL so that you can upload a file to our AWS S3 bucket |
|
|
30
|
+
| [**get_submission**](PDFApi.md#get_submission) | **GET** /submissions/{submission_id} | Check the status of a PDF |
|
|
31
|
+
| [**get_submission_batch**](PDFApi.md#get_submission_batch) | **GET** /submissions/batches/{submission_batch_id} | Check the status of a submission batch job |
|
|
32
|
+
| [**get_template**](PDFApi.md#get_template) | **GET** /templates/{template_id} | Check the status of an uploaded template |
|
|
33
|
+
| [**get_template_schema**](PDFApi.md#get_template_schema) | **GET** /templates/{template_id}/schema | Fetch the JSON schema for a template |
|
|
34
|
+
| [**list_combined_submissions**](PDFApi.md#list_combined_submissions) | **GET** /combined_submissions | Get a list of all combined submissions |
|
|
35
|
+
| [**list_folders**](PDFApi.md#list_folders) | **GET** /folders/ | Get a list of all folders |
|
|
36
|
+
| [**list_submissions**](PDFApi.md#list_submissions) | **GET** /submissions | List all submissions |
|
|
37
|
+
| [**list_template_submissions**](PDFApi.md#list_template_submissions) | **GET** /templates/{template_id}/submissions | List all submissions for a given template |
|
|
38
|
+
| [**list_templates**](PDFApi.md#list_templates) | **GET** /templates | Get a list of all templates |
|
|
39
|
+
| [**move_folder_to_folder**](PDFApi.md#move_folder_to_folder) | **POST** /folders/{folder_id}/move | Move a folder |
|
|
40
|
+
| [**move_template_to_folder**](PDFApi.md#move_template_to_folder) | **POST** /templates/{template_id}/move | Move Template to folder |
|
|
41
|
+
| [**publish_template_version**](PDFApi.md#publish_template_version) | **POST** /templates/{template_id}/publish_version | Publish a template version |
|
|
42
|
+
| [**rename_folder**](PDFApi.md#rename_folder) | **POST** /folders/{folder_id}/rename | Rename a folder |
|
|
43
|
+
| [**restore_template_version**](PDFApi.md#restore_template_version) | **POST** /templates/{template_id}/restore_version | Restore a template version |
|
|
44
|
+
| [**test_authentication**](PDFApi.md#test_authentication) | **GET** /authentication | Test Authentication |
|
|
45
|
+
| [**update_data_request**](PDFApi.md#update_data_request) | **PUT** /data_requests/{data_request_id} | Update a submission data request |
|
|
46
|
+
| [**update_template**](PDFApi.md#update_template) | **PUT** /templates/{template_id} | Update a Template |
|
|
47
|
+
|
|
48
|
+
|
|
49
|
+
## add_fields_to_template
|
|
50
|
+
|
|
51
|
+
> <AddFieldsTemplateResponse> add_fields_to_template(template_id, data)
|
|
45
52
|
|
|
46
53
|
Add new fields to a Template
|
|
47
54
|
|
|
48
|
-
###
|
|
55
|
+
### Examples
|
|
56
|
+
|
|
49
57
|
```ruby
|
|
50
|
-
|
|
58
|
+
require 'time'
|
|
51
59
|
require 'docspring'
|
|
52
60
|
# setup authorization
|
|
53
61
|
DocSpring.configure do |config|
|
|
@@ -58,23 +66,41 @@ end
|
|
|
58
66
|
|
|
59
67
|
api_instance = DocSpring::PDFApi.new
|
|
60
68
|
template_id = 'tpl_000000000000000002' # String |
|
|
61
|
-
|
|
69
|
+
data = DocSpring::AddFieldsData.new({fields: [3.56]}) # AddFieldsData |
|
|
62
70
|
|
|
63
71
|
begin
|
|
64
|
-
#Add new fields to a Template
|
|
65
|
-
result = api_instance.add_fields_to_template(template_id,
|
|
72
|
+
# Add new fields to a Template
|
|
73
|
+
result = api_instance.add_fields_to_template(template_id, data)
|
|
66
74
|
p result
|
|
67
75
|
rescue DocSpring::ApiError => e
|
|
68
|
-
puts "
|
|
76
|
+
puts "Error when calling PDFApi->add_fields_to_template: #{e}"
|
|
77
|
+
end
|
|
78
|
+
```
|
|
79
|
+
|
|
80
|
+
#### Using the add_fields_to_template_with_http_info variant
|
|
81
|
+
|
|
82
|
+
This returns an Array which contains the response data, status code and headers.
|
|
83
|
+
|
|
84
|
+
> <Array(<AddFieldsTemplateResponse>, Integer, Hash)> add_fields_to_template_with_http_info(template_id, data)
|
|
85
|
+
|
|
86
|
+
```ruby
|
|
87
|
+
begin
|
|
88
|
+
# Add new fields to a Template
|
|
89
|
+
data, status_code, headers = api_instance.add_fields_to_template_with_http_info(template_id, data)
|
|
90
|
+
p status_code # => 2xx
|
|
91
|
+
p headers # => { ... }
|
|
92
|
+
p data # => <AddFieldsTemplateResponse>
|
|
93
|
+
rescue DocSpring::ApiError => e
|
|
94
|
+
puts "Error when calling PDFApi->add_fields_to_template_with_http_info: #{e}"
|
|
69
95
|
end
|
|
70
96
|
```
|
|
71
97
|
|
|
72
98
|
### Parameters
|
|
73
99
|
|
|
74
|
-
Name | Type | Description
|
|
75
|
-
|
|
76
|
-
**template_id** | **String
|
|
77
|
-
**
|
|
100
|
+
| Name | Type | Description | Notes |
|
|
101
|
+
| ---- | ---- | ----------- | ----- |
|
|
102
|
+
| **template_id** | **String** | | |
|
|
103
|
+
| **data** | [**AddFieldsData**](AddFieldsData.md) | | |
|
|
78
104
|
|
|
79
105
|
### Return type
|
|
80
106
|
|
|
@@ -86,19 +112,20 @@ Name | Type | Description | Notes
|
|
|
86
112
|
|
|
87
113
|
### HTTP request headers
|
|
88
114
|
|
|
89
|
-
|
|
90
|
-
|
|
115
|
+
- **Content-Type**: application/json
|
|
116
|
+
- **Accept**: application/json
|
|
91
117
|
|
|
92
118
|
|
|
119
|
+
## batch_generate_pdf_v1
|
|
93
120
|
|
|
94
|
-
|
|
95
|
-
> Array<CreateSubmissionResponse> batch_generate_pdf_v1(template_id, request_body)
|
|
121
|
+
> <Array<CreateSubmissionResponse>> batch_generate_pdf_v1(template_id, data)
|
|
96
122
|
|
|
97
123
|
Generates multiple PDFs
|
|
98
124
|
|
|
99
|
-
###
|
|
125
|
+
### Examples
|
|
126
|
+
|
|
100
127
|
```ruby
|
|
101
|
-
|
|
128
|
+
require 'time'
|
|
102
129
|
require 'docspring'
|
|
103
130
|
# setup authorization
|
|
104
131
|
DocSpring.configure do |config|
|
|
@@ -109,23 +136,41 @@ end
|
|
|
109
136
|
|
|
110
137
|
api_instance = DocSpring::PDFApi.new
|
|
111
138
|
template_id = 'tpl_000000000000000001' # String |
|
|
112
|
-
|
|
139
|
+
data = [DocSpring::SubmissionData.new({data: 3.56})] # Array<SubmissionData> |
|
|
113
140
|
|
|
114
141
|
begin
|
|
115
|
-
#Generates multiple PDFs
|
|
116
|
-
result = api_instance.batch_generate_pdf_v1(template_id,
|
|
142
|
+
# Generates multiple PDFs
|
|
143
|
+
result = api_instance.batch_generate_pdf_v1(template_id, data)
|
|
117
144
|
p result
|
|
118
145
|
rescue DocSpring::ApiError => e
|
|
119
|
-
puts "
|
|
146
|
+
puts "Error when calling PDFApi->batch_generate_pdf_v1: #{e}"
|
|
147
|
+
end
|
|
148
|
+
```
|
|
149
|
+
|
|
150
|
+
#### Using the batch_generate_pdf_v1_with_http_info variant
|
|
151
|
+
|
|
152
|
+
This returns an Array which contains the response data, status code and headers.
|
|
153
|
+
|
|
154
|
+
> <Array(<Array<CreateSubmissionResponse>>, Integer, Hash)> batch_generate_pdf_v1_with_http_info(template_id, data)
|
|
155
|
+
|
|
156
|
+
```ruby
|
|
157
|
+
begin
|
|
158
|
+
# Generates multiple PDFs
|
|
159
|
+
data, status_code, headers = api_instance.batch_generate_pdf_v1_with_http_info(template_id, data)
|
|
160
|
+
p status_code # => 2xx
|
|
161
|
+
p headers # => { ... }
|
|
162
|
+
p data # => <Array<CreateSubmissionResponse>>
|
|
163
|
+
rescue DocSpring::ApiError => e
|
|
164
|
+
puts "Error when calling PDFApi->batch_generate_pdf_v1_with_http_info: #{e}"
|
|
120
165
|
end
|
|
121
166
|
```
|
|
122
167
|
|
|
123
168
|
### Parameters
|
|
124
169
|
|
|
125
|
-
Name | Type | Description
|
|
126
|
-
|
|
127
|
-
**template_id** | **String
|
|
128
|
-
**
|
|
170
|
+
| Name | Type | Description | Notes |
|
|
171
|
+
| ---- | ---- | ----------- | ----- |
|
|
172
|
+
| **template_id** | **String** | | |
|
|
173
|
+
| **data** | [**Array<SubmissionData>**](SubmissionData.md) | | |
|
|
129
174
|
|
|
130
175
|
### Return type
|
|
131
176
|
|
|
@@ -137,19 +182,20 @@ Name | Type | Description | Notes
|
|
|
137
182
|
|
|
138
183
|
### HTTP request headers
|
|
139
184
|
|
|
140
|
-
|
|
141
|
-
|
|
185
|
+
- **Content-Type**: application/json
|
|
186
|
+
- **Accept**: application/json
|
|
142
187
|
|
|
143
188
|
|
|
189
|
+
## batch_generate_pdfs
|
|
144
190
|
|
|
145
|
-
|
|
146
|
-
> CreateSubmissionBatchResponse batch_generate_pdfs(submission_batch_data)
|
|
191
|
+
> <CreateSubmissionBatchResponse> batch_generate_pdfs(data)
|
|
147
192
|
|
|
148
193
|
Generates multiple PDFs
|
|
149
194
|
|
|
150
|
-
###
|
|
195
|
+
### Examples
|
|
196
|
+
|
|
151
197
|
```ruby
|
|
152
|
-
|
|
198
|
+
require 'time'
|
|
153
199
|
require 'docspring'
|
|
154
200
|
# setup authorization
|
|
155
201
|
DocSpring.configure do |config|
|
|
@@ -159,22 +205,40 @@ DocSpring.configure do |config|
|
|
|
159
205
|
end
|
|
160
206
|
|
|
161
207
|
api_instance = DocSpring::PDFApi.new
|
|
162
|
-
|
|
208
|
+
data = DocSpring::SubmissionBatchData.new({submissions: [DocSpring::SubmissionDataBatchRequest.new({data: 3.56, template_id: 'template_id_example'})]}) # SubmissionBatchData |
|
|
163
209
|
|
|
164
210
|
begin
|
|
165
|
-
#Generates multiple PDFs
|
|
166
|
-
result = api_instance.batch_generate_pdfs(
|
|
211
|
+
# Generates multiple PDFs
|
|
212
|
+
result = api_instance.batch_generate_pdfs(data)
|
|
167
213
|
p result
|
|
168
214
|
rescue DocSpring::ApiError => e
|
|
169
|
-
puts "
|
|
215
|
+
puts "Error when calling PDFApi->batch_generate_pdfs: #{e}"
|
|
216
|
+
end
|
|
217
|
+
```
|
|
218
|
+
|
|
219
|
+
#### Using the batch_generate_pdfs_with_http_info variant
|
|
220
|
+
|
|
221
|
+
This returns an Array which contains the response data, status code and headers.
|
|
222
|
+
|
|
223
|
+
> <Array(<CreateSubmissionBatchResponse>, Integer, Hash)> batch_generate_pdfs_with_http_info(data)
|
|
224
|
+
|
|
225
|
+
```ruby
|
|
226
|
+
begin
|
|
227
|
+
# Generates multiple PDFs
|
|
228
|
+
data, status_code, headers = api_instance.batch_generate_pdfs_with_http_info(data)
|
|
229
|
+
p status_code # => 2xx
|
|
230
|
+
p headers # => { ... }
|
|
231
|
+
p data # => <CreateSubmissionBatchResponse>
|
|
232
|
+
rescue DocSpring::ApiError => e
|
|
233
|
+
puts "Error when calling PDFApi->batch_generate_pdfs_with_http_info: #{e}"
|
|
170
234
|
end
|
|
171
235
|
```
|
|
172
236
|
|
|
173
237
|
### Parameters
|
|
174
238
|
|
|
175
|
-
Name | Type | Description
|
|
176
|
-
|
|
177
|
-
**
|
|
239
|
+
| Name | Type | Description | Notes |
|
|
240
|
+
| ---- | ---- | ----------- | ----- |
|
|
241
|
+
| **data** | [**SubmissionBatchData**](SubmissionBatchData.md) | | |
|
|
178
242
|
|
|
179
243
|
### Return type
|
|
180
244
|
|
|
@@ -186,19 +250,20 @@ Name | Type | Description | Notes
|
|
|
186
250
|
|
|
187
251
|
### HTTP request headers
|
|
188
252
|
|
|
189
|
-
|
|
190
|
-
|
|
253
|
+
- **Content-Type**: application/json
|
|
254
|
+
- **Accept**: application/json
|
|
191
255
|
|
|
192
256
|
|
|
257
|
+
## combine_pdfs
|
|
193
258
|
|
|
194
|
-
|
|
195
|
-
> CreateCombinedSubmissionResponse combine_pdfs(combine_pdfs_data)
|
|
259
|
+
> <CreateCombinedSubmissionResponse> combine_pdfs(data)
|
|
196
260
|
|
|
197
261
|
Merge submission PDFs, template PDFs, or custom files
|
|
198
262
|
|
|
199
|
-
###
|
|
263
|
+
### Examples
|
|
264
|
+
|
|
200
265
|
```ruby
|
|
201
|
-
|
|
266
|
+
require 'time'
|
|
202
267
|
require 'docspring'
|
|
203
268
|
# setup authorization
|
|
204
269
|
DocSpring.configure do |config|
|
|
@@ -208,22 +273,40 @@ DocSpring.configure do |config|
|
|
|
208
273
|
end
|
|
209
274
|
|
|
210
275
|
api_instance = DocSpring::PDFApi.new
|
|
211
|
-
|
|
276
|
+
data = DocSpring::CombinePdfsData.new({source_pdfs: [3.56]}) # CombinePdfsData |
|
|
212
277
|
|
|
213
278
|
begin
|
|
214
|
-
#Merge submission PDFs, template PDFs, or custom files
|
|
215
|
-
result = api_instance.combine_pdfs(
|
|
279
|
+
# Merge submission PDFs, template PDFs, or custom files
|
|
280
|
+
result = api_instance.combine_pdfs(data)
|
|
216
281
|
p result
|
|
217
282
|
rescue DocSpring::ApiError => e
|
|
218
|
-
puts "
|
|
283
|
+
puts "Error when calling PDFApi->combine_pdfs: #{e}"
|
|
284
|
+
end
|
|
285
|
+
```
|
|
286
|
+
|
|
287
|
+
#### Using the combine_pdfs_with_http_info variant
|
|
288
|
+
|
|
289
|
+
This returns an Array which contains the response data, status code and headers.
|
|
290
|
+
|
|
291
|
+
> <Array(<CreateCombinedSubmissionResponse>, Integer, Hash)> combine_pdfs_with_http_info(data)
|
|
292
|
+
|
|
293
|
+
```ruby
|
|
294
|
+
begin
|
|
295
|
+
# Merge submission PDFs, template PDFs, or custom files
|
|
296
|
+
data, status_code, headers = api_instance.combine_pdfs_with_http_info(data)
|
|
297
|
+
p status_code # => 2xx
|
|
298
|
+
p headers # => { ... }
|
|
299
|
+
p data # => <CreateCombinedSubmissionResponse>
|
|
300
|
+
rescue DocSpring::ApiError => e
|
|
301
|
+
puts "Error when calling PDFApi->combine_pdfs_with_http_info: #{e}"
|
|
219
302
|
end
|
|
220
303
|
```
|
|
221
304
|
|
|
222
305
|
### Parameters
|
|
223
306
|
|
|
224
|
-
Name | Type | Description
|
|
225
|
-
|
|
226
|
-
**
|
|
307
|
+
| Name | Type | Description | Notes |
|
|
308
|
+
| ---- | ---- | ----------- | ----- |
|
|
309
|
+
| **data** | [**CombinePdfsData**](CombinePdfsData.md) | | |
|
|
227
310
|
|
|
228
311
|
### Return type
|
|
229
312
|
|
|
@@ -235,19 +318,20 @@ Name | Type | Description | Notes
|
|
|
235
318
|
|
|
236
319
|
### HTTP request headers
|
|
237
320
|
|
|
238
|
-
|
|
239
|
-
|
|
321
|
+
- **Content-Type**: application/json
|
|
322
|
+
- **Accept**: application/json
|
|
240
323
|
|
|
241
324
|
|
|
325
|
+
## combine_submissions
|
|
242
326
|
|
|
243
|
-
|
|
244
|
-
> CreateCombinedSubmissionResponse combine_submissions(combined_submission_data)
|
|
327
|
+
> <CreateCombinedSubmissionResponse> combine_submissions(data)
|
|
245
328
|
|
|
246
329
|
Merge generated PDFs together
|
|
247
330
|
|
|
248
|
-
###
|
|
331
|
+
### Examples
|
|
332
|
+
|
|
249
333
|
```ruby
|
|
250
|
-
|
|
334
|
+
require 'time'
|
|
251
335
|
require 'docspring'
|
|
252
336
|
# setup authorization
|
|
253
337
|
DocSpring.configure do |config|
|
|
@@ -257,22 +341,40 @@ DocSpring.configure do |config|
|
|
|
257
341
|
end
|
|
258
342
|
|
|
259
343
|
api_instance = DocSpring::PDFApi.new
|
|
260
|
-
|
|
344
|
+
data = DocSpring::CombinedSubmissionData.new({submission_ids: ['submission_ids_example']}) # CombinedSubmissionData |
|
|
261
345
|
|
|
262
346
|
begin
|
|
263
|
-
#Merge generated PDFs together
|
|
264
|
-
result = api_instance.combine_submissions(
|
|
347
|
+
# Merge generated PDFs together
|
|
348
|
+
result = api_instance.combine_submissions(data)
|
|
265
349
|
p result
|
|
266
350
|
rescue DocSpring::ApiError => e
|
|
267
|
-
puts "
|
|
351
|
+
puts "Error when calling PDFApi->combine_submissions: #{e}"
|
|
352
|
+
end
|
|
353
|
+
```
|
|
354
|
+
|
|
355
|
+
#### Using the combine_submissions_with_http_info variant
|
|
356
|
+
|
|
357
|
+
This returns an Array which contains the response data, status code and headers.
|
|
358
|
+
|
|
359
|
+
> <Array(<CreateCombinedSubmissionResponse>, Integer, Hash)> combine_submissions_with_http_info(data)
|
|
360
|
+
|
|
361
|
+
```ruby
|
|
362
|
+
begin
|
|
363
|
+
# Merge generated PDFs together
|
|
364
|
+
data, status_code, headers = api_instance.combine_submissions_with_http_info(data)
|
|
365
|
+
p status_code # => 2xx
|
|
366
|
+
p headers # => { ... }
|
|
367
|
+
p data # => <CreateCombinedSubmissionResponse>
|
|
368
|
+
rescue DocSpring::ApiError => e
|
|
369
|
+
puts "Error when calling PDFApi->combine_submissions_with_http_info: #{e}"
|
|
268
370
|
end
|
|
269
371
|
```
|
|
270
372
|
|
|
271
373
|
### Parameters
|
|
272
374
|
|
|
273
|
-
Name | Type | Description
|
|
274
|
-
|
|
275
|
-
**
|
|
375
|
+
| Name | Type | Description | Notes |
|
|
376
|
+
| ---- | ---- | ----------- | ----- |
|
|
377
|
+
| **data** | [**CombinedSubmissionData**](CombinedSubmissionData.md) | | |
|
|
276
378
|
|
|
277
379
|
### Return type
|
|
278
380
|
|
|
@@ -284,19 +386,20 @@ Name | Type | Description | Notes
|
|
|
284
386
|
|
|
285
387
|
### HTTP request headers
|
|
286
388
|
|
|
287
|
-
|
|
288
|
-
|
|
389
|
+
- **Content-Type**: application/json
|
|
390
|
+
- **Accept**: application/json
|
|
289
391
|
|
|
290
392
|
|
|
393
|
+
## copy_template
|
|
291
394
|
|
|
292
|
-
|
|
293
|
-
> Template copy_template(template_id, copy_template_data)
|
|
395
|
+
> <Template> copy_template(template_id, data)
|
|
294
396
|
|
|
295
397
|
Copy a Template
|
|
296
398
|
|
|
297
|
-
###
|
|
399
|
+
### Examples
|
|
400
|
+
|
|
298
401
|
```ruby
|
|
299
|
-
|
|
402
|
+
require 'time'
|
|
300
403
|
require 'docspring'
|
|
301
404
|
# setup authorization
|
|
302
405
|
DocSpring.configure do |config|
|
|
@@ -307,23 +410,41 @@ end
|
|
|
307
410
|
|
|
308
411
|
api_instance = DocSpring::PDFApi.new
|
|
309
412
|
template_id = 'tpl_000000000000000001' # String |
|
|
310
|
-
|
|
413
|
+
data = DocSpring::CopyTemplateData.new({parent_folder_id: 'parent_folder_id_example'}) # CopyTemplateData |
|
|
311
414
|
|
|
312
415
|
begin
|
|
313
|
-
#Copy a Template
|
|
314
|
-
result = api_instance.copy_template(template_id,
|
|
416
|
+
# Copy a Template
|
|
417
|
+
result = api_instance.copy_template(template_id, data)
|
|
315
418
|
p result
|
|
316
419
|
rescue DocSpring::ApiError => e
|
|
317
|
-
puts "
|
|
420
|
+
puts "Error when calling PDFApi->copy_template: #{e}"
|
|
421
|
+
end
|
|
422
|
+
```
|
|
423
|
+
|
|
424
|
+
#### Using the copy_template_with_http_info variant
|
|
425
|
+
|
|
426
|
+
This returns an Array which contains the response data, status code and headers.
|
|
427
|
+
|
|
428
|
+
> <Array(<Template>, Integer, Hash)> copy_template_with_http_info(template_id, data)
|
|
429
|
+
|
|
430
|
+
```ruby
|
|
431
|
+
begin
|
|
432
|
+
# Copy a Template
|
|
433
|
+
data, status_code, headers = api_instance.copy_template_with_http_info(template_id, data)
|
|
434
|
+
p status_code # => 2xx
|
|
435
|
+
p headers # => { ... }
|
|
436
|
+
p data # => <Template>
|
|
437
|
+
rescue DocSpring::ApiError => e
|
|
438
|
+
puts "Error when calling PDFApi->copy_template_with_http_info: #{e}"
|
|
318
439
|
end
|
|
319
440
|
```
|
|
320
441
|
|
|
321
442
|
### Parameters
|
|
322
443
|
|
|
323
|
-
Name | Type | Description
|
|
324
|
-
|
|
325
|
-
**template_id** | **String
|
|
326
|
-
**
|
|
444
|
+
| Name | Type | Description | Notes |
|
|
445
|
+
| ---- | ---- | ----------- | ----- |
|
|
446
|
+
| **template_id** | **String** | | |
|
|
447
|
+
| **data** | [**CopyTemplateData**](CopyTemplateData.md) | | |
|
|
327
448
|
|
|
328
449
|
### Return type
|
|
329
450
|
|
|
@@ -335,19 +456,20 @@ Name | Type | Description | Notes
|
|
|
335
456
|
|
|
336
457
|
### HTTP request headers
|
|
337
458
|
|
|
338
|
-
|
|
339
|
-
|
|
459
|
+
- **Content-Type**: application/json
|
|
460
|
+
- **Accept**: application/json
|
|
340
461
|
|
|
341
462
|
|
|
463
|
+
## create_custom_file_from_upload
|
|
342
464
|
|
|
343
|
-
|
|
344
|
-
> CreateCustomFileResponse create_custom_file_from_upload(create_custom_file_data)
|
|
465
|
+
> <CreateCustomFileResponse> create_custom_file_from_upload(data)
|
|
345
466
|
|
|
346
467
|
Create a new custom file from a cached presign upload
|
|
347
468
|
|
|
348
|
-
###
|
|
469
|
+
### Examples
|
|
470
|
+
|
|
349
471
|
```ruby
|
|
350
|
-
|
|
472
|
+
require 'time'
|
|
351
473
|
require 'docspring'
|
|
352
474
|
# setup authorization
|
|
353
475
|
DocSpring.configure do |config|
|
|
@@ -357,22 +479,40 @@ DocSpring.configure do |config|
|
|
|
357
479
|
end
|
|
358
480
|
|
|
359
481
|
api_instance = DocSpring::PDFApi.new
|
|
360
|
-
|
|
482
|
+
data = DocSpring::CreateCustomFileData.new({cache_id: 'cache_id_example'}) # CreateCustomFileData |
|
|
361
483
|
|
|
362
484
|
begin
|
|
363
|
-
#Create a new custom file from a cached presign upload
|
|
364
|
-
result = api_instance.create_custom_file_from_upload(
|
|
485
|
+
# Create a new custom file from a cached presign upload
|
|
486
|
+
result = api_instance.create_custom_file_from_upload(data)
|
|
365
487
|
p result
|
|
366
488
|
rescue DocSpring::ApiError => e
|
|
367
|
-
puts "
|
|
489
|
+
puts "Error when calling PDFApi->create_custom_file_from_upload: #{e}"
|
|
490
|
+
end
|
|
491
|
+
```
|
|
492
|
+
|
|
493
|
+
#### Using the create_custom_file_from_upload_with_http_info variant
|
|
494
|
+
|
|
495
|
+
This returns an Array which contains the response data, status code and headers.
|
|
496
|
+
|
|
497
|
+
> <Array(<CreateCustomFileResponse>, Integer, Hash)> create_custom_file_from_upload_with_http_info(data)
|
|
498
|
+
|
|
499
|
+
```ruby
|
|
500
|
+
begin
|
|
501
|
+
# Create a new custom file from a cached presign upload
|
|
502
|
+
data, status_code, headers = api_instance.create_custom_file_from_upload_with_http_info(data)
|
|
503
|
+
p status_code # => 2xx
|
|
504
|
+
p headers # => { ... }
|
|
505
|
+
p data # => <CreateCustomFileResponse>
|
|
506
|
+
rescue DocSpring::ApiError => e
|
|
507
|
+
puts "Error when calling PDFApi->create_custom_file_from_upload_with_http_info: #{e}"
|
|
368
508
|
end
|
|
369
509
|
```
|
|
370
510
|
|
|
371
511
|
### Parameters
|
|
372
512
|
|
|
373
|
-
Name | Type | Description
|
|
374
|
-
|
|
375
|
-
**
|
|
513
|
+
| Name | Type | Description | Notes |
|
|
514
|
+
| ---- | ---- | ----------- | ----- |
|
|
515
|
+
| **data** | [**CreateCustomFileData**](CreateCustomFileData.md) | | |
|
|
376
516
|
|
|
377
517
|
### Return type
|
|
378
518
|
|
|
@@ -384,19 +524,20 @@ Name | Type | Description | Notes
|
|
|
384
524
|
|
|
385
525
|
### HTTP request headers
|
|
386
526
|
|
|
387
|
-
|
|
388
|
-
|
|
527
|
+
- **Content-Type**: application/json
|
|
528
|
+
- **Accept**: application/json
|
|
389
529
|
|
|
390
530
|
|
|
531
|
+
## create_data_request_event
|
|
391
532
|
|
|
392
|
-
|
|
393
|
-
> CreateSubmissionDataRequestTokenResponse create_data_request_token(data_request_id)
|
|
533
|
+
> <CreateSubmissionDataRequestEventResponse> create_data_request_event(data_request_id, event)
|
|
394
534
|
|
|
395
|
-
Creates a new
|
|
535
|
+
Creates a new event for emailing a signee a request for signature
|
|
536
|
+
|
|
537
|
+
### Examples
|
|
396
538
|
|
|
397
|
-
### Example
|
|
398
539
|
```ruby
|
|
399
|
-
|
|
540
|
+
require 'time'
|
|
400
541
|
require 'docspring'
|
|
401
542
|
# setup authorization
|
|
402
543
|
DocSpring.configure do |config|
|
|
@@ -407,25 +548,45 @@ end
|
|
|
407
548
|
|
|
408
549
|
api_instance = DocSpring::PDFApi.new
|
|
409
550
|
data_request_id = 'drq_000000000000000001' # String |
|
|
551
|
+
event = DocSpring::CreateSubmissionDataRequestEventRequest.new({event_type: 'send_request'}) # CreateSubmissionDataRequestEventRequest |
|
|
410
552
|
|
|
411
553
|
begin
|
|
412
|
-
#Creates a new
|
|
413
|
-
result = api_instance.
|
|
554
|
+
# Creates a new event for emailing a signee a request for signature
|
|
555
|
+
result = api_instance.create_data_request_event(data_request_id, event)
|
|
414
556
|
p result
|
|
415
557
|
rescue DocSpring::ApiError => e
|
|
416
|
-
puts "
|
|
558
|
+
puts "Error when calling PDFApi->create_data_request_event: #{e}"
|
|
559
|
+
end
|
|
560
|
+
```
|
|
561
|
+
|
|
562
|
+
#### Using the create_data_request_event_with_http_info variant
|
|
563
|
+
|
|
564
|
+
This returns an Array which contains the response data, status code and headers.
|
|
565
|
+
|
|
566
|
+
> <Array(<CreateSubmissionDataRequestEventResponse>, Integer, Hash)> create_data_request_event_with_http_info(data_request_id, event)
|
|
567
|
+
|
|
568
|
+
```ruby
|
|
569
|
+
begin
|
|
570
|
+
# Creates a new event for emailing a signee a request for signature
|
|
571
|
+
data, status_code, headers = api_instance.create_data_request_event_with_http_info(data_request_id, event)
|
|
572
|
+
p status_code # => 2xx
|
|
573
|
+
p headers # => { ... }
|
|
574
|
+
p data # => <CreateSubmissionDataRequestEventResponse>
|
|
575
|
+
rescue DocSpring::ApiError => e
|
|
576
|
+
puts "Error when calling PDFApi->create_data_request_event_with_http_info: #{e}"
|
|
417
577
|
end
|
|
418
578
|
```
|
|
419
579
|
|
|
420
580
|
### Parameters
|
|
421
581
|
|
|
422
|
-
Name | Type | Description
|
|
423
|
-
|
|
424
|
-
**data_request_id** | **String
|
|
582
|
+
| Name | Type | Description | Notes |
|
|
583
|
+
| ---- | ---- | ----------- | ----- |
|
|
584
|
+
| **data_request_id** | **String** | | |
|
|
585
|
+
| **event** | [**CreateSubmissionDataRequestEventRequest**](CreateSubmissionDataRequestEventRequest.md) | | |
|
|
425
586
|
|
|
426
587
|
### Return type
|
|
427
588
|
|
|
428
|
-
[**
|
|
589
|
+
[**CreateSubmissionDataRequestEventResponse**](CreateSubmissionDataRequestEventResponse.md)
|
|
429
590
|
|
|
430
591
|
### Authorization
|
|
431
592
|
|
|
@@ -433,19 +594,20 @@ Name | Type | Description | Notes
|
|
|
433
594
|
|
|
434
595
|
### HTTP request headers
|
|
435
596
|
|
|
436
|
-
|
|
437
|
-
|
|
597
|
+
- **Content-Type**: application/json
|
|
598
|
+
- **Accept**: application/json
|
|
438
599
|
|
|
439
600
|
|
|
601
|
+
## create_data_request_token
|
|
440
602
|
|
|
441
|
-
|
|
442
|
-
> Folder create_folder(create_folder_data)
|
|
603
|
+
> <CreateSubmissionDataRequestTokenResponse> create_data_request_token(data_request_id)
|
|
443
604
|
|
|
444
|
-
|
|
605
|
+
Creates a new data request token for form authentication
|
|
606
|
+
|
|
607
|
+
### Examples
|
|
445
608
|
|
|
446
|
-
### Example
|
|
447
609
|
```ruby
|
|
448
|
-
|
|
610
|
+
require 'time'
|
|
449
611
|
require 'docspring'
|
|
450
612
|
# setup authorization
|
|
451
613
|
DocSpring.configure do |config|
|
|
@@ -455,26 +617,44 @@ DocSpring.configure do |config|
|
|
|
455
617
|
end
|
|
456
618
|
|
|
457
619
|
api_instance = DocSpring::PDFApi.new
|
|
458
|
-
|
|
620
|
+
data_request_id = 'drq_000000000000000001' # String |
|
|
459
621
|
|
|
460
622
|
begin
|
|
461
|
-
#
|
|
462
|
-
result = api_instance.
|
|
623
|
+
# Creates a new data request token for form authentication
|
|
624
|
+
result = api_instance.create_data_request_token(data_request_id)
|
|
463
625
|
p result
|
|
464
626
|
rescue DocSpring::ApiError => e
|
|
465
|
-
puts "
|
|
627
|
+
puts "Error when calling PDFApi->create_data_request_token: #{e}"
|
|
628
|
+
end
|
|
629
|
+
```
|
|
630
|
+
|
|
631
|
+
#### Using the create_data_request_token_with_http_info variant
|
|
632
|
+
|
|
633
|
+
This returns an Array which contains the response data, status code and headers.
|
|
634
|
+
|
|
635
|
+
> <Array(<CreateSubmissionDataRequestTokenResponse>, Integer, Hash)> create_data_request_token_with_http_info(data_request_id)
|
|
636
|
+
|
|
637
|
+
```ruby
|
|
638
|
+
begin
|
|
639
|
+
# Creates a new data request token for form authentication
|
|
640
|
+
data, status_code, headers = api_instance.create_data_request_token_with_http_info(data_request_id)
|
|
641
|
+
p status_code # => 2xx
|
|
642
|
+
p headers # => { ... }
|
|
643
|
+
p data # => <CreateSubmissionDataRequestTokenResponse>
|
|
644
|
+
rescue DocSpring::ApiError => e
|
|
645
|
+
puts "Error when calling PDFApi->create_data_request_token_with_http_info: #{e}"
|
|
466
646
|
end
|
|
467
647
|
```
|
|
468
648
|
|
|
469
649
|
### Parameters
|
|
470
650
|
|
|
471
|
-
Name | Type | Description
|
|
472
|
-
|
|
473
|
-
**
|
|
651
|
+
| Name | Type | Description | Notes |
|
|
652
|
+
| ---- | ---- | ----------- | ----- |
|
|
653
|
+
| **data_request_id** | **String** | | |
|
|
474
654
|
|
|
475
655
|
### Return type
|
|
476
656
|
|
|
477
|
-
[**
|
|
657
|
+
[**CreateSubmissionDataRequestTokenResponse**](CreateSubmissionDataRequestTokenResponse.md)
|
|
478
658
|
|
|
479
659
|
### Authorization
|
|
480
660
|
|
|
@@ -482,19 +662,20 @@ Name | Type | Description | Notes
|
|
|
482
662
|
|
|
483
663
|
### HTTP request headers
|
|
484
664
|
|
|
485
|
-
|
|
486
|
-
|
|
665
|
+
- **Content-Type**: Not defined
|
|
666
|
+
- **Accept**: application/json
|
|
487
667
|
|
|
488
668
|
|
|
669
|
+
## create_folder
|
|
489
670
|
|
|
490
|
-
|
|
491
|
-
> PendingTemplate create_html_template(create_html_template_data)
|
|
671
|
+
> <Folder> create_folder(data)
|
|
492
672
|
|
|
493
|
-
Create a
|
|
673
|
+
Create a folder
|
|
674
|
+
|
|
675
|
+
### Examples
|
|
494
676
|
|
|
495
|
-
### Example
|
|
496
677
|
```ruby
|
|
497
|
-
|
|
678
|
+
require 'time'
|
|
498
679
|
require 'docspring'
|
|
499
680
|
# setup authorization
|
|
500
681
|
DocSpring.configure do |config|
|
|
@@ -504,26 +685,44 @@ DocSpring.configure do |config|
|
|
|
504
685
|
end
|
|
505
686
|
|
|
506
687
|
api_instance = DocSpring::PDFApi.new
|
|
507
|
-
|
|
688
|
+
data = DocSpring::CreateFolderData.new({folder: DocSpring::CreateFolderAttributes.new({name: 'name_example'})}) # CreateFolderData |
|
|
508
689
|
|
|
509
690
|
begin
|
|
510
|
-
#Create a
|
|
511
|
-
result = api_instance.
|
|
691
|
+
# Create a folder
|
|
692
|
+
result = api_instance.create_folder(data)
|
|
512
693
|
p result
|
|
513
694
|
rescue DocSpring::ApiError => e
|
|
514
|
-
puts "
|
|
695
|
+
puts "Error when calling PDFApi->create_folder: #{e}"
|
|
696
|
+
end
|
|
697
|
+
```
|
|
698
|
+
|
|
699
|
+
#### Using the create_folder_with_http_info variant
|
|
700
|
+
|
|
701
|
+
This returns an Array which contains the response data, status code and headers.
|
|
702
|
+
|
|
703
|
+
> <Array(<Folder>, Integer, Hash)> create_folder_with_http_info(data)
|
|
704
|
+
|
|
705
|
+
```ruby
|
|
706
|
+
begin
|
|
707
|
+
# Create a folder
|
|
708
|
+
data, status_code, headers = api_instance.create_folder_with_http_info(data)
|
|
709
|
+
p status_code # => 2xx
|
|
710
|
+
p headers # => { ... }
|
|
711
|
+
p data # => <Folder>
|
|
712
|
+
rescue DocSpring::ApiError => e
|
|
713
|
+
puts "Error when calling PDFApi->create_folder_with_http_info: #{e}"
|
|
515
714
|
end
|
|
516
715
|
```
|
|
517
716
|
|
|
518
717
|
### Parameters
|
|
519
718
|
|
|
520
|
-
Name | Type | Description
|
|
521
|
-
|
|
522
|
-
**
|
|
719
|
+
| Name | Type | Description | Notes |
|
|
720
|
+
| ---- | ---- | ----------- | ----- |
|
|
721
|
+
| **data** | [**CreateFolderData**](CreateFolderData.md) | | |
|
|
523
722
|
|
|
524
723
|
### Return type
|
|
525
724
|
|
|
526
|
-
[**
|
|
725
|
+
[**Folder**](Folder.md)
|
|
527
726
|
|
|
528
727
|
### Authorization
|
|
529
728
|
|
|
@@ -531,19 +730,20 @@ Name | Type | Description | Notes
|
|
|
531
730
|
|
|
532
731
|
### HTTP request headers
|
|
533
732
|
|
|
534
|
-
|
|
535
|
-
|
|
733
|
+
- **Content-Type**: application/json
|
|
734
|
+
- **Accept**: application/json
|
|
536
735
|
|
|
537
736
|
|
|
737
|
+
## create_html_template
|
|
538
738
|
|
|
539
|
-
|
|
540
|
-
> PendingTemplate create_pdf_template(template_document, template_name, opts)
|
|
739
|
+
> <PendingTemplate> create_html_template(data)
|
|
541
740
|
|
|
542
|
-
Create a new
|
|
741
|
+
Create a new HTML template
|
|
742
|
+
|
|
743
|
+
### Examples
|
|
543
744
|
|
|
544
|
-
### Example
|
|
545
745
|
```ruby
|
|
546
|
-
|
|
746
|
+
require 'time'
|
|
547
747
|
require 'docspring'
|
|
548
748
|
# setup authorization
|
|
549
749
|
DocSpring.configure do |config|
|
|
@@ -553,28 +753,40 @@ DocSpring.configure do |config|
|
|
|
553
753
|
end
|
|
554
754
|
|
|
555
755
|
api_instance = DocSpring::PDFApi.new
|
|
556
|
-
|
|
557
|
-
template_name = 'template_name_example' # String |
|
|
558
|
-
opts = {
|
|
559
|
-
template_parent_folder_id: 'template_parent_folder_id_example' # String |
|
|
560
|
-
}
|
|
756
|
+
data = DocSpring::CreateHtmlTemplateData.new({template: DocSpring::HtmlTemplateData.new({name: 'name_example'})}) # CreateHtmlTemplateData |
|
|
561
757
|
|
|
562
758
|
begin
|
|
563
|
-
#Create a new
|
|
564
|
-
result = api_instance.
|
|
759
|
+
# Create a new HTML template
|
|
760
|
+
result = api_instance.create_html_template(data)
|
|
565
761
|
p result
|
|
566
762
|
rescue DocSpring::ApiError => e
|
|
567
|
-
puts "
|
|
763
|
+
puts "Error when calling PDFApi->create_html_template: #{e}"
|
|
764
|
+
end
|
|
765
|
+
```
|
|
766
|
+
|
|
767
|
+
#### Using the create_html_template_with_http_info variant
|
|
768
|
+
|
|
769
|
+
This returns an Array which contains the response data, status code and headers.
|
|
770
|
+
|
|
771
|
+
> <Array(<PendingTemplate>, Integer, Hash)> create_html_template_with_http_info(data)
|
|
772
|
+
|
|
773
|
+
```ruby
|
|
774
|
+
begin
|
|
775
|
+
# Create a new HTML template
|
|
776
|
+
data, status_code, headers = api_instance.create_html_template_with_http_info(data)
|
|
777
|
+
p status_code # => 2xx
|
|
778
|
+
p headers # => { ... }
|
|
779
|
+
p data # => <PendingTemplate>
|
|
780
|
+
rescue DocSpring::ApiError => e
|
|
781
|
+
puts "Error when calling PDFApi->create_html_template_with_http_info: #{e}"
|
|
568
782
|
end
|
|
569
783
|
```
|
|
570
784
|
|
|
571
785
|
### Parameters
|
|
572
786
|
|
|
573
|
-
Name | Type | Description
|
|
574
|
-
|
|
575
|
-
**
|
|
576
|
-
**template_name** | **String**| |
|
|
577
|
-
**template_parent_folder_id** | **String**| | [optional]
|
|
787
|
+
| Name | Type | Description | Notes |
|
|
788
|
+
| ---- | ---- | ----------- | ----- |
|
|
789
|
+
| **data** | [**CreateHtmlTemplateData**](CreateHtmlTemplateData.md) | | |
|
|
578
790
|
|
|
579
791
|
### Return type
|
|
580
792
|
|
|
@@ -586,19 +798,20 @@ Name | Type | Description | Notes
|
|
|
586
798
|
|
|
587
799
|
### HTTP request headers
|
|
588
800
|
|
|
589
|
-
|
|
590
|
-
|
|
801
|
+
- **Content-Type**: application/json
|
|
802
|
+
- **Accept**: application/json
|
|
591
803
|
|
|
592
804
|
|
|
805
|
+
## create_pdf_template
|
|
593
806
|
|
|
594
|
-
|
|
595
|
-
> PendingTemplate create_pdf_template_from_upload(create_template_from_upload_data)
|
|
807
|
+
> <PendingTemplate> create_pdf_template(template_document, template_name, opts)
|
|
596
808
|
|
|
597
|
-
Create a new PDF template
|
|
809
|
+
Create a new PDF template with a form POST file upload
|
|
810
|
+
|
|
811
|
+
### Examples
|
|
598
812
|
|
|
599
|
-
### Example
|
|
600
813
|
```ruby
|
|
601
|
-
|
|
814
|
+
require 'time'
|
|
602
815
|
require 'docspring'
|
|
603
816
|
# setup authorization
|
|
604
817
|
DocSpring.configure do |config|
|
|
@@ -608,22 +821,46 @@ DocSpring.configure do |config|
|
|
|
608
821
|
end
|
|
609
822
|
|
|
610
823
|
api_instance = DocSpring::PDFApi.new
|
|
611
|
-
|
|
824
|
+
template_document = File.new('/path/to/some/file') # File |
|
|
825
|
+
template_name = 'template_name_example' # String |
|
|
826
|
+
opts = {
|
|
827
|
+
template_parent_folder_id: 'template_parent_folder_id_example' # String |
|
|
828
|
+
}
|
|
612
829
|
|
|
613
830
|
begin
|
|
614
|
-
#Create a new PDF template
|
|
615
|
-
result = api_instance.
|
|
831
|
+
# Create a new PDF template with a form POST file upload
|
|
832
|
+
result = api_instance.create_pdf_template(template_document, template_name, opts)
|
|
616
833
|
p result
|
|
617
834
|
rescue DocSpring::ApiError => e
|
|
618
|
-
puts "
|
|
835
|
+
puts "Error when calling PDFApi->create_pdf_template: #{e}"
|
|
836
|
+
end
|
|
837
|
+
```
|
|
838
|
+
|
|
839
|
+
#### Using the create_pdf_template_with_http_info variant
|
|
840
|
+
|
|
841
|
+
This returns an Array which contains the response data, status code and headers.
|
|
842
|
+
|
|
843
|
+
> <Array(<PendingTemplate>, Integer, Hash)> create_pdf_template_with_http_info(template_document, template_name, opts)
|
|
844
|
+
|
|
845
|
+
```ruby
|
|
846
|
+
begin
|
|
847
|
+
# Create a new PDF template with a form POST file upload
|
|
848
|
+
data, status_code, headers = api_instance.create_pdf_template_with_http_info(template_document, template_name, opts)
|
|
849
|
+
p status_code # => 2xx
|
|
850
|
+
p headers # => { ... }
|
|
851
|
+
p data # => <PendingTemplate>
|
|
852
|
+
rescue DocSpring::ApiError => e
|
|
853
|
+
puts "Error when calling PDFApi->create_pdf_template_with_http_info: #{e}"
|
|
619
854
|
end
|
|
620
855
|
```
|
|
621
856
|
|
|
622
857
|
### Parameters
|
|
623
858
|
|
|
624
|
-
Name | Type | Description
|
|
625
|
-
|
|
626
|
-
**
|
|
859
|
+
| Name | Type | Description | Notes |
|
|
860
|
+
| ---- | ---- | ----------- | ----- |
|
|
861
|
+
| **template_document** | **File** | | |
|
|
862
|
+
| **template_name** | **String** | | |
|
|
863
|
+
| **template_parent_folder_id** | **String** | | [optional] |
|
|
627
864
|
|
|
628
865
|
### Return type
|
|
629
866
|
|
|
@@ -635,19 +872,20 @@ Name | Type | Description | Notes
|
|
|
635
872
|
|
|
636
873
|
### HTTP request headers
|
|
637
874
|
|
|
638
|
-
|
|
639
|
-
|
|
875
|
+
- **Content-Type**: multipart/form-data
|
|
876
|
+
- **Accept**: application/json
|
|
640
877
|
|
|
641
878
|
|
|
879
|
+
## create_pdf_template_from_upload
|
|
642
880
|
|
|
643
|
-
|
|
644
|
-
> Folder delete_folder(folder_id)
|
|
881
|
+
> <PendingTemplate> create_pdf_template_from_upload(data)
|
|
645
882
|
|
|
646
|
-
|
|
883
|
+
Create a new PDF template from a cached presign upload
|
|
884
|
+
|
|
885
|
+
### Examples
|
|
647
886
|
|
|
648
|
-
### Example
|
|
649
887
|
```ruby
|
|
650
|
-
|
|
888
|
+
require 'time'
|
|
651
889
|
require 'docspring'
|
|
652
890
|
# setup authorization
|
|
653
891
|
DocSpring.configure do |config|
|
|
@@ -657,26 +895,44 @@ DocSpring.configure do |config|
|
|
|
657
895
|
end
|
|
658
896
|
|
|
659
897
|
api_instance = DocSpring::PDFApi.new
|
|
660
|
-
|
|
898
|
+
data = DocSpring::CreateTemplateFromUploadData.new({template: DocSpring::UploadTemplateData.new({name: 'name_example'})}) # CreateTemplateFromUploadData |
|
|
661
899
|
|
|
662
900
|
begin
|
|
663
|
-
#
|
|
664
|
-
result = api_instance.
|
|
901
|
+
# Create a new PDF template from a cached presign upload
|
|
902
|
+
result = api_instance.create_pdf_template_from_upload(data)
|
|
665
903
|
p result
|
|
666
904
|
rescue DocSpring::ApiError => e
|
|
667
|
-
puts "
|
|
905
|
+
puts "Error when calling PDFApi->create_pdf_template_from_upload: #{e}"
|
|
906
|
+
end
|
|
907
|
+
```
|
|
908
|
+
|
|
909
|
+
#### Using the create_pdf_template_from_upload_with_http_info variant
|
|
910
|
+
|
|
911
|
+
This returns an Array which contains the response data, status code and headers.
|
|
912
|
+
|
|
913
|
+
> <Array(<PendingTemplate>, Integer, Hash)> create_pdf_template_from_upload_with_http_info(data)
|
|
914
|
+
|
|
915
|
+
```ruby
|
|
916
|
+
begin
|
|
917
|
+
# Create a new PDF template from a cached presign upload
|
|
918
|
+
data, status_code, headers = api_instance.create_pdf_template_from_upload_with_http_info(data)
|
|
919
|
+
p status_code # => 2xx
|
|
920
|
+
p headers # => { ... }
|
|
921
|
+
p data # => <PendingTemplate>
|
|
922
|
+
rescue DocSpring::ApiError => e
|
|
923
|
+
puts "Error when calling PDFApi->create_pdf_template_from_upload_with_http_info: #{e}"
|
|
668
924
|
end
|
|
669
925
|
```
|
|
670
926
|
|
|
671
927
|
### Parameters
|
|
672
928
|
|
|
673
|
-
Name | Type | Description
|
|
674
|
-
|
|
675
|
-
**
|
|
929
|
+
| Name | Type | Description | Notes |
|
|
930
|
+
| ---- | ---- | ----------- | ----- |
|
|
931
|
+
| **data** | [**CreateTemplateFromUploadData**](CreateTemplateFromUploadData.md) | | |
|
|
676
932
|
|
|
677
933
|
### Return type
|
|
678
934
|
|
|
679
|
-
[**
|
|
935
|
+
[**PendingTemplate**](PendingTemplate.md)
|
|
680
936
|
|
|
681
937
|
### Authorization
|
|
682
938
|
|
|
@@ -684,19 +940,20 @@ Name | Type | Description | Notes
|
|
|
684
940
|
|
|
685
941
|
### HTTP request headers
|
|
686
942
|
|
|
687
|
-
|
|
688
|
-
|
|
943
|
+
- **Content-Type**: application/json
|
|
944
|
+
- **Accept**: application/json
|
|
689
945
|
|
|
690
946
|
|
|
947
|
+
## delete_folder
|
|
691
948
|
|
|
692
|
-
|
|
693
|
-
> CombinedSubmission expire_combined_submission(combined_submission_id)
|
|
949
|
+
> <Folder> delete_folder(folder_id)
|
|
694
950
|
|
|
695
|
-
|
|
951
|
+
Delete a folder
|
|
952
|
+
|
|
953
|
+
### Examples
|
|
696
954
|
|
|
697
|
-
### Example
|
|
698
955
|
```ruby
|
|
699
|
-
|
|
956
|
+
require 'time'
|
|
700
957
|
require 'docspring'
|
|
701
958
|
# setup authorization
|
|
702
959
|
DocSpring.configure do |config|
|
|
@@ -706,26 +963,44 @@ DocSpring.configure do |config|
|
|
|
706
963
|
end
|
|
707
964
|
|
|
708
965
|
api_instance = DocSpring::PDFApi.new
|
|
709
|
-
|
|
966
|
+
folder_id = 'fld_0000000000000000001' # String |
|
|
710
967
|
|
|
711
968
|
begin
|
|
712
|
-
#
|
|
713
|
-
result = api_instance.
|
|
969
|
+
# Delete a folder
|
|
970
|
+
result = api_instance.delete_folder(folder_id)
|
|
714
971
|
p result
|
|
715
972
|
rescue DocSpring::ApiError => e
|
|
716
|
-
puts "
|
|
973
|
+
puts "Error when calling PDFApi->delete_folder: #{e}"
|
|
974
|
+
end
|
|
975
|
+
```
|
|
976
|
+
|
|
977
|
+
#### Using the delete_folder_with_http_info variant
|
|
978
|
+
|
|
979
|
+
This returns an Array which contains the response data, status code and headers.
|
|
980
|
+
|
|
981
|
+
> <Array(<Folder>, Integer, Hash)> delete_folder_with_http_info(folder_id)
|
|
982
|
+
|
|
983
|
+
```ruby
|
|
984
|
+
begin
|
|
985
|
+
# Delete a folder
|
|
986
|
+
data, status_code, headers = api_instance.delete_folder_with_http_info(folder_id)
|
|
987
|
+
p status_code # => 2xx
|
|
988
|
+
p headers # => { ... }
|
|
989
|
+
p data # => <Folder>
|
|
990
|
+
rescue DocSpring::ApiError => e
|
|
991
|
+
puts "Error when calling PDFApi->delete_folder_with_http_info: #{e}"
|
|
717
992
|
end
|
|
718
993
|
```
|
|
719
994
|
|
|
720
995
|
### Parameters
|
|
721
996
|
|
|
722
|
-
Name | Type | Description
|
|
723
|
-
|
|
724
|
-
**
|
|
997
|
+
| Name | Type | Description | Notes |
|
|
998
|
+
| ---- | ---- | ----------- | ----- |
|
|
999
|
+
| **folder_id** | **String** | | |
|
|
725
1000
|
|
|
726
1001
|
### Return type
|
|
727
1002
|
|
|
728
|
-
[**
|
|
1003
|
+
[**Folder**](Folder.md)
|
|
729
1004
|
|
|
730
1005
|
### Authorization
|
|
731
1006
|
|
|
@@ -733,19 +1008,20 @@ Name | Type | Description | Notes
|
|
|
733
1008
|
|
|
734
1009
|
### HTTP request headers
|
|
735
1010
|
|
|
736
|
-
|
|
737
|
-
|
|
1011
|
+
- **Content-Type**: Not defined
|
|
1012
|
+
- **Accept**: application/json
|
|
738
1013
|
|
|
739
1014
|
|
|
1015
|
+
## delete_template
|
|
740
1016
|
|
|
741
|
-
|
|
742
|
-
> Submission expire_submission(submission_id)
|
|
1017
|
+
> <DeleteTemplateResponse> delete_template(template_id, opts)
|
|
743
1018
|
|
|
744
|
-
|
|
1019
|
+
Delete a template
|
|
1020
|
+
|
|
1021
|
+
### Examples
|
|
745
1022
|
|
|
746
|
-
### Example
|
|
747
1023
|
```ruby
|
|
748
|
-
|
|
1024
|
+
require 'time'
|
|
749
1025
|
require 'docspring'
|
|
750
1026
|
# setup authorization
|
|
751
1027
|
DocSpring.configure do |config|
|
|
@@ -755,26 +1031,48 @@ DocSpring.configure do |config|
|
|
|
755
1031
|
end
|
|
756
1032
|
|
|
757
1033
|
api_instance = DocSpring::PDFApi.new
|
|
758
|
-
|
|
1034
|
+
template_id = 'tpl_000000000000000001' # String |
|
|
1035
|
+
opts = {
|
|
1036
|
+
version: '0.1.0' # String |
|
|
1037
|
+
}
|
|
759
1038
|
|
|
760
1039
|
begin
|
|
761
|
-
#
|
|
762
|
-
result = api_instance.
|
|
1040
|
+
# Delete a template
|
|
1041
|
+
result = api_instance.delete_template(template_id, opts)
|
|
763
1042
|
p result
|
|
764
1043
|
rescue DocSpring::ApiError => e
|
|
765
|
-
puts "
|
|
1044
|
+
puts "Error when calling PDFApi->delete_template: #{e}"
|
|
1045
|
+
end
|
|
1046
|
+
```
|
|
1047
|
+
|
|
1048
|
+
#### Using the delete_template_with_http_info variant
|
|
1049
|
+
|
|
1050
|
+
This returns an Array which contains the response data, status code and headers.
|
|
1051
|
+
|
|
1052
|
+
> <Array(<DeleteTemplateResponse>, Integer, Hash)> delete_template_with_http_info(template_id, opts)
|
|
1053
|
+
|
|
1054
|
+
```ruby
|
|
1055
|
+
begin
|
|
1056
|
+
# Delete a template
|
|
1057
|
+
data, status_code, headers = api_instance.delete_template_with_http_info(template_id, opts)
|
|
1058
|
+
p status_code # => 2xx
|
|
1059
|
+
p headers # => { ... }
|
|
1060
|
+
p data # => <DeleteTemplateResponse>
|
|
1061
|
+
rescue DocSpring::ApiError => e
|
|
1062
|
+
puts "Error when calling PDFApi->delete_template_with_http_info: #{e}"
|
|
766
1063
|
end
|
|
767
1064
|
```
|
|
768
1065
|
|
|
769
1066
|
### Parameters
|
|
770
1067
|
|
|
771
|
-
Name | Type | Description
|
|
772
|
-
|
|
773
|
-
**
|
|
1068
|
+
| Name | Type | Description | Notes |
|
|
1069
|
+
| ---- | ---- | ----------- | ----- |
|
|
1070
|
+
| **template_id** | **String** | | |
|
|
1071
|
+
| **version** | **String** | | [optional] |
|
|
774
1072
|
|
|
775
1073
|
### Return type
|
|
776
1074
|
|
|
777
|
-
[**
|
|
1075
|
+
[**DeleteTemplateResponse**](DeleteTemplateResponse.md)
|
|
778
1076
|
|
|
779
1077
|
### Authorization
|
|
780
1078
|
|
|
@@ -782,19 +1080,20 @@ Name | Type | Description | Notes
|
|
|
782
1080
|
|
|
783
1081
|
### HTTP request headers
|
|
784
1082
|
|
|
785
|
-
|
|
786
|
-
|
|
1083
|
+
- **Content-Type**: Not defined
|
|
1084
|
+
- **Accept**: application/json
|
|
787
1085
|
|
|
788
1086
|
|
|
1087
|
+
## expire_combined_submission
|
|
789
1088
|
|
|
790
|
-
|
|
791
|
-
> CreateSubmissionResponse generate_pdf(template_id, submission_data)
|
|
1089
|
+
> <CombinedSubmission> expire_combined_submission(combined_submission_id)
|
|
792
1090
|
|
|
793
|
-
|
|
1091
|
+
Expire a combined submission
|
|
1092
|
+
|
|
1093
|
+
### Examples
|
|
794
1094
|
|
|
795
|
-
### Example
|
|
796
1095
|
```ruby
|
|
797
|
-
|
|
1096
|
+
require 'time'
|
|
798
1097
|
require 'docspring'
|
|
799
1098
|
# setup authorization
|
|
800
1099
|
DocSpring.configure do |config|
|
|
@@ -804,28 +1103,44 @@ DocSpring.configure do |config|
|
|
|
804
1103
|
end
|
|
805
1104
|
|
|
806
1105
|
api_instance = DocSpring::PDFApi.new
|
|
807
|
-
|
|
808
|
-
submission_data = DocSpring::SubmissionData.new # SubmissionData |
|
|
1106
|
+
combined_submission_id = 'com_0000000000000000001' # String |
|
|
809
1107
|
|
|
810
1108
|
begin
|
|
811
|
-
#
|
|
812
|
-
result = api_instance.
|
|
1109
|
+
# Expire a combined submission
|
|
1110
|
+
result = api_instance.expire_combined_submission(combined_submission_id)
|
|
813
1111
|
p result
|
|
814
1112
|
rescue DocSpring::ApiError => e
|
|
815
|
-
puts "
|
|
1113
|
+
puts "Error when calling PDFApi->expire_combined_submission: #{e}"
|
|
1114
|
+
end
|
|
1115
|
+
```
|
|
1116
|
+
|
|
1117
|
+
#### Using the expire_combined_submission_with_http_info variant
|
|
1118
|
+
|
|
1119
|
+
This returns an Array which contains the response data, status code and headers.
|
|
1120
|
+
|
|
1121
|
+
> <Array(<CombinedSubmission>, Integer, Hash)> expire_combined_submission_with_http_info(combined_submission_id)
|
|
1122
|
+
|
|
1123
|
+
```ruby
|
|
1124
|
+
begin
|
|
1125
|
+
# Expire a combined submission
|
|
1126
|
+
data, status_code, headers = api_instance.expire_combined_submission_with_http_info(combined_submission_id)
|
|
1127
|
+
p status_code # => 2xx
|
|
1128
|
+
p headers # => { ... }
|
|
1129
|
+
p data # => <CombinedSubmission>
|
|
1130
|
+
rescue DocSpring::ApiError => e
|
|
1131
|
+
puts "Error when calling PDFApi->expire_combined_submission_with_http_info: #{e}"
|
|
816
1132
|
end
|
|
817
1133
|
```
|
|
818
1134
|
|
|
819
1135
|
### Parameters
|
|
820
1136
|
|
|
821
|
-
Name | Type | Description
|
|
822
|
-
|
|
823
|
-
**
|
|
824
|
-
**submission_data** | [**SubmissionData**](SubmissionData.md)| |
|
|
1137
|
+
| Name | Type | Description | Notes |
|
|
1138
|
+
| ---- | ---- | ----------- | ----- |
|
|
1139
|
+
| **combined_submission_id** | **String** | | |
|
|
825
1140
|
|
|
826
1141
|
### Return type
|
|
827
1142
|
|
|
828
|
-
[**
|
|
1143
|
+
[**CombinedSubmission**](CombinedSubmission.md)
|
|
829
1144
|
|
|
830
1145
|
### Authorization
|
|
831
1146
|
|
|
@@ -833,19 +1148,20 @@ Name | Type | Description | Notes
|
|
|
833
1148
|
|
|
834
1149
|
### HTTP request headers
|
|
835
1150
|
|
|
836
|
-
|
|
837
|
-
|
|
1151
|
+
- **Content-Type**: Not defined
|
|
1152
|
+
- **Accept**: application/json
|
|
838
1153
|
|
|
839
1154
|
|
|
1155
|
+
## expire_submission
|
|
840
1156
|
|
|
841
|
-
|
|
842
|
-
> CombinedSubmission get_combined_submission(combined_submission_id)
|
|
1157
|
+
> <Submission> expire_submission(submission_id)
|
|
843
1158
|
|
|
844
|
-
|
|
1159
|
+
Expire a PDF submission
|
|
1160
|
+
|
|
1161
|
+
### Examples
|
|
845
1162
|
|
|
846
|
-
### Example
|
|
847
1163
|
```ruby
|
|
848
|
-
|
|
1164
|
+
require 'time'
|
|
849
1165
|
require 'docspring'
|
|
850
1166
|
# setup authorization
|
|
851
1167
|
DocSpring.configure do |config|
|
|
@@ -855,26 +1171,44 @@ DocSpring.configure do |config|
|
|
|
855
1171
|
end
|
|
856
1172
|
|
|
857
1173
|
api_instance = DocSpring::PDFApi.new
|
|
858
|
-
|
|
1174
|
+
submission_id = 'sub_000000000000000001' # String |
|
|
859
1175
|
|
|
860
1176
|
begin
|
|
861
|
-
#
|
|
862
|
-
result = api_instance.
|
|
1177
|
+
# Expire a PDF submission
|
|
1178
|
+
result = api_instance.expire_submission(submission_id)
|
|
863
1179
|
p result
|
|
864
1180
|
rescue DocSpring::ApiError => e
|
|
865
|
-
puts "
|
|
1181
|
+
puts "Error when calling PDFApi->expire_submission: #{e}"
|
|
1182
|
+
end
|
|
1183
|
+
```
|
|
1184
|
+
|
|
1185
|
+
#### Using the expire_submission_with_http_info variant
|
|
1186
|
+
|
|
1187
|
+
This returns an Array which contains the response data, status code and headers.
|
|
1188
|
+
|
|
1189
|
+
> <Array(<Submission>, Integer, Hash)> expire_submission_with_http_info(submission_id)
|
|
1190
|
+
|
|
1191
|
+
```ruby
|
|
1192
|
+
begin
|
|
1193
|
+
# Expire a PDF submission
|
|
1194
|
+
data, status_code, headers = api_instance.expire_submission_with_http_info(submission_id)
|
|
1195
|
+
p status_code # => 2xx
|
|
1196
|
+
p headers # => { ... }
|
|
1197
|
+
p data # => <Submission>
|
|
1198
|
+
rescue DocSpring::ApiError => e
|
|
1199
|
+
puts "Error when calling PDFApi->expire_submission_with_http_info: #{e}"
|
|
866
1200
|
end
|
|
867
1201
|
```
|
|
868
1202
|
|
|
869
1203
|
### Parameters
|
|
870
1204
|
|
|
871
|
-
Name | Type | Description
|
|
872
|
-
|
|
873
|
-
**
|
|
1205
|
+
| Name | Type | Description | Notes |
|
|
1206
|
+
| ---- | ---- | ----------- | ----- |
|
|
1207
|
+
| **submission_id** | **String** | | |
|
|
874
1208
|
|
|
875
1209
|
### Return type
|
|
876
1210
|
|
|
877
|
-
[**
|
|
1211
|
+
[**Submission**](Submission.md)
|
|
878
1212
|
|
|
879
1213
|
### Authorization
|
|
880
1214
|
|
|
@@ -882,19 +1216,20 @@ Name | Type | Description | Notes
|
|
|
882
1216
|
|
|
883
1217
|
### HTTP request headers
|
|
884
1218
|
|
|
885
|
-
|
|
886
|
-
|
|
1219
|
+
- **Content-Type**: Not defined
|
|
1220
|
+
- **Accept**: application/json
|
|
887
1221
|
|
|
888
1222
|
|
|
1223
|
+
## generate_pdf
|
|
889
1224
|
|
|
890
|
-
|
|
891
|
-
> SubmissionDataRequest get_data_request(data_request_id)
|
|
1225
|
+
> <CreateSubmissionResponse> generate_pdf(template_id, submission)
|
|
892
1226
|
|
|
893
|
-
|
|
1227
|
+
Generates a new PDF
|
|
1228
|
+
|
|
1229
|
+
### Examples
|
|
894
1230
|
|
|
895
|
-
### Example
|
|
896
1231
|
```ruby
|
|
897
|
-
|
|
1232
|
+
require 'time'
|
|
898
1233
|
require 'docspring'
|
|
899
1234
|
# setup authorization
|
|
900
1235
|
DocSpring.configure do |config|
|
|
@@ -904,26 +1239,46 @@ DocSpring.configure do |config|
|
|
|
904
1239
|
end
|
|
905
1240
|
|
|
906
1241
|
api_instance = DocSpring::PDFApi.new
|
|
907
|
-
|
|
1242
|
+
template_id = 'tpl_000000000000000001' # String |
|
|
1243
|
+
submission = DocSpring::CreateSubmissionData.new({data: 3.56}) # CreateSubmissionData |
|
|
908
1244
|
|
|
909
1245
|
begin
|
|
910
|
-
#
|
|
911
|
-
result = api_instance.
|
|
1246
|
+
# Generates a new PDF
|
|
1247
|
+
result = api_instance.generate_pdf(template_id, submission)
|
|
912
1248
|
p result
|
|
913
1249
|
rescue DocSpring::ApiError => e
|
|
914
|
-
puts "
|
|
1250
|
+
puts "Error when calling PDFApi->generate_pdf: #{e}"
|
|
1251
|
+
end
|
|
1252
|
+
```
|
|
1253
|
+
|
|
1254
|
+
#### Using the generate_pdf_with_http_info variant
|
|
1255
|
+
|
|
1256
|
+
This returns an Array which contains the response data, status code and headers.
|
|
1257
|
+
|
|
1258
|
+
> <Array(<CreateSubmissionResponse>, Integer, Hash)> generate_pdf_with_http_info(template_id, submission)
|
|
1259
|
+
|
|
1260
|
+
```ruby
|
|
1261
|
+
begin
|
|
1262
|
+
# Generates a new PDF
|
|
1263
|
+
data, status_code, headers = api_instance.generate_pdf_with_http_info(template_id, submission)
|
|
1264
|
+
p status_code # => 2xx
|
|
1265
|
+
p headers # => { ... }
|
|
1266
|
+
p data # => <CreateSubmissionResponse>
|
|
1267
|
+
rescue DocSpring::ApiError => e
|
|
1268
|
+
puts "Error when calling PDFApi->generate_pdf_with_http_info: #{e}"
|
|
915
1269
|
end
|
|
916
1270
|
```
|
|
917
1271
|
|
|
918
1272
|
### Parameters
|
|
919
1273
|
|
|
920
|
-
Name | Type | Description
|
|
921
|
-
|
|
922
|
-
**
|
|
1274
|
+
| Name | Type | Description | Notes |
|
|
1275
|
+
| ---- | ---- | ----------- | ----- |
|
|
1276
|
+
| **template_id** | **String** | | |
|
|
1277
|
+
| **submission** | [**CreateSubmissionData**](CreateSubmissionData.md) | | |
|
|
923
1278
|
|
|
924
1279
|
### Return type
|
|
925
1280
|
|
|
926
|
-
[**
|
|
1281
|
+
[**CreateSubmissionResponse**](CreateSubmissionResponse.md)
|
|
927
1282
|
|
|
928
1283
|
### Authorization
|
|
929
1284
|
|
|
@@ -931,19 +1286,20 @@ Name | Type | Description | Notes
|
|
|
931
1286
|
|
|
932
1287
|
### HTTP request headers
|
|
933
1288
|
|
|
934
|
-
|
|
935
|
-
|
|
1289
|
+
- **Content-Type**: application/json
|
|
1290
|
+
- **Accept**: application/json
|
|
936
1291
|
|
|
937
1292
|
|
|
1293
|
+
## generate_preview
|
|
938
1294
|
|
|
939
|
-
|
|
940
|
-
> Template1 get_full_template(template_id)
|
|
1295
|
+
> <PreviewPdfResponse> generate_preview(submission_id)
|
|
941
1296
|
|
|
942
|
-
|
|
1297
|
+
Generated a preview PDF for partially completed data requests
|
|
1298
|
+
|
|
1299
|
+
### Examples
|
|
943
1300
|
|
|
944
|
-
### Example
|
|
945
1301
|
```ruby
|
|
946
|
-
|
|
1302
|
+
require 'time'
|
|
947
1303
|
require 'docspring'
|
|
948
1304
|
# setup authorization
|
|
949
1305
|
DocSpring.configure do |config|
|
|
@@ -953,26 +1309,248 @@ DocSpring.configure do |config|
|
|
|
953
1309
|
end
|
|
954
1310
|
|
|
955
1311
|
api_instance = DocSpring::PDFApi.new
|
|
956
|
-
|
|
1312
|
+
submission_id = 'sub_00000000000000001' # String |
|
|
957
1313
|
|
|
958
1314
|
begin
|
|
959
|
-
#
|
|
960
|
-
result = api_instance.
|
|
1315
|
+
# Generated a preview PDF for partially completed data requests
|
|
1316
|
+
result = api_instance.generate_preview(submission_id)
|
|
961
1317
|
p result
|
|
962
1318
|
rescue DocSpring::ApiError => e
|
|
963
|
-
puts "
|
|
1319
|
+
puts "Error when calling PDFApi->generate_preview: #{e}"
|
|
964
1320
|
end
|
|
965
1321
|
```
|
|
966
1322
|
|
|
967
|
-
|
|
1323
|
+
#### Using the generate_preview_with_http_info variant
|
|
968
1324
|
|
|
969
|
-
|
|
970
|
-
------------- | ------------- | ------------- | -------------
|
|
971
|
-
**template_id** | **String**| |
|
|
1325
|
+
This returns an Array which contains the response data, status code and headers.
|
|
972
1326
|
|
|
973
|
-
|
|
1327
|
+
> <Array(<PreviewPdfResponse>, Integer, Hash)> generate_preview_with_http_info(submission_id)
|
|
974
1328
|
|
|
975
|
-
|
|
1329
|
+
```ruby
|
|
1330
|
+
begin
|
|
1331
|
+
# Generated a preview PDF for partially completed data requests
|
|
1332
|
+
data, status_code, headers = api_instance.generate_preview_with_http_info(submission_id)
|
|
1333
|
+
p status_code # => 2xx
|
|
1334
|
+
p headers # => { ... }
|
|
1335
|
+
p data # => <PreviewPdfResponse>
|
|
1336
|
+
rescue DocSpring::ApiError => e
|
|
1337
|
+
puts "Error when calling PDFApi->generate_preview_with_http_info: #{e}"
|
|
1338
|
+
end
|
|
1339
|
+
```
|
|
1340
|
+
|
|
1341
|
+
### Parameters
|
|
1342
|
+
|
|
1343
|
+
| Name | Type | Description | Notes |
|
|
1344
|
+
| ---- | ---- | ----------- | ----- |
|
|
1345
|
+
| **submission_id** | **String** | | |
|
|
1346
|
+
|
|
1347
|
+
### Return type
|
|
1348
|
+
|
|
1349
|
+
[**PreviewPdfResponse**](PreviewPdfResponse.md)
|
|
1350
|
+
|
|
1351
|
+
### Authorization
|
|
1352
|
+
|
|
1353
|
+
[api_token_basic](../README.md#api_token_basic)
|
|
1354
|
+
|
|
1355
|
+
### HTTP request headers
|
|
1356
|
+
|
|
1357
|
+
- **Content-Type**: Not defined
|
|
1358
|
+
- **Accept**: application/json
|
|
1359
|
+
|
|
1360
|
+
|
|
1361
|
+
## get_combined_submission
|
|
1362
|
+
|
|
1363
|
+
> <CombinedSubmission> get_combined_submission(combined_submission_id)
|
|
1364
|
+
|
|
1365
|
+
Check the status of a combined submission (merged PDFs)
|
|
1366
|
+
|
|
1367
|
+
### Examples
|
|
1368
|
+
|
|
1369
|
+
```ruby
|
|
1370
|
+
require 'time'
|
|
1371
|
+
require 'docspring'
|
|
1372
|
+
# setup authorization
|
|
1373
|
+
DocSpring.configure do |config|
|
|
1374
|
+
# Configure HTTP basic authorization: api_token_basic
|
|
1375
|
+
config.username = 'YOUR USERNAME'
|
|
1376
|
+
config.password = 'YOUR PASSWORD'
|
|
1377
|
+
end
|
|
1378
|
+
|
|
1379
|
+
api_instance = DocSpring::PDFApi.new
|
|
1380
|
+
combined_submission_id = 'com_0000000000000000001' # String |
|
|
1381
|
+
|
|
1382
|
+
begin
|
|
1383
|
+
# Check the status of a combined submission (merged PDFs)
|
|
1384
|
+
result = api_instance.get_combined_submission(combined_submission_id)
|
|
1385
|
+
p result
|
|
1386
|
+
rescue DocSpring::ApiError => e
|
|
1387
|
+
puts "Error when calling PDFApi->get_combined_submission: #{e}"
|
|
1388
|
+
end
|
|
1389
|
+
```
|
|
1390
|
+
|
|
1391
|
+
#### Using the get_combined_submission_with_http_info variant
|
|
1392
|
+
|
|
1393
|
+
This returns an Array which contains the response data, status code and headers.
|
|
1394
|
+
|
|
1395
|
+
> <Array(<CombinedSubmission>, Integer, Hash)> get_combined_submission_with_http_info(combined_submission_id)
|
|
1396
|
+
|
|
1397
|
+
```ruby
|
|
1398
|
+
begin
|
|
1399
|
+
# Check the status of a combined submission (merged PDFs)
|
|
1400
|
+
data, status_code, headers = api_instance.get_combined_submission_with_http_info(combined_submission_id)
|
|
1401
|
+
p status_code # => 2xx
|
|
1402
|
+
p headers # => { ... }
|
|
1403
|
+
p data # => <CombinedSubmission>
|
|
1404
|
+
rescue DocSpring::ApiError => e
|
|
1405
|
+
puts "Error when calling PDFApi->get_combined_submission_with_http_info: #{e}"
|
|
1406
|
+
end
|
|
1407
|
+
```
|
|
1408
|
+
|
|
1409
|
+
### Parameters
|
|
1410
|
+
|
|
1411
|
+
| Name | Type | Description | Notes |
|
|
1412
|
+
| ---- | ---- | ----------- | ----- |
|
|
1413
|
+
| **combined_submission_id** | **String** | | |
|
|
1414
|
+
|
|
1415
|
+
### Return type
|
|
1416
|
+
|
|
1417
|
+
[**CombinedSubmission**](CombinedSubmission.md)
|
|
1418
|
+
|
|
1419
|
+
### Authorization
|
|
1420
|
+
|
|
1421
|
+
[api_token_basic](../README.md#api_token_basic)
|
|
1422
|
+
|
|
1423
|
+
### HTTP request headers
|
|
1424
|
+
|
|
1425
|
+
- **Content-Type**: Not defined
|
|
1426
|
+
- **Accept**: application/json
|
|
1427
|
+
|
|
1428
|
+
|
|
1429
|
+
## get_data_request
|
|
1430
|
+
|
|
1431
|
+
> <SubmissionDataRequest> get_data_request(data_request_id)
|
|
1432
|
+
|
|
1433
|
+
Look up a submission data request
|
|
1434
|
+
|
|
1435
|
+
### Examples
|
|
1436
|
+
|
|
1437
|
+
```ruby
|
|
1438
|
+
require 'time'
|
|
1439
|
+
require 'docspring'
|
|
1440
|
+
# setup authorization
|
|
1441
|
+
DocSpring.configure do |config|
|
|
1442
|
+
# Configure HTTP basic authorization: api_token_basic
|
|
1443
|
+
config.username = 'YOUR USERNAME'
|
|
1444
|
+
config.password = 'YOUR PASSWORD'
|
|
1445
|
+
end
|
|
1446
|
+
|
|
1447
|
+
api_instance = DocSpring::PDFApi.new
|
|
1448
|
+
data_request_id = 'drq_000000000000000001' # String |
|
|
1449
|
+
|
|
1450
|
+
begin
|
|
1451
|
+
# Look up a submission data request
|
|
1452
|
+
result = api_instance.get_data_request(data_request_id)
|
|
1453
|
+
p result
|
|
1454
|
+
rescue DocSpring::ApiError => e
|
|
1455
|
+
puts "Error when calling PDFApi->get_data_request: #{e}"
|
|
1456
|
+
end
|
|
1457
|
+
```
|
|
1458
|
+
|
|
1459
|
+
#### Using the get_data_request_with_http_info variant
|
|
1460
|
+
|
|
1461
|
+
This returns an Array which contains the response data, status code and headers.
|
|
1462
|
+
|
|
1463
|
+
> <Array(<SubmissionDataRequest>, Integer, Hash)> get_data_request_with_http_info(data_request_id)
|
|
1464
|
+
|
|
1465
|
+
```ruby
|
|
1466
|
+
begin
|
|
1467
|
+
# Look up a submission data request
|
|
1468
|
+
data, status_code, headers = api_instance.get_data_request_with_http_info(data_request_id)
|
|
1469
|
+
p status_code # => 2xx
|
|
1470
|
+
p headers # => { ... }
|
|
1471
|
+
p data # => <SubmissionDataRequest>
|
|
1472
|
+
rescue DocSpring::ApiError => e
|
|
1473
|
+
puts "Error when calling PDFApi->get_data_request_with_http_info: #{e}"
|
|
1474
|
+
end
|
|
1475
|
+
```
|
|
1476
|
+
|
|
1477
|
+
### Parameters
|
|
1478
|
+
|
|
1479
|
+
| Name | Type | Description | Notes |
|
|
1480
|
+
| ---- | ---- | ----------- | ----- |
|
|
1481
|
+
| **data_request_id** | **String** | | |
|
|
1482
|
+
|
|
1483
|
+
### Return type
|
|
1484
|
+
|
|
1485
|
+
[**SubmissionDataRequest**](SubmissionDataRequest.md)
|
|
1486
|
+
|
|
1487
|
+
### Authorization
|
|
1488
|
+
|
|
1489
|
+
[api_token_basic](../README.md#api_token_basic)
|
|
1490
|
+
|
|
1491
|
+
### HTTP request headers
|
|
1492
|
+
|
|
1493
|
+
- **Content-Type**: Not defined
|
|
1494
|
+
- **Accept**: application/json
|
|
1495
|
+
|
|
1496
|
+
|
|
1497
|
+
## get_full_template
|
|
1498
|
+
|
|
1499
|
+
> <FullTemplate> get_full_template(template_id)
|
|
1500
|
+
|
|
1501
|
+
Fetch the full template attributes
|
|
1502
|
+
|
|
1503
|
+
### Examples
|
|
1504
|
+
|
|
1505
|
+
```ruby
|
|
1506
|
+
require 'time'
|
|
1507
|
+
require 'docspring'
|
|
1508
|
+
# setup authorization
|
|
1509
|
+
DocSpring.configure do |config|
|
|
1510
|
+
# Configure HTTP basic authorization: api_token_basic
|
|
1511
|
+
config.username = 'YOUR USERNAME'
|
|
1512
|
+
config.password = 'YOUR PASSWORD'
|
|
1513
|
+
end
|
|
1514
|
+
|
|
1515
|
+
api_instance = DocSpring::PDFApi.new
|
|
1516
|
+
template_id = 'tpl_000000000000000001' # String |
|
|
1517
|
+
|
|
1518
|
+
begin
|
|
1519
|
+
# Fetch the full template attributes
|
|
1520
|
+
result = api_instance.get_full_template(template_id)
|
|
1521
|
+
p result
|
|
1522
|
+
rescue DocSpring::ApiError => e
|
|
1523
|
+
puts "Error when calling PDFApi->get_full_template: #{e}"
|
|
1524
|
+
end
|
|
1525
|
+
```
|
|
1526
|
+
|
|
1527
|
+
#### Using the get_full_template_with_http_info variant
|
|
1528
|
+
|
|
1529
|
+
This returns an Array which contains the response data, status code and headers.
|
|
1530
|
+
|
|
1531
|
+
> <Array(<FullTemplate>, Integer, Hash)> get_full_template_with_http_info(template_id)
|
|
1532
|
+
|
|
1533
|
+
```ruby
|
|
1534
|
+
begin
|
|
1535
|
+
# Fetch the full template attributes
|
|
1536
|
+
data, status_code, headers = api_instance.get_full_template_with_http_info(template_id)
|
|
1537
|
+
p status_code # => 2xx
|
|
1538
|
+
p headers # => { ... }
|
|
1539
|
+
p data # => <FullTemplate>
|
|
1540
|
+
rescue DocSpring::ApiError => e
|
|
1541
|
+
puts "Error when calling PDFApi->get_full_template_with_http_info: #{e}"
|
|
1542
|
+
end
|
|
1543
|
+
```
|
|
1544
|
+
|
|
1545
|
+
### Parameters
|
|
1546
|
+
|
|
1547
|
+
| Name | Type | Description | Notes |
|
|
1548
|
+
| ---- | ---- | ----------- | ----- |
|
|
1549
|
+
| **template_id** | **String** | | |
|
|
1550
|
+
|
|
1551
|
+
### Return type
|
|
1552
|
+
|
|
1553
|
+
[**FullTemplate**](FullTemplate.md)
|
|
976
1554
|
|
|
977
1555
|
### Authorization
|
|
978
1556
|
|
|
@@ -980,19 +1558,20 @@ Name | Type | Description | Notes
|
|
|
980
1558
|
|
|
981
1559
|
### HTTP request headers
|
|
982
1560
|
|
|
983
|
-
|
|
984
|
-
|
|
1561
|
+
- **Content-Type**: Not defined
|
|
1562
|
+
- **Accept**: application/json
|
|
985
1563
|
|
|
986
1564
|
|
|
1565
|
+
## get_presign_url
|
|
987
1566
|
|
|
988
|
-
|
|
989
|
-
> Hash<String, Object> get_presign_url
|
|
1567
|
+
> <UploadPresign> get_presign_url
|
|
990
1568
|
|
|
991
1569
|
Get a presigned URL so that you can upload a file to our AWS S3 bucket
|
|
992
1570
|
|
|
993
|
-
###
|
|
1571
|
+
### Examples
|
|
1572
|
+
|
|
994
1573
|
```ruby
|
|
995
|
-
|
|
1574
|
+
require 'time'
|
|
996
1575
|
require 'docspring'
|
|
997
1576
|
# setup authorization
|
|
998
1577
|
DocSpring.configure do |config|
|
|
@@ -1004,20 +1583,39 @@ end
|
|
|
1004
1583
|
api_instance = DocSpring::PDFApi.new
|
|
1005
1584
|
|
|
1006
1585
|
begin
|
|
1007
|
-
#Get a presigned URL so that you can upload a file to our AWS S3 bucket
|
|
1586
|
+
# Get a presigned URL so that you can upload a file to our AWS S3 bucket
|
|
1008
1587
|
result = api_instance.get_presign_url
|
|
1009
1588
|
p result
|
|
1010
1589
|
rescue DocSpring::ApiError => e
|
|
1011
|
-
puts "
|
|
1590
|
+
puts "Error when calling PDFApi->get_presign_url: #{e}"
|
|
1591
|
+
end
|
|
1592
|
+
```
|
|
1593
|
+
|
|
1594
|
+
#### Using the get_presign_url_with_http_info variant
|
|
1595
|
+
|
|
1596
|
+
This returns an Array which contains the response data, status code and headers.
|
|
1597
|
+
|
|
1598
|
+
> <Array(<UploadPresign>, Integer, Hash)> get_presign_url_with_http_info
|
|
1599
|
+
|
|
1600
|
+
```ruby
|
|
1601
|
+
begin
|
|
1602
|
+
# Get a presigned URL so that you can upload a file to our AWS S3 bucket
|
|
1603
|
+
data, status_code, headers = api_instance.get_presign_url_with_http_info
|
|
1604
|
+
p status_code # => 2xx
|
|
1605
|
+
p headers # => { ... }
|
|
1606
|
+
p data # => <UploadPresign>
|
|
1607
|
+
rescue DocSpring::ApiError => e
|
|
1608
|
+
puts "Error when calling PDFApi->get_presign_url_with_http_info: #{e}"
|
|
1012
1609
|
end
|
|
1013
1610
|
```
|
|
1014
1611
|
|
|
1015
1612
|
### Parameters
|
|
1613
|
+
|
|
1016
1614
|
This endpoint does not need any parameter.
|
|
1017
1615
|
|
|
1018
1616
|
### Return type
|
|
1019
1617
|
|
|
1020
|
-
**
|
|
1618
|
+
[**UploadPresign**](UploadPresign.md)
|
|
1021
1619
|
|
|
1022
1620
|
### Authorization
|
|
1023
1621
|
|
|
@@ -1025,19 +1623,20 @@ This endpoint does not need any parameter.
|
|
|
1025
1623
|
|
|
1026
1624
|
### HTTP request headers
|
|
1027
1625
|
|
|
1028
|
-
|
|
1029
|
-
|
|
1626
|
+
- **Content-Type**: Not defined
|
|
1627
|
+
- **Accept**: application/json
|
|
1030
1628
|
|
|
1031
1629
|
|
|
1630
|
+
## get_submission
|
|
1032
1631
|
|
|
1033
|
-
|
|
1034
|
-
> Submission get_submission(submission_id, opts)
|
|
1632
|
+
> <Submission> get_submission(submission_id, opts)
|
|
1035
1633
|
|
|
1036
1634
|
Check the status of a PDF
|
|
1037
1635
|
|
|
1038
|
-
###
|
|
1636
|
+
### Examples
|
|
1637
|
+
|
|
1039
1638
|
```ruby
|
|
1040
|
-
|
|
1639
|
+
require 'time'
|
|
1041
1640
|
require 'docspring'
|
|
1042
1641
|
# setup authorization
|
|
1043
1642
|
DocSpring.configure do |config|
|
|
@@ -1049,24 +1648,42 @@ end
|
|
|
1049
1648
|
api_instance = DocSpring::PDFApi.new
|
|
1050
1649
|
submission_id = 'sub_000000000000000001' # String |
|
|
1051
1650
|
opts = {
|
|
1052
|
-
include_data: true #
|
|
1651
|
+
include_data: true # Boolean |
|
|
1053
1652
|
}
|
|
1054
1653
|
|
|
1055
1654
|
begin
|
|
1056
|
-
#Check the status of a PDF
|
|
1655
|
+
# Check the status of a PDF
|
|
1057
1656
|
result = api_instance.get_submission(submission_id, opts)
|
|
1058
1657
|
p result
|
|
1059
1658
|
rescue DocSpring::ApiError => e
|
|
1060
|
-
puts "
|
|
1659
|
+
puts "Error when calling PDFApi->get_submission: #{e}"
|
|
1660
|
+
end
|
|
1661
|
+
```
|
|
1662
|
+
|
|
1663
|
+
#### Using the get_submission_with_http_info variant
|
|
1664
|
+
|
|
1665
|
+
This returns an Array which contains the response data, status code and headers.
|
|
1666
|
+
|
|
1667
|
+
> <Array(<Submission>, Integer, Hash)> get_submission_with_http_info(submission_id, opts)
|
|
1668
|
+
|
|
1669
|
+
```ruby
|
|
1670
|
+
begin
|
|
1671
|
+
# Check the status of a PDF
|
|
1672
|
+
data, status_code, headers = api_instance.get_submission_with_http_info(submission_id, opts)
|
|
1673
|
+
p status_code # => 2xx
|
|
1674
|
+
p headers # => { ... }
|
|
1675
|
+
p data # => <Submission>
|
|
1676
|
+
rescue DocSpring::ApiError => e
|
|
1677
|
+
puts "Error when calling PDFApi->get_submission_with_http_info: #{e}"
|
|
1061
1678
|
end
|
|
1062
1679
|
```
|
|
1063
1680
|
|
|
1064
1681
|
### Parameters
|
|
1065
1682
|
|
|
1066
|
-
Name | Type | Description
|
|
1067
|
-
|
|
1068
|
-
**submission_id** | **String
|
|
1069
|
-
**include_data** | **
|
|
1683
|
+
| Name | Type | Description | Notes |
|
|
1684
|
+
| ---- | ---- | ----------- | ----- |
|
|
1685
|
+
| **submission_id** | **String** | | |
|
|
1686
|
+
| **include_data** | **Boolean** | | [optional] |
|
|
1070
1687
|
|
|
1071
1688
|
### Return type
|
|
1072
1689
|
|
|
@@ -1078,19 +1695,20 @@ Name | Type | Description | Notes
|
|
|
1078
1695
|
|
|
1079
1696
|
### HTTP request headers
|
|
1080
1697
|
|
|
1081
|
-
|
|
1082
|
-
|
|
1698
|
+
- **Content-Type**: Not defined
|
|
1699
|
+
- **Accept**: application/json
|
|
1083
1700
|
|
|
1084
1701
|
|
|
1702
|
+
## get_submission_batch
|
|
1085
1703
|
|
|
1086
|
-
|
|
1087
|
-
> SubmissionBatch get_submission_batch(submission_batch_id, opts)
|
|
1704
|
+
> <SubmissionBatch> get_submission_batch(submission_batch_id, opts)
|
|
1088
1705
|
|
|
1089
1706
|
Check the status of a submission batch job
|
|
1090
1707
|
|
|
1091
|
-
###
|
|
1708
|
+
### Examples
|
|
1709
|
+
|
|
1092
1710
|
```ruby
|
|
1093
|
-
|
|
1711
|
+
require 'time'
|
|
1094
1712
|
require 'docspring'
|
|
1095
1713
|
# setup authorization
|
|
1096
1714
|
DocSpring.configure do |config|
|
|
@@ -1102,24 +1720,42 @@ end
|
|
|
1102
1720
|
api_instance = DocSpring::PDFApi.new
|
|
1103
1721
|
submission_batch_id = 'sbb_000000000000000001' # String |
|
|
1104
1722
|
opts = {
|
|
1105
|
-
include_submissions: true #
|
|
1723
|
+
include_submissions: true # Boolean |
|
|
1106
1724
|
}
|
|
1107
1725
|
|
|
1108
1726
|
begin
|
|
1109
|
-
#Check the status of a submission batch job
|
|
1727
|
+
# Check the status of a submission batch job
|
|
1110
1728
|
result = api_instance.get_submission_batch(submission_batch_id, opts)
|
|
1111
1729
|
p result
|
|
1112
1730
|
rescue DocSpring::ApiError => e
|
|
1113
|
-
puts "
|
|
1731
|
+
puts "Error when calling PDFApi->get_submission_batch: #{e}"
|
|
1732
|
+
end
|
|
1733
|
+
```
|
|
1734
|
+
|
|
1735
|
+
#### Using the get_submission_batch_with_http_info variant
|
|
1736
|
+
|
|
1737
|
+
This returns an Array which contains the response data, status code and headers.
|
|
1738
|
+
|
|
1739
|
+
> <Array(<SubmissionBatch>, Integer, Hash)> get_submission_batch_with_http_info(submission_batch_id, opts)
|
|
1740
|
+
|
|
1741
|
+
```ruby
|
|
1742
|
+
begin
|
|
1743
|
+
# Check the status of a submission batch job
|
|
1744
|
+
data, status_code, headers = api_instance.get_submission_batch_with_http_info(submission_batch_id, opts)
|
|
1745
|
+
p status_code # => 2xx
|
|
1746
|
+
p headers # => { ... }
|
|
1747
|
+
p data # => <SubmissionBatch>
|
|
1748
|
+
rescue DocSpring::ApiError => e
|
|
1749
|
+
puts "Error when calling PDFApi->get_submission_batch_with_http_info: #{e}"
|
|
1114
1750
|
end
|
|
1115
1751
|
```
|
|
1116
1752
|
|
|
1117
1753
|
### Parameters
|
|
1118
1754
|
|
|
1119
|
-
Name | Type | Description
|
|
1120
|
-
|
|
1121
|
-
**submission_batch_id** | **String
|
|
1122
|
-
**include_submissions** | **
|
|
1755
|
+
| Name | Type | Description | Notes |
|
|
1756
|
+
| ---- | ---- | ----------- | ----- |
|
|
1757
|
+
| **submission_batch_id** | **String** | | |
|
|
1758
|
+
| **include_submissions** | **Boolean** | | [optional] |
|
|
1123
1759
|
|
|
1124
1760
|
### Return type
|
|
1125
1761
|
|
|
@@ -1131,19 +1767,20 @@ Name | Type | Description | Notes
|
|
|
1131
1767
|
|
|
1132
1768
|
### HTTP request headers
|
|
1133
1769
|
|
|
1134
|
-
|
|
1135
|
-
|
|
1770
|
+
- **Content-Type**: Not defined
|
|
1771
|
+
- **Accept**: application/json
|
|
1136
1772
|
|
|
1137
1773
|
|
|
1774
|
+
## get_template
|
|
1138
1775
|
|
|
1139
|
-
|
|
1140
|
-
> Template get_template(template_id)
|
|
1776
|
+
> <Template> get_template(template_id)
|
|
1141
1777
|
|
|
1142
1778
|
Check the status of an uploaded template
|
|
1143
1779
|
|
|
1144
|
-
###
|
|
1780
|
+
### Examples
|
|
1781
|
+
|
|
1145
1782
|
```ruby
|
|
1146
|
-
|
|
1783
|
+
require 'time'
|
|
1147
1784
|
require 'docspring'
|
|
1148
1785
|
# setup authorization
|
|
1149
1786
|
DocSpring.configure do |config|
|
|
@@ -1156,19 +1793,37 @@ api_instance = DocSpring::PDFApi.new
|
|
|
1156
1793
|
template_id = 'tpl_000000000000000001' # String |
|
|
1157
1794
|
|
|
1158
1795
|
begin
|
|
1159
|
-
#Check the status of an uploaded template
|
|
1796
|
+
# Check the status of an uploaded template
|
|
1160
1797
|
result = api_instance.get_template(template_id)
|
|
1161
1798
|
p result
|
|
1162
1799
|
rescue DocSpring::ApiError => e
|
|
1163
|
-
puts "
|
|
1800
|
+
puts "Error when calling PDFApi->get_template: #{e}"
|
|
1801
|
+
end
|
|
1802
|
+
```
|
|
1803
|
+
|
|
1804
|
+
#### Using the get_template_with_http_info variant
|
|
1805
|
+
|
|
1806
|
+
This returns an Array which contains the response data, status code and headers.
|
|
1807
|
+
|
|
1808
|
+
> <Array(<Template>, Integer, Hash)> get_template_with_http_info(template_id)
|
|
1809
|
+
|
|
1810
|
+
```ruby
|
|
1811
|
+
begin
|
|
1812
|
+
# Check the status of an uploaded template
|
|
1813
|
+
data, status_code, headers = api_instance.get_template_with_http_info(template_id)
|
|
1814
|
+
p status_code # => 2xx
|
|
1815
|
+
p headers # => { ... }
|
|
1816
|
+
p data # => <Template>
|
|
1817
|
+
rescue DocSpring::ApiError => e
|
|
1818
|
+
puts "Error when calling PDFApi->get_template_with_http_info: #{e}"
|
|
1164
1819
|
end
|
|
1165
1820
|
```
|
|
1166
1821
|
|
|
1167
1822
|
### Parameters
|
|
1168
1823
|
|
|
1169
|
-
Name | Type | Description
|
|
1170
|
-
|
|
1171
|
-
**template_id** | **String
|
|
1824
|
+
| Name | Type | Description | Notes |
|
|
1825
|
+
| ---- | ---- | ----------- | ----- |
|
|
1826
|
+
| **template_id** | **String** | | |
|
|
1172
1827
|
|
|
1173
1828
|
### Return type
|
|
1174
1829
|
|
|
@@ -1180,19 +1835,20 @@ Name | Type | Description | Notes
|
|
|
1180
1835
|
|
|
1181
1836
|
### HTTP request headers
|
|
1182
1837
|
|
|
1183
|
-
|
|
1184
|
-
|
|
1838
|
+
- **Content-Type**: Not defined
|
|
1839
|
+
- **Accept**: application/json
|
|
1185
1840
|
|
|
1186
1841
|
|
|
1842
|
+
## get_template_schema
|
|
1187
1843
|
|
|
1188
|
-
|
|
1189
|
-
> Hash<String, Object> get_template_schema(template_id)
|
|
1844
|
+
> <TemplateSchema> get_template_schema(template_id)
|
|
1190
1845
|
|
|
1191
1846
|
Fetch the JSON schema for a template
|
|
1192
1847
|
|
|
1193
|
-
###
|
|
1848
|
+
### Examples
|
|
1849
|
+
|
|
1194
1850
|
```ruby
|
|
1195
|
-
|
|
1851
|
+
require 'time'
|
|
1196
1852
|
require 'docspring'
|
|
1197
1853
|
# setup authorization
|
|
1198
1854
|
DocSpring.configure do |config|
|
|
@@ -1205,23 +1861,113 @@ api_instance = DocSpring::PDFApi.new
|
|
|
1205
1861
|
template_id = 'tpl_000000000000000001' # String |
|
|
1206
1862
|
|
|
1207
1863
|
begin
|
|
1208
|
-
#Fetch the JSON schema for a template
|
|
1864
|
+
# Fetch the JSON schema for a template
|
|
1209
1865
|
result = api_instance.get_template_schema(template_id)
|
|
1210
1866
|
p result
|
|
1211
1867
|
rescue DocSpring::ApiError => e
|
|
1212
|
-
puts "
|
|
1868
|
+
puts "Error when calling PDFApi->get_template_schema: #{e}"
|
|
1869
|
+
end
|
|
1870
|
+
```
|
|
1871
|
+
|
|
1872
|
+
#### Using the get_template_schema_with_http_info variant
|
|
1873
|
+
|
|
1874
|
+
This returns an Array which contains the response data, status code and headers.
|
|
1875
|
+
|
|
1876
|
+
> <Array(<TemplateSchema>, Integer, Hash)> get_template_schema_with_http_info(template_id)
|
|
1877
|
+
|
|
1878
|
+
```ruby
|
|
1879
|
+
begin
|
|
1880
|
+
# Fetch the JSON schema for a template
|
|
1881
|
+
data, status_code, headers = api_instance.get_template_schema_with_http_info(template_id)
|
|
1882
|
+
p status_code # => 2xx
|
|
1883
|
+
p headers # => { ... }
|
|
1884
|
+
p data # => <TemplateSchema>
|
|
1885
|
+
rescue DocSpring::ApiError => e
|
|
1886
|
+
puts "Error when calling PDFApi->get_template_schema_with_http_info: #{e}"
|
|
1887
|
+
end
|
|
1888
|
+
```
|
|
1889
|
+
|
|
1890
|
+
### Parameters
|
|
1891
|
+
|
|
1892
|
+
| Name | Type | Description | Notes |
|
|
1893
|
+
| ---- | ---- | ----------- | ----- |
|
|
1894
|
+
| **template_id** | **String** | | |
|
|
1895
|
+
|
|
1896
|
+
### Return type
|
|
1897
|
+
|
|
1898
|
+
[**TemplateSchema**](TemplateSchema.md)
|
|
1899
|
+
|
|
1900
|
+
### Authorization
|
|
1901
|
+
|
|
1902
|
+
[api_token_basic](../README.md#api_token_basic)
|
|
1903
|
+
|
|
1904
|
+
### HTTP request headers
|
|
1905
|
+
|
|
1906
|
+
- **Content-Type**: Not defined
|
|
1907
|
+
- **Accept**: application/json
|
|
1908
|
+
|
|
1909
|
+
|
|
1910
|
+
## list_combined_submissions
|
|
1911
|
+
|
|
1912
|
+
> <Array<CombinedSubmission>> list_combined_submissions(opts)
|
|
1913
|
+
|
|
1914
|
+
Get a list of all combined submissions
|
|
1915
|
+
|
|
1916
|
+
### Examples
|
|
1917
|
+
|
|
1918
|
+
```ruby
|
|
1919
|
+
require 'time'
|
|
1920
|
+
require 'docspring'
|
|
1921
|
+
# setup authorization
|
|
1922
|
+
DocSpring.configure do |config|
|
|
1923
|
+
# Configure HTTP basic authorization: api_token_basic
|
|
1924
|
+
config.username = 'YOUR USERNAME'
|
|
1925
|
+
config.password = 'YOUR PASSWORD'
|
|
1926
|
+
end
|
|
1927
|
+
|
|
1928
|
+
api_instance = DocSpring::PDFApi.new
|
|
1929
|
+
opts = {
|
|
1930
|
+
page: 2, # Integer | Default: 1
|
|
1931
|
+
per_page: 1 # Integer | Default: 50
|
|
1932
|
+
}
|
|
1933
|
+
|
|
1934
|
+
begin
|
|
1935
|
+
# Get a list of all combined submissions
|
|
1936
|
+
result = api_instance.list_combined_submissions(opts)
|
|
1937
|
+
p result
|
|
1938
|
+
rescue DocSpring::ApiError => e
|
|
1939
|
+
puts "Error when calling PDFApi->list_combined_submissions: #{e}"
|
|
1940
|
+
end
|
|
1941
|
+
```
|
|
1942
|
+
|
|
1943
|
+
#### Using the list_combined_submissions_with_http_info variant
|
|
1944
|
+
|
|
1945
|
+
This returns an Array which contains the response data, status code and headers.
|
|
1946
|
+
|
|
1947
|
+
> <Array(<Array<CombinedSubmission>>, Integer, Hash)> list_combined_submissions_with_http_info(opts)
|
|
1948
|
+
|
|
1949
|
+
```ruby
|
|
1950
|
+
begin
|
|
1951
|
+
# Get a list of all combined submissions
|
|
1952
|
+
data, status_code, headers = api_instance.list_combined_submissions_with_http_info(opts)
|
|
1953
|
+
p status_code # => 2xx
|
|
1954
|
+
p headers # => { ... }
|
|
1955
|
+
p data # => <Array<CombinedSubmission>>
|
|
1956
|
+
rescue DocSpring::ApiError => e
|
|
1957
|
+
puts "Error when calling PDFApi->list_combined_submissions_with_http_info: #{e}"
|
|
1213
1958
|
end
|
|
1214
1959
|
```
|
|
1215
1960
|
|
|
1216
1961
|
### Parameters
|
|
1217
1962
|
|
|
1218
|
-
Name | Type | Description
|
|
1219
|
-
|
|
1220
|
-
**
|
|
1963
|
+
| Name | Type | Description | Notes |
|
|
1964
|
+
| ---- | ---- | ----------- | ----- |
|
|
1965
|
+
| **page** | **Integer** | Default: 1 | [optional] |
|
|
1966
|
+
| **per_page** | **Integer** | Default: 50 | [optional] |
|
|
1221
1967
|
|
|
1222
1968
|
### Return type
|
|
1223
1969
|
|
|
1224
|
-
**
|
|
1970
|
+
[**Array<CombinedSubmission>**](CombinedSubmission.md)
|
|
1225
1971
|
|
|
1226
1972
|
### Authorization
|
|
1227
1973
|
|
|
@@ -1229,19 +1975,20 @@ Name | Type | Description | Notes
|
|
|
1229
1975
|
|
|
1230
1976
|
### HTTP request headers
|
|
1231
1977
|
|
|
1232
|
-
|
|
1233
|
-
|
|
1978
|
+
- **Content-Type**: Not defined
|
|
1979
|
+
- **Accept**: application/json
|
|
1234
1980
|
|
|
1235
1981
|
|
|
1982
|
+
## list_folders
|
|
1236
1983
|
|
|
1237
|
-
|
|
1238
|
-
> Array<Folder> list_folders(opts)
|
|
1984
|
+
> <Array<Folder>> list_folders(opts)
|
|
1239
1985
|
|
|
1240
1986
|
Get a list of all folders
|
|
1241
1987
|
|
|
1242
|
-
###
|
|
1988
|
+
### Examples
|
|
1989
|
+
|
|
1243
1990
|
```ruby
|
|
1244
|
-
|
|
1991
|
+
require 'time'
|
|
1245
1992
|
require 'docspring'
|
|
1246
1993
|
# setup authorization
|
|
1247
1994
|
DocSpring.configure do |config|
|
|
@@ -1252,23 +1999,41 @@ end
|
|
|
1252
1999
|
|
|
1253
2000
|
api_instance = DocSpring::PDFApi.new
|
|
1254
2001
|
opts = {
|
|
1255
|
-
parent_folder_id: '
|
|
2002
|
+
parent_folder_id: 'fld_0000000000000000002' # String | Filter By Folder Id
|
|
1256
2003
|
}
|
|
1257
2004
|
|
|
1258
2005
|
begin
|
|
1259
|
-
#Get a list of all folders
|
|
2006
|
+
# Get a list of all folders
|
|
1260
2007
|
result = api_instance.list_folders(opts)
|
|
1261
2008
|
p result
|
|
1262
2009
|
rescue DocSpring::ApiError => e
|
|
1263
|
-
puts "
|
|
2010
|
+
puts "Error when calling PDFApi->list_folders: #{e}"
|
|
2011
|
+
end
|
|
2012
|
+
```
|
|
2013
|
+
|
|
2014
|
+
#### Using the list_folders_with_http_info variant
|
|
2015
|
+
|
|
2016
|
+
This returns an Array which contains the response data, status code and headers.
|
|
2017
|
+
|
|
2018
|
+
> <Array(<Array<Folder>>, Integer, Hash)> list_folders_with_http_info(opts)
|
|
2019
|
+
|
|
2020
|
+
```ruby
|
|
2021
|
+
begin
|
|
2022
|
+
# Get a list of all folders
|
|
2023
|
+
data, status_code, headers = api_instance.list_folders_with_http_info(opts)
|
|
2024
|
+
p status_code # => 2xx
|
|
2025
|
+
p headers # => { ... }
|
|
2026
|
+
p data # => <Array<Folder>>
|
|
2027
|
+
rescue DocSpring::ApiError => e
|
|
2028
|
+
puts "Error when calling PDFApi->list_folders_with_http_info: #{e}"
|
|
1264
2029
|
end
|
|
1265
2030
|
```
|
|
1266
2031
|
|
|
1267
2032
|
### Parameters
|
|
1268
2033
|
|
|
1269
|
-
Name | Type | Description
|
|
1270
|
-
|
|
1271
|
-
**parent_folder_id** | **String
|
|
2034
|
+
| Name | Type | Description | Notes |
|
|
2035
|
+
| ---- | ---- | ----------- | ----- |
|
|
2036
|
+
| **parent_folder_id** | **String** | Filter By Folder Id | [optional] |
|
|
1272
2037
|
|
|
1273
2038
|
### Return type
|
|
1274
2039
|
|
|
@@ -1280,19 +2045,20 @@ Name | Type | Description | Notes
|
|
|
1280
2045
|
|
|
1281
2046
|
### HTTP request headers
|
|
1282
2047
|
|
|
1283
|
-
|
|
1284
|
-
|
|
2048
|
+
- **Content-Type**: Not defined
|
|
2049
|
+
- **Accept**: application/json
|
|
1285
2050
|
|
|
1286
2051
|
|
|
2052
|
+
## list_submissions
|
|
1287
2053
|
|
|
1288
|
-
|
|
1289
|
-
> ListSubmissionsResponse list_submissions(opts)
|
|
2054
|
+
> <ListSubmissionsResponse> list_submissions(opts)
|
|
1290
2055
|
|
|
1291
2056
|
List all submissions
|
|
1292
2057
|
|
|
1293
|
-
###
|
|
2058
|
+
### Examples
|
|
2059
|
+
|
|
1294
2060
|
```ruby
|
|
1295
|
-
|
|
2061
|
+
require 'time'
|
|
1296
2062
|
require 'docspring'
|
|
1297
2063
|
# setup authorization
|
|
1298
2064
|
DocSpring.configure do |config|
|
|
@@ -1306,30 +2072,48 @@ opts = {
|
|
|
1306
2072
|
cursor: 'sub_list_000012', # String |
|
|
1307
2073
|
limit: 3, # Float |
|
|
1308
2074
|
created_after: '2019-01-01T09:00:00-05:00', # String |
|
|
1309
|
-
created_before: '2020-01-01T09:00:00
|
|
2075
|
+
created_before: '2020-01-01T09:00:00.000+0200', # String |
|
|
1310
2076
|
type: 'test', # String |
|
|
1311
|
-
include_data: true #
|
|
2077
|
+
include_data: true # Boolean |
|
|
1312
2078
|
}
|
|
1313
2079
|
|
|
1314
2080
|
begin
|
|
1315
|
-
#List all submissions
|
|
2081
|
+
# List all submissions
|
|
1316
2082
|
result = api_instance.list_submissions(opts)
|
|
1317
2083
|
p result
|
|
1318
2084
|
rescue DocSpring::ApiError => e
|
|
1319
|
-
puts "
|
|
2085
|
+
puts "Error when calling PDFApi->list_submissions: #{e}"
|
|
2086
|
+
end
|
|
2087
|
+
```
|
|
2088
|
+
|
|
2089
|
+
#### Using the list_submissions_with_http_info variant
|
|
2090
|
+
|
|
2091
|
+
This returns an Array which contains the response data, status code and headers.
|
|
2092
|
+
|
|
2093
|
+
> <Array(<ListSubmissionsResponse>, Integer, Hash)> list_submissions_with_http_info(opts)
|
|
2094
|
+
|
|
2095
|
+
```ruby
|
|
2096
|
+
begin
|
|
2097
|
+
# List all submissions
|
|
2098
|
+
data, status_code, headers = api_instance.list_submissions_with_http_info(opts)
|
|
2099
|
+
p status_code # => 2xx
|
|
2100
|
+
p headers # => { ... }
|
|
2101
|
+
p data # => <ListSubmissionsResponse>
|
|
2102
|
+
rescue DocSpring::ApiError => e
|
|
2103
|
+
puts "Error when calling PDFApi->list_submissions_with_http_info: #{e}"
|
|
1320
2104
|
end
|
|
1321
2105
|
```
|
|
1322
2106
|
|
|
1323
2107
|
### Parameters
|
|
1324
2108
|
|
|
1325
|
-
Name | Type | Description
|
|
1326
|
-
|
|
1327
|
-
**cursor** | **String
|
|
1328
|
-
**limit** | **Float
|
|
1329
|
-
**created_after** | **String
|
|
1330
|
-
**created_before** | **String
|
|
1331
|
-
**type** | **String
|
|
1332
|
-
**include_data** | **
|
|
2109
|
+
| Name | Type | Description | Notes |
|
|
2110
|
+
| ---- | ---- | ----------- | ----- |
|
|
2111
|
+
| **cursor** | **String** | | [optional] |
|
|
2112
|
+
| **limit** | **Float** | | [optional] |
|
|
2113
|
+
| **created_after** | **String** | | [optional] |
|
|
2114
|
+
| **created_before** | **String** | | [optional] |
|
|
2115
|
+
| **type** | **String** | | [optional] |
|
|
2116
|
+
| **include_data** | **Boolean** | | [optional] |
|
|
1333
2117
|
|
|
1334
2118
|
### Return type
|
|
1335
2119
|
|
|
@@ -1341,19 +2125,20 @@ Name | Type | Description | Notes
|
|
|
1341
2125
|
|
|
1342
2126
|
### HTTP request headers
|
|
1343
2127
|
|
|
1344
|
-
|
|
1345
|
-
|
|
2128
|
+
- **Content-Type**: Not defined
|
|
2129
|
+
- **Accept**: application/json
|
|
1346
2130
|
|
|
1347
2131
|
|
|
2132
|
+
## list_template_submissions
|
|
1348
2133
|
|
|
1349
|
-
|
|
1350
|
-
> ListSubmissionsResponse list_submissions_0(template_id, opts)
|
|
2134
|
+
> <ListSubmissionsResponse> list_template_submissions(template_id, opts)
|
|
1351
2135
|
|
|
1352
2136
|
List all submissions for a given template
|
|
1353
2137
|
|
|
1354
|
-
###
|
|
2138
|
+
### Examples
|
|
2139
|
+
|
|
1355
2140
|
```ruby
|
|
1356
|
-
|
|
2141
|
+
require 'time'
|
|
1357
2142
|
require 'docspring'
|
|
1358
2143
|
# setup authorization
|
|
1359
2144
|
DocSpring.configure do |config|
|
|
@@ -1366,33 +2151,51 @@ api_instance = DocSpring::PDFApi.new
|
|
|
1366
2151
|
template_id = 'tpl_000000000000000002' # String |
|
|
1367
2152
|
opts = {
|
|
1368
2153
|
cursor: 'cursor_example', # String |
|
|
1369
|
-
limit:
|
|
2154
|
+
limit: 8.14, # Float |
|
|
1370
2155
|
created_after: 'created_after_example', # String |
|
|
1371
2156
|
created_before: 'created_before_example', # String |
|
|
1372
2157
|
type: 'type_example', # String |
|
|
1373
|
-
include_data: true #
|
|
2158
|
+
include_data: true # Boolean |
|
|
1374
2159
|
}
|
|
1375
2160
|
|
|
1376
2161
|
begin
|
|
1377
|
-
#List all submissions for a given template
|
|
1378
|
-
result = api_instance.
|
|
2162
|
+
# List all submissions for a given template
|
|
2163
|
+
result = api_instance.list_template_submissions(template_id, opts)
|
|
1379
2164
|
p result
|
|
1380
2165
|
rescue DocSpring::ApiError => e
|
|
1381
|
-
puts "
|
|
2166
|
+
puts "Error when calling PDFApi->list_template_submissions: #{e}"
|
|
2167
|
+
end
|
|
2168
|
+
```
|
|
2169
|
+
|
|
2170
|
+
#### Using the list_template_submissions_with_http_info variant
|
|
2171
|
+
|
|
2172
|
+
This returns an Array which contains the response data, status code and headers.
|
|
2173
|
+
|
|
2174
|
+
> <Array(<ListSubmissionsResponse>, Integer, Hash)> list_template_submissions_with_http_info(template_id, opts)
|
|
2175
|
+
|
|
2176
|
+
```ruby
|
|
2177
|
+
begin
|
|
2178
|
+
# List all submissions for a given template
|
|
2179
|
+
data, status_code, headers = api_instance.list_template_submissions_with_http_info(template_id, opts)
|
|
2180
|
+
p status_code # => 2xx
|
|
2181
|
+
p headers # => { ... }
|
|
2182
|
+
p data # => <ListSubmissionsResponse>
|
|
2183
|
+
rescue DocSpring::ApiError => e
|
|
2184
|
+
puts "Error when calling PDFApi->list_template_submissions_with_http_info: #{e}"
|
|
1382
2185
|
end
|
|
1383
2186
|
```
|
|
1384
2187
|
|
|
1385
2188
|
### Parameters
|
|
1386
2189
|
|
|
1387
|
-
Name | Type | Description
|
|
1388
|
-
|
|
1389
|
-
**template_id** | **String
|
|
1390
|
-
**cursor** | **String
|
|
1391
|
-
**limit** | **Float
|
|
1392
|
-
**created_after** | **String
|
|
1393
|
-
**created_before** | **String
|
|
1394
|
-
**type** | **String
|
|
1395
|
-
**include_data** | **
|
|
2190
|
+
| Name | Type | Description | Notes |
|
|
2191
|
+
| ---- | ---- | ----------- | ----- |
|
|
2192
|
+
| **template_id** | **String** | | |
|
|
2193
|
+
| **cursor** | **String** | | [optional] |
|
|
2194
|
+
| **limit** | **Float** | | [optional] |
|
|
2195
|
+
| **created_after** | **String** | | [optional] |
|
|
2196
|
+
| **created_before** | **String** | | [optional] |
|
|
2197
|
+
| **type** | **String** | | [optional] |
|
|
2198
|
+
| **include_data** | **Boolean** | | [optional] |
|
|
1396
2199
|
|
|
1397
2200
|
### Return type
|
|
1398
2201
|
|
|
@@ -1404,19 +2207,20 @@ Name | Type | Description | Notes
|
|
|
1404
2207
|
|
|
1405
2208
|
### HTTP request headers
|
|
1406
2209
|
|
|
1407
|
-
|
|
1408
|
-
|
|
2210
|
+
- **Content-Type**: Not defined
|
|
2211
|
+
- **Accept**: application/json
|
|
1409
2212
|
|
|
1410
2213
|
|
|
2214
|
+
## list_templates
|
|
1411
2215
|
|
|
1412
|
-
|
|
1413
|
-
> Array<Template> list_templates(opts)
|
|
2216
|
+
> <Array<Template>> list_templates(opts)
|
|
1414
2217
|
|
|
1415
2218
|
Get a list of all templates
|
|
1416
2219
|
|
|
1417
|
-
###
|
|
2220
|
+
### Examples
|
|
2221
|
+
|
|
1418
2222
|
```ruby
|
|
1419
|
-
|
|
2223
|
+
require 'time'
|
|
1420
2224
|
require 'docspring'
|
|
1421
2225
|
# setup authorization
|
|
1422
2226
|
DocSpring.configure do |config|
|
|
@@ -1434,22 +2238,40 @@ opts = {
|
|
|
1434
2238
|
}
|
|
1435
2239
|
|
|
1436
2240
|
begin
|
|
1437
|
-
#Get a list of all templates
|
|
2241
|
+
# Get a list of all templates
|
|
1438
2242
|
result = api_instance.list_templates(opts)
|
|
1439
2243
|
p result
|
|
1440
2244
|
rescue DocSpring::ApiError => e
|
|
1441
|
-
puts "
|
|
2245
|
+
puts "Error when calling PDFApi->list_templates: #{e}"
|
|
2246
|
+
end
|
|
2247
|
+
```
|
|
2248
|
+
|
|
2249
|
+
#### Using the list_templates_with_http_info variant
|
|
2250
|
+
|
|
2251
|
+
This returns an Array which contains the response data, status code and headers.
|
|
2252
|
+
|
|
2253
|
+
> <Array(<Array<Template>>, Integer, Hash)> list_templates_with_http_info(opts)
|
|
2254
|
+
|
|
2255
|
+
```ruby
|
|
2256
|
+
begin
|
|
2257
|
+
# Get a list of all templates
|
|
2258
|
+
data, status_code, headers = api_instance.list_templates_with_http_info(opts)
|
|
2259
|
+
p status_code # => 2xx
|
|
2260
|
+
p headers # => { ... }
|
|
2261
|
+
p data # => <Array<Template>>
|
|
2262
|
+
rescue DocSpring::ApiError => e
|
|
2263
|
+
puts "Error when calling PDFApi->list_templates_with_http_info: #{e}"
|
|
1442
2264
|
end
|
|
1443
2265
|
```
|
|
1444
2266
|
|
|
1445
2267
|
### Parameters
|
|
1446
2268
|
|
|
1447
|
-
Name | Type | Description
|
|
1448
|
-
|
|
1449
|
-
**query** | **String
|
|
1450
|
-
**parent_folder_id** | **String
|
|
1451
|
-
**page** | **Integer
|
|
1452
|
-
**per_page** | **Integer
|
|
2269
|
+
| Name | Type | Description | Notes |
|
|
2270
|
+
| ---- | ---- | ----------- | ----- |
|
|
2271
|
+
| **query** | **String** | Search By Name | [optional] |
|
|
2272
|
+
| **parent_folder_id** | **String** | Filter By Folder Id | [optional] |
|
|
2273
|
+
| **page** | **Integer** | Default: 1 | [optional] |
|
|
2274
|
+
| **per_page** | **Integer** | Default: 50 | [optional] |
|
|
1453
2275
|
|
|
1454
2276
|
### Return type
|
|
1455
2277
|
|
|
@@ -1461,19 +2283,20 @@ Name | Type | Description | Notes
|
|
|
1461
2283
|
|
|
1462
2284
|
### HTTP request headers
|
|
1463
2285
|
|
|
1464
|
-
|
|
1465
|
-
|
|
2286
|
+
- **Content-Type**: Not defined
|
|
2287
|
+
- **Accept**: application/json
|
|
1466
2288
|
|
|
1467
2289
|
|
|
2290
|
+
## move_folder_to_folder
|
|
1468
2291
|
|
|
1469
|
-
|
|
1470
|
-
> Folder move_folder_to_folder(folder_id, move_folder_data)
|
|
2292
|
+
> <Folder> move_folder_to_folder(folder_id, data)
|
|
1471
2293
|
|
|
1472
2294
|
Move a folder
|
|
1473
2295
|
|
|
1474
|
-
###
|
|
2296
|
+
### Examples
|
|
2297
|
+
|
|
1475
2298
|
```ruby
|
|
1476
|
-
|
|
2299
|
+
require 'time'
|
|
1477
2300
|
require 'docspring'
|
|
1478
2301
|
# setup authorization
|
|
1479
2302
|
DocSpring.configure do |config|
|
|
@@ -1483,24 +2306,42 @@ DocSpring.configure do |config|
|
|
|
1483
2306
|
end
|
|
1484
2307
|
|
|
1485
2308
|
api_instance = DocSpring::PDFApi.new
|
|
1486
|
-
folder_id = '
|
|
1487
|
-
|
|
2309
|
+
folder_id = 'fld_0000000000000000001' # String |
|
|
2310
|
+
data = DocSpring::MoveFolderData.new # MoveFolderData |
|
|
1488
2311
|
|
|
1489
2312
|
begin
|
|
1490
|
-
#Move a folder
|
|
1491
|
-
result = api_instance.move_folder_to_folder(folder_id,
|
|
2313
|
+
# Move a folder
|
|
2314
|
+
result = api_instance.move_folder_to_folder(folder_id, data)
|
|
1492
2315
|
p result
|
|
1493
2316
|
rescue DocSpring::ApiError => e
|
|
1494
|
-
puts "
|
|
2317
|
+
puts "Error when calling PDFApi->move_folder_to_folder: #{e}"
|
|
2318
|
+
end
|
|
2319
|
+
```
|
|
2320
|
+
|
|
2321
|
+
#### Using the move_folder_to_folder_with_http_info variant
|
|
2322
|
+
|
|
2323
|
+
This returns an Array which contains the response data, status code and headers.
|
|
2324
|
+
|
|
2325
|
+
> <Array(<Folder>, Integer, Hash)> move_folder_to_folder_with_http_info(folder_id, data)
|
|
2326
|
+
|
|
2327
|
+
```ruby
|
|
2328
|
+
begin
|
|
2329
|
+
# Move a folder
|
|
2330
|
+
data, status_code, headers = api_instance.move_folder_to_folder_with_http_info(folder_id, data)
|
|
2331
|
+
p status_code # => 2xx
|
|
2332
|
+
p headers # => { ... }
|
|
2333
|
+
p data # => <Folder>
|
|
2334
|
+
rescue DocSpring::ApiError => e
|
|
2335
|
+
puts "Error when calling PDFApi->move_folder_to_folder_with_http_info: #{e}"
|
|
1495
2336
|
end
|
|
1496
2337
|
```
|
|
1497
2338
|
|
|
1498
2339
|
### Parameters
|
|
1499
2340
|
|
|
1500
|
-
Name | Type | Description
|
|
1501
|
-
|
|
1502
|
-
**folder_id** | **String
|
|
1503
|
-
**
|
|
2341
|
+
| Name | Type | Description | Notes |
|
|
2342
|
+
| ---- | ---- | ----------- | ----- |
|
|
2343
|
+
| **folder_id** | **String** | | |
|
|
2344
|
+
| **data** | [**MoveFolderData**](MoveFolderData.md) | | |
|
|
1504
2345
|
|
|
1505
2346
|
### Return type
|
|
1506
2347
|
|
|
@@ -1512,19 +2353,20 @@ Name | Type | Description | Notes
|
|
|
1512
2353
|
|
|
1513
2354
|
### HTTP request headers
|
|
1514
2355
|
|
|
1515
|
-
|
|
1516
|
-
|
|
2356
|
+
- **Content-Type**: application/json
|
|
2357
|
+
- **Accept**: application/json
|
|
1517
2358
|
|
|
1518
2359
|
|
|
2360
|
+
## move_template_to_folder
|
|
1519
2361
|
|
|
1520
|
-
|
|
1521
|
-
> Template move_template_to_folder(template_id, move_template_data)
|
|
2362
|
+
> <Template> move_template_to_folder(template_id, data)
|
|
1522
2363
|
|
|
1523
2364
|
Move Template to folder
|
|
1524
2365
|
|
|
1525
|
-
###
|
|
2366
|
+
### Examples
|
|
2367
|
+
|
|
1526
2368
|
```ruby
|
|
1527
|
-
|
|
2369
|
+
require 'time'
|
|
1528
2370
|
require 'docspring'
|
|
1529
2371
|
# setup authorization
|
|
1530
2372
|
DocSpring.configure do |config|
|
|
@@ -1535,23 +2377,41 @@ end
|
|
|
1535
2377
|
|
|
1536
2378
|
api_instance = DocSpring::PDFApi.new
|
|
1537
2379
|
template_id = 'tpl_000000000000000001' # String |
|
|
1538
|
-
|
|
2380
|
+
data = DocSpring::MoveTemplateData.new({parent_folder_id: 'parent_folder_id_example'}) # MoveTemplateData |
|
|
1539
2381
|
|
|
1540
2382
|
begin
|
|
1541
|
-
#Move Template to folder
|
|
1542
|
-
result = api_instance.move_template_to_folder(template_id,
|
|
2383
|
+
# Move Template to folder
|
|
2384
|
+
result = api_instance.move_template_to_folder(template_id, data)
|
|
1543
2385
|
p result
|
|
1544
2386
|
rescue DocSpring::ApiError => e
|
|
1545
|
-
puts "
|
|
2387
|
+
puts "Error when calling PDFApi->move_template_to_folder: #{e}"
|
|
2388
|
+
end
|
|
2389
|
+
```
|
|
2390
|
+
|
|
2391
|
+
#### Using the move_template_to_folder_with_http_info variant
|
|
2392
|
+
|
|
2393
|
+
This returns an Array which contains the response data, status code and headers.
|
|
2394
|
+
|
|
2395
|
+
> <Array(<Template>, Integer, Hash)> move_template_to_folder_with_http_info(template_id, data)
|
|
2396
|
+
|
|
2397
|
+
```ruby
|
|
2398
|
+
begin
|
|
2399
|
+
# Move Template to folder
|
|
2400
|
+
data, status_code, headers = api_instance.move_template_to_folder_with_http_info(template_id, data)
|
|
2401
|
+
p status_code # => 2xx
|
|
2402
|
+
p headers # => { ... }
|
|
2403
|
+
p data # => <Template>
|
|
2404
|
+
rescue DocSpring::ApiError => e
|
|
2405
|
+
puts "Error when calling PDFApi->move_template_to_folder_with_http_info: #{e}"
|
|
1546
2406
|
end
|
|
1547
2407
|
```
|
|
1548
2408
|
|
|
1549
2409
|
### Parameters
|
|
1550
2410
|
|
|
1551
|
-
Name | Type | Description
|
|
1552
|
-
|
|
1553
|
-
**template_id** | **String
|
|
1554
|
-
**
|
|
2411
|
+
| Name | Type | Description | Notes |
|
|
2412
|
+
| ---- | ---- | ----------- | ----- |
|
|
2413
|
+
| **template_id** | **String** | | |
|
|
2414
|
+
| **data** | [**MoveTemplateData**](MoveTemplateData.md) | | |
|
|
1555
2415
|
|
|
1556
2416
|
### Return type
|
|
1557
2417
|
|
|
@@ -1563,19 +2423,90 @@ Name | Type | Description | Notes
|
|
|
1563
2423
|
|
|
1564
2424
|
### HTTP request headers
|
|
1565
2425
|
|
|
1566
|
-
|
|
1567
|
-
|
|
2426
|
+
- **Content-Type**: application/json
|
|
2427
|
+
- **Accept**: application/json
|
|
2428
|
+
|
|
2429
|
+
|
|
2430
|
+
## publish_template_version
|
|
2431
|
+
|
|
2432
|
+
> <PublishTemplateVersionResponse> publish_template_version(template_id, data)
|
|
2433
|
+
|
|
2434
|
+
Publish a template version
|
|
2435
|
+
|
|
2436
|
+
### Examples
|
|
2437
|
+
|
|
2438
|
+
```ruby
|
|
2439
|
+
require 'time'
|
|
2440
|
+
require 'docspring'
|
|
2441
|
+
# setup authorization
|
|
2442
|
+
DocSpring.configure do |config|
|
|
2443
|
+
# Configure HTTP basic authorization: api_token_basic
|
|
2444
|
+
config.username = 'YOUR USERNAME'
|
|
2445
|
+
config.password = 'YOUR PASSWORD'
|
|
2446
|
+
end
|
|
2447
|
+
|
|
2448
|
+
api_instance = DocSpring::PDFApi.new
|
|
2449
|
+
template_id = 'tpl_000000000000000001' # String |
|
|
2450
|
+
data = DocSpring::PublishVersionData.new({version_type: 'version_type_example'}) # PublishVersionData |
|
|
2451
|
+
|
|
2452
|
+
begin
|
|
2453
|
+
# Publish a template version
|
|
2454
|
+
result = api_instance.publish_template_version(template_id, data)
|
|
2455
|
+
p result
|
|
2456
|
+
rescue DocSpring::ApiError => e
|
|
2457
|
+
puts "Error when calling PDFApi->publish_template_version: #{e}"
|
|
2458
|
+
end
|
|
2459
|
+
```
|
|
2460
|
+
|
|
2461
|
+
#### Using the publish_template_version_with_http_info variant
|
|
2462
|
+
|
|
2463
|
+
This returns an Array which contains the response data, status code and headers.
|
|
2464
|
+
|
|
2465
|
+
> <Array(<PublishTemplateVersionResponse>, Integer, Hash)> publish_template_version_with_http_info(template_id, data)
|
|
2466
|
+
|
|
2467
|
+
```ruby
|
|
2468
|
+
begin
|
|
2469
|
+
# Publish a template version
|
|
2470
|
+
data, status_code, headers = api_instance.publish_template_version_with_http_info(template_id, data)
|
|
2471
|
+
p status_code # => 2xx
|
|
2472
|
+
p headers # => { ... }
|
|
2473
|
+
p data # => <PublishTemplateVersionResponse>
|
|
2474
|
+
rescue DocSpring::ApiError => e
|
|
2475
|
+
puts "Error when calling PDFApi->publish_template_version_with_http_info: #{e}"
|
|
2476
|
+
end
|
|
2477
|
+
```
|
|
2478
|
+
|
|
2479
|
+
### Parameters
|
|
2480
|
+
|
|
2481
|
+
| Name | Type | Description | Notes |
|
|
2482
|
+
| ---- | ---- | ----------- | ----- |
|
|
2483
|
+
| **template_id** | **String** | | |
|
|
2484
|
+
| **data** | [**PublishVersionData**](PublishVersionData.md) | | |
|
|
2485
|
+
|
|
2486
|
+
### Return type
|
|
2487
|
+
|
|
2488
|
+
[**PublishTemplateVersionResponse**](PublishTemplateVersionResponse.md)
|
|
2489
|
+
|
|
2490
|
+
### Authorization
|
|
2491
|
+
|
|
2492
|
+
[api_token_basic](../README.md#api_token_basic)
|
|
2493
|
+
|
|
2494
|
+
### HTTP request headers
|
|
2495
|
+
|
|
2496
|
+
- **Content-Type**: application/json
|
|
2497
|
+
- **Accept**: application/json
|
|
1568
2498
|
|
|
1569
2499
|
|
|
2500
|
+
## rename_folder
|
|
1570
2501
|
|
|
1571
|
-
|
|
1572
|
-
> rename_folder(folder_id, rename_folder_data)
|
|
2502
|
+
> rename_folder(folder_id, data)
|
|
1573
2503
|
|
|
1574
2504
|
Rename a folder
|
|
1575
2505
|
|
|
1576
|
-
###
|
|
2506
|
+
### Examples
|
|
2507
|
+
|
|
1577
2508
|
```ruby
|
|
1578
|
-
|
|
2509
|
+
require 'time'
|
|
1579
2510
|
require 'docspring'
|
|
1580
2511
|
# setup authorization
|
|
1581
2512
|
DocSpring.configure do |config|
|
|
@@ -1585,23 +2516,41 @@ DocSpring.configure do |config|
|
|
|
1585
2516
|
end
|
|
1586
2517
|
|
|
1587
2518
|
api_instance = DocSpring::PDFApi.new
|
|
1588
|
-
folder_id = '
|
|
1589
|
-
|
|
2519
|
+
folder_id = 'fld_0000000000000000001' # String |
|
|
2520
|
+
data = DocSpring::RenameFolderData.new({name: 'name_example'}) # RenameFolderData |
|
|
1590
2521
|
|
|
1591
2522
|
begin
|
|
1592
|
-
#Rename a folder
|
|
1593
|
-
api_instance.rename_folder(folder_id,
|
|
2523
|
+
# Rename a folder
|
|
2524
|
+
api_instance.rename_folder(folder_id, data)
|
|
1594
2525
|
rescue DocSpring::ApiError => e
|
|
1595
|
-
puts "
|
|
2526
|
+
puts "Error when calling PDFApi->rename_folder: #{e}"
|
|
2527
|
+
end
|
|
2528
|
+
```
|
|
2529
|
+
|
|
2530
|
+
#### Using the rename_folder_with_http_info variant
|
|
2531
|
+
|
|
2532
|
+
This returns an Array which contains the response data (`nil` in this case), status code and headers.
|
|
2533
|
+
|
|
2534
|
+
> <Array(nil, Integer, Hash)> rename_folder_with_http_info(folder_id, data)
|
|
2535
|
+
|
|
2536
|
+
```ruby
|
|
2537
|
+
begin
|
|
2538
|
+
# Rename a folder
|
|
2539
|
+
data, status_code, headers = api_instance.rename_folder_with_http_info(folder_id, data)
|
|
2540
|
+
p status_code # => 2xx
|
|
2541
|
+
p headers # => { ... }
|
|
2542
|
+
p data # => nil
|
|
2543
|
+
rescue DocSpring::ApiError => e
|
|
2544
|
+
puts "Error when calling PDFApi->rename_folder_with_http_info: #{e}"
|
|
1596
2545
|
end
|
|
1597
2546
|
```
|
|
1598
2547
|
|
|
1599
2548
|
### Parameters
|
|
1600
2549
|
|
|
1601
|
-
Name | Type | Description
|
|
1602
|
-
|
|
1603
|
-
**folder_id** | **String
|
|
1604
|
-
**
|
|
2550
|
+
| Name | Type | Description | Notes |
|
|
2551
|
+
| ---- | ---- | ----------- | ----- |
|
|
2552
|
+
| **folder_id** | **String** | | |
|
|
2553
|
+
| **data** | [**RenameFolderData**](RenameFolderData.md) | | |
|
|
1605
2554
|
|
|
1606
2555
|
### Return type
|
|
1607
2556
|
|
|
@@ -1613,19 +2562,90 @@ nil (empty response body)
|
|
|
1613
2562
|
|
|
1614
2563
|
### HTTP request headers
|
|
1615
2564
|
|
|
1616
|
-
|
|
1617
|
-
|
|
2565
|
+
- **Content-Type**: application/json
|
|
2566
|
+
- **Accept**: application/json
|
|
2567
|
+
|
|
2568
|
+
|
|
2569
|
+
## restore_template_version
|
|
2570
|
+
|
|
2571
|
+
> <RestoreTemplateVersionResponse> restore_template_version(template_id, data)
|
|
2572
|
+
|
|
2573
|
+
Restore a template version
|
|
2574
|
+
|
|
2575
|
+
### Examples
|
|
2576
|
+
|
|
2577
|
+
```ruby
|
|
2578
|
+
require 'time'
|
|
2579
|
+
require 'docspring'
|
|
2580
|
+
# setup authorization
|
|
2581
|
+
DocSpring.configure do |config|
|
|
2582
|
+
# Configure HTTP basic authorization: api_token_basic
|
|
2583
|
+
config.username = 'YOUR USERNAME'
|
|
2584
|
+
config.password = 'YOUR PASSWORD'
|
|
2585
|
+
end
|
|
2586
|
+
|
|
2587
|
+
api_instance = DocSpring::PDFApi.new
|
|
2588
|
+
template_id = 'tpl_000000000000000001' # String |
|
|
2589
|
+
data = DocSpring::RestoreVersionData.new({version: 'version_example'}) # RestoreVersionData |
|
|
2590
|
+
|
|
2591
|
+
begin
|
|
2592
|
+
# Restore a template version
|
|
2593
|
+
result = api_instance.restore_template_version(template_id, data)
|
|
2594
|
+
p result
|
|
2595
|
+
rescue DocSpring::ApiError => e
|
|
2596
|
+
puts "Error when calling PDFApi->restore_template_version: #{e}"
|
|
2597
|
+
end
|
|
2598
|
+
```
|
|
2599
|
+
|
|
2600
|
+
#### Using the restore_template_version_with_http_info variant
|
|
2601
|
+
|
|
2602
|
+
This returns an Array which contains the response data, status code and headers.
|
|
2603
|
+
|
|
2604
|
+
> <Array(<RestoreTemplateVersionResponse>, Integer, Hash)> restore_template_version_with_http_info(template_id, data)
|
|
2605
|
+
|
|
2606
|
+
```ruby
|
|
2607
|
+
begin
|
|
2608
|
+
# Restore a template version
|
|
2609
|
+
data, status_code, headers = api_instance.restore_template_version_with_http_info(template_id, data)
|
|
2610
|
+
p status_code # => 2xx
|
|
2611
|
+
p headers # => { ... }
|
|
2612
|
+
p data # => <RestoreTemplateVersionResponse>
|
|
2613
|
+
rescue DocSpring::ApiError => e
|
|
2614
|
+
puts "Error when calling PDFApi->restore_template_version_with_http_info: #{e}"
|
|
2615
|
+
end
|
|
2616
|
+
```
|
|
2617
|
+
|
|
2618
|
+
### Parameters
|
|
2619
|
+
|
|
2620
|
+
| Name | Type | Description | Notes |
|
|
2621
|
+
| ---- | ---- | ----------- | ----- |
|
|
2622
|
+
| **template_id** | **String** | | |
|
|
2623
|
+
| **data** | [**RestoreVersionData**](RestoreVersionData.md) | | |
|
|
2624
|
+
|
|
2625
|
+
### Return type
|
|
2626
|
+
|
|
2627
|
+
[**RestoreTemplateVersionResponse**](RestoreTemplateVersionResponse.md)
|
|
2628
|
+
|
|
2629
|
+
### Authorization
|
|
2630
|
+
|
|
2631
|
+
[api_token_basic](../README.md#api_token_basic)
|
|
2632
|
+
|
|
2633
|
+
### HTTP request headers
|
|
2634
|
+
|
|
2635
|
+
- **Content-Type**: application/json
|
|
2636
|
+
- **Accept**: application/json
|
|
1618
2637
|
|
|
1619
2638
|
|
|
2639
|
+
## test_authentication
|
|
1620
2640
|
|
|
1621
|
-
|
|
1622
|
-
> AuthenticationSuccessResponse test_authentication
|
|
2641
|
+
> <AuthenticationSuccessResponse> test_authentication
|
|
1623
2642
|
|
|
1624
2643
|
Test Authentication
|
|
1625
2644
|
|
|
1626
|
-
###
|
|
2645
|
+
### Examples
|
|
2646
|
+
|
|
1627
2647
|
```ruby
|
|
1628
|
-
|
|
2648
|
+
require 'time'
|
|
1629
2649
|
require 'docspring'
|
|
1630
2650
|
# setup authorization
|
|
1631
2651
|
DocSpring.configure do |config|
|
|
@@ -1637,15 +2657,34 @@ end
|
|
|
1637
2657
|
api_instance = DocSpring::PDFApi.new
|
|
1638
2658
|
|
|
1639
2659
|
begin
|
|
1640
|
-
#Test Authentication
|
|
2660
|
+
# Test Authentication
|
|
1641
2661
|
result = api_instance.test_authentication
|
|
1642
2662
|
p result
|
|
1643
2663
|
rescue DocSpring::ApiError => e
|
|
1644
|
-
puts "
|
|
2664
|
+
puts "Error when calling PDFApi->test_authentication: #{e}"
|
|
2665
|
+
end
|
|
2666
|
+
```
|
|
2667
|
+
|
|
2668
|
+
#### Using the test_authentication_with_http_info variant
|
|
2669
|
+
|
|
2670
|
+
This returns an Array which contains the response data, status code and headers.
|
|
2671
|
+
|
|
2672
|
+
> <Array(<AuthenticationSuccessResponse>, Integer, Hash)> test_authentication_with_http_info
|
|
2673
|
+
|
|
2674
|
+
```ruby
|
|
2675
|
+
begin
|
|
2676
|
+
# Test Authentication
|
|
2677
|
+
data, status_code, headers = api_instance.test_authentication_with_http_info
|
|
2678
|
+
p status_code # => 2xx
|
|
2679
|
+
p headers # => { ... }
|
|
2680
|
+
p data # => <AuthenticationSuccessResponse>
|
|
2681
|
+
rescue DocSpring::ApiError => e
|
|
2682
|
+
puts "Error when calling PDFApi->test_authentication_with_http_info: #{e}"
|
|
1645
2683
|
end
|
|
1646
2684
|
```
|
|
1647
2685
|
|
|
1648
2686
|
### Parameters
|
|
2687
|
+
|
|
1649
2688
|
This endpoint does not need any parameter.
|
|
1650
2689
|
|
|
1651
2690
|
### Return type
|
|
@@ -1658,19 +2697,20 @@ This endpoint does not need any parameter.
|
|
|
1658
2697
|
|
|
1659
2698
|
### HTTP request headers
|
|
1660
2699
|
|
|
1661
|
-
|
|
1662
|
-
|
|
2700
|
+
- **Content-Type**: Not defined
|
|
2701
|
+
- **Accept**: application/json
|
|
1663
2702
|
|
|
1664
2703
|
|
|
2704
|
+
## update_data_request
|
|
1665
2705
|
|
|
1666
|
-
|
|
1667
|
-
> UpdateDataRequestResponse update_data_request(data_request_id, update_submission_data_request_data)
|
|
2706
|
+
> <UpdateDataRequestResponse> update_data_request(data_request_id, data)
|
|
1668
2707
|
|
|
1669
2708
|
Update a submission data request
|
|
1670
2709
|
|
|
1671
|
-
###
|
|
2710
|
+
### Examples
|
|
2711
|
+
|
|
1672
2712
|
```ruby
|
|
1673
|
-
|
|
2713
|
+
require 'time'
|
|
1674
2714
|
require 'docspring'
|
|
1675
2715
|
# setup authorization
|
|
1676
2716
|
DocSpring.configure do |config|
|
|
@@ -1681,23 +2721,41 @@ end
|
|
|
1681
2721
|
|
|
1682
2722
|
api_instance = DocSpring::PDFApi.new
|
|
1683
2723
|
data_request_id = 'drq_000000000000000001' # String |
|
|
1684
|
-
|
|
2724
|
+
data = DocSpring::UpdateSubmissionDataRequestData.new # UpdateSubmissionDataRequestData |
|
|
1685
2725
|
|
|
1686
2726
|
begin
|
|
1687
|
-
#Update a submission data request
|
|
1688
|
-
result = api_instance.update_data_request(data_request_id,
|
|
2727
|
+
# Update a submission data request
|
|
2728
|
+
result = api_instance.update_data_request(data_request_id, data)
|
|
1689
2729
|
p result
|
|
1690
2730
|
rescue DocSpring::ApiError => e
|
|
1691
|
-
puts "
|
|
2731
|
+
puts "Error when calling PDFApi->update_data_request: #{e}"
|
|
2732
|
+
end
|
|
2733
|
+
```
|
|
2734
|
+
|
|
2735
|
+
#### Using the update_data_request_with_http_info variant
|
|
2736
|
+
|
|
2737
|
+
This returns an Array which contains the response data, status code and headers.
|
|
2738
|
+
|
|
2739
|
+
> <Array(<UpdateDataRequestResponse>, Integer, Hash)> update_data_request_with_http_info(data_request_id, data)
|
|
2740
|
+
|
|
2741
|
+
```ruby
|
|
2742
|
+
begin
|
|
2743
|
+
# Update a submission data request
|
|
2744
|
+
data, status_code, headers = api_instance.update_data_request_with_http_info(data_request_id, data)
|
|
2745
|
+
p status_code # => 2xx
|
|
2746
|
+
p headers # => { ... }
|
|
2747
|
+
p data # => <UpdateDataRequestResponse>
|
|
2748
|
+
rescue DocSpring::ApiError => e
|
|
2749
|
+
puts "Error when calling PDFApi->update_data_request_with_http_info: #{e}"
|
|
1692
2750
|
end
|
|
1693
2751
|
```
|
|
1694
2752
|
|
|
1695
2753
|
### Parameters
|
|
1696
2754
|
|
|
1697
|
-
Name | Type | Description
|
|
1698
|
-
|
|
1699
|
-
**data_request_id** | **String
|
|
1700
|
-
**
|
|
2755
|
+
| Name | Type | Description | Notes |
|
|
2756
|
+
| ---- | ---- | ----------- | ----- |
|
|
2757
|
+
| **data_request_id** | **String** | | |
|
|
2758
|
+
| **data** | [**UpdateSubmissionDataRequestData**](UpdateSubmissionDataRequestData.md) | | |
|
|
1701
2759
|
|
|
1702
2760
|
### Return type
|
|
1703
2761
|
|
|
@@ -1709,19 +2767,20 @@ Name | Type | Description | Notes
|
|
|
1709
2767
|
|
|
1710
2768
|
### HTTP request headers
|
|
1711
2769
|
|
|
1712
|
-
|
|
1713
|
-
|
|
2770
|
+
- **Content-Type**: application/json
|
|
2771
|
+
- **Accept**: application/json
|
|
1714
2772
|
|
|
1715
2773
|
|
|
2774
|
+
## update_template
|
|
1716
2775
|
|
|
1717
|
-
|
|
1718
|
-
> UpdateTemplateResponse update_template(template_id, update_template_data)
|
|
2776
|
+
> <UpdateTemplateResponse> update_template(template_id, data)
|
|
1719
2777
|
|
|
1720
2778
|
Update a Template
|
|
1721
2779
|
|
|
1722
|
-
###
|
|
2780
|
+
### Examples
|
|
2781
|
+
|
|
1723
2782
|
```ruby
|
|
1724
|
-
|
|
2783
|
+
require 'time'
|
|
1725
2784
|
require 'docspring'
|
|
1726
2785
|
# setup authorization
|
|
1727
2786
|
DocSpring.configure do |config|
|
|
@@ -1732,23 +2791,41 @@ end
|
|
|
1732
2791
|
|
|
1733
2792
|
api_instance = DocSpring::PDFApi.new
|
|
1734
2793
|
template_id = 'tpl_000000000000000003' # String |
|
|
1735
|
-
|
|
2794
|
+
data = DocSpring::UpdateTemplateData.new({template: DocSpring::TemplateData.new}) # UpdateTemplateData |
|
|
1736
2795
|
|
|
1737
2796
|
begin
|
|
1738
|
-
#Update a Template
|
|
1739
|
-
result = api_instance.update_template(template_id,
|
|
2797
|
+
# Update a Template
|
|
2798
|
+
result = api_instance.update_template(template_id, data)
|
|
1740
2799
|
p result
|
|
1741
2800
|
rescue DocSpring::ApiError => e
|
|
1742
|
-
puts "
|
|
2801
|
+
puts "Error when calling PDFApi->update_template: #{e}"
|
|
2802
|
+
end
|
|
2803
|
+
```
|
|
2804
|
+
|
|
2805
|
+
#### Using the update_template_with_http_info variant
|
|
2806
|
+
|
|
2807
|
+
This returns an Array which contains the response data, status code and headers.
|
|
2808
|
+
|
|
2809
|
+
> <Array(<UpdateTemplateResponse>, Integer, Hash)> update_template_with_http_info(template_id, data)
|
|
2810
|
+
|
|
2811
|
+
```ruby
|
|
2812
|
+
begin
|
|
2813
|
+
# Update a Template
|
|
2814
|
+
data, status_code, headers = api_instance.update_template_with_http_info(template_id, data)
|
|
2815
|
+
p status_code # => 2xx
|
|
2816
|
+
p headers # => { ... }
|
|
2817
|
+
p data # => <UpdateTemplateResponse>
|
|
2818
|
+
rescue DocSpring::ApiError => e
|
|
2819
|
+
puts "Error when calling PDFApi->update_template_with_http_info: #{e}"
|
|
1743
2820
|
end
|
|
1744
2821
|
```
|
|
1745
2822
|
|
|
1746
2823
|
### Parameters
|
|
1747
2824
|
|
|
1748
|
-
Name | Type | Description
|
|
1749
|
-
|
|
1750
|
-
**template_id** | **String
|
|
1751
|
-
**
|
|
2825
|
+
| Name | Type | Description | Notes |
|
|
2826
|
+
| ---- | ---- | ----------- | ----- |
|
|
2827
|
+
| **template_id** | **String** | | |
|
|
2828
|
+
| **data** | [**UpdateTemplateData**](UpdateTemplateData.md) | | |
|
|
1752
2829
|
|
|
1753
2830
|
### Return type
|
|
1754
2831
|
|
|
@@ -1760,8 +2837,6 @@ Name | Type | Description | Notes
|
|
|
1760
2837
|
|
|
1761
2838
|
### HTTP request headers
|
|
1762
2839
|
|
|
1763
|
-
|
|
1764
|
-
|
|
1765
|
-
|
|
1766
|
-
|
|
2840
|
+
- **Content-Type**: application/json
|
|
2841
|
+
- **Accept**: application/json
|
|
1767
2842
|
|