docspring 1.4.0 → 2.0.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/.gitlab-ci.yml +26 -0
- data/.openapi-generator/FILES +220 -0
- data/.openapi-generator/VERSION +1 -1
- data/.rubocop.yml +6 -12
- data/.travis.yml +11 -0
- data/CHANGELOG.md +9 -0
- data/Gemfile +5 -1
- data/Gemfile.lock +85 -48
- data/README.md +47 -16
- 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 -7
- data/docs/CombinedSubmission.md +37 -12
- data/docs/CombinedSubmissionAction.md +23 -8
- data/docs/CombinedSubmissionData.md +21 -6
- 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 +22 -0
- data/docs/MoveFolderData.md +13 -3
- data/docs/MoveTemplateData.md +13 -3
- data/docs/PDFApi.md +1746 -495
- 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 -9
- 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 +1485 -497
- 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 +74 -32
- data/lib/docspring/models/combined_submission.rb +167 -68
- data/lib/docspring/models/combined_submission_action.rb +83 -39
- data/lib/docspring/models/combined_submission_data.rb +72 -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/full_template.rb +801 -0
- 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 +251 -0
- 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 -41
- 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/template_defaults.rb +249 -0
- 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 +30 -10
- 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 +469 -98
- 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 +18 -17
- data/spec/models/combined_submission_action_spec.rb +16 -21
- data/spec/models/combined_submission_data_spec.rb +17 -16
- data/spec/models/combined_submission_spec.rb +45 -32
- 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 +48 -0
- 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 -24
- 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 +112 -124
- 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/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/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,49 +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
|
-
|
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)
|
42
52
|
|
43
53
|
Add new fields to a Template
|
44
54
|
|
45
|
-
###
|
55
|
+
### Examples
|
56
|
+
|
46
57
|
```ruby
|
47
|
-
|
58
|
+
require 'time'
|
48
59
|
require 'docspring'
|
49
60
|
# setup authorization
|
50
61
|
DocSpring.configure do |config|
|
@@ -55,23 +66,41 @@ end
|
|
55
66
|
|
56
67
|
api_instance = DocSpring::PDFApi.new
|
57
68
|
template_id = 'tpl_000000000000000002' # String |
|
58
|
-
|
69
|
+
data = DocSpring::AddFieldsData.new({fields: [3.56]}) # AddFieldsData |
|
59
70
|
|
60
71
|
begin
|
61
|
-
#Add new fields to a Template
|
62
|
-
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)
|
63
74
|
p result
|
64
75
|
rescue DocSpring::ApiError => e
|
65
|
-
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}"
|
66
95
|
end
|
67
96
|
```
|
68
97
|
|
69
98
|
### Parameters
|
70
99
|
|
71
|
-
Name | Type | Description
|
72
|
-
|
73
|
-
**template_id** | **String
|
74
|
-
**
|
100
|
+
| Name | Type | Description | Notes |
|
101
|
+
| ---- | ---- | ----------- | ----- |
|
102
|
+
| **template_id** | **String** | | |
|
103
|
+
| **data** | [**AddFieldsData**](AddFieldsData.md) | | |
|
75
104
|
|
76
105
|
### Return type
|
77
106
|
|
@@ -83,19 +112,20 @@ Name | Type | Description | Notes
|
|
83
112
|
|
84
113
|
### HTTP request headers
|
85
114
|
|
86
|
-
|
87
|
-
|
115
|
+
- **Content-Type**: application/json
|
116
|
+
- **Accept**: application/json
|
88
117
|
|
89
118
|
|
119
|
+
## batch_generate_pdf_v1
|
90
120
|
|
91
|
-
|
92
|
-
> Array<CreateSubmissionResponse> batch_generate_pdf_v1(template_id, request_body)
|
121
|
+
> <Array<CreateSubmissionResponse>> batch_generate_pdf_v1(template_id, data)
|
93
122
|
|
94
123
|
Generates multiple PDFs
|
95
124
|
|
96
|
-
###
|
125
|
+
### Examples
|
126
|
+
|
97
127
|
```ruby
|
98
|
-
|
128
|
+
require 'time'
|
99
129
|
require 'docspring'
|
100
130
|
# setup authorization
|
101
131
|
DocSpring.configure do |config|
|
@@ -106,23 +136,41 @@ end
|
|
106
136
|
|
107
137
|
api_instance = DocSpring::PDFApi.new
|
108
138
|
template_id = 'tpl_000000000000000001' # String |
|
109
|
-
|
139
|
+
data = [DocSpring::SubmissionData.new({data: 3.56})] # Array<SubmissionData> |
|
110
140
|
|
111
141
|
begin
|
112
|
-
#Generates multiple PDFs
|
113
|
-
result = api_instance.batch_generate_pdf_v1(template_id,
|
142
|
+
# Generates multiple PDFs
|
143
|
+
result = api_instance.batch_generate_pdf_v1(template_id, data)
|
114
144
|
p result
|
115
145
|
rescue DocSpring::ApiError => e
|
116
|
-
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}"
|
117
165
|
end
|
118
166
|
```
|
119
167
|
|
120
168
|
### Parameters
|
121
169
|
|
122
|
-
Name | Type | Description
|
123
|
-
|
124
|
-
**template_id** | **String
|
125
|
-
**
|
170
|
+
| Name | Type | Description | Notes |
|
171
|
+
| ---- | ---- | ----------- | ----- |
|
172
|
+
| **template_id** | **String** | | |
|
173
|
+
| **data** | [**Array<SubmissionData>**](SubmissionData.md) | | |
|
126
174
|
|
127
175
|
### Return type
|
128
176
|
|
@@ -134,19 +182,20 @@ Name | Type | Description | Notes
|
|
134
182
|
|
135
183
|
### HTTP request headers
|
136
184
|
|
137
|
-
|
138
|
-
|
185
|
+
- **Content-Type**: application/json
|
186
|
+
- **Accept**: application/json
|
139
187
|
|
140
188
|
|
189
|
+
## batch_generate_pdfs
|
141
190
|
|
142
|
-
|
143
|
-
> CreateSubmissionBatchResponse batch_generate_pdfs(submission_batch_data)
|
191
|
+
> <CreateSubmissionBatchResponse> batch_generate_pdfs(data)
|
144
192
|
|
145
193
|
Generates multiple PDFs
|
146
194
|
|
147
|
-
###
|
195
|
+
### Examples
|
196
|
+
|
148
197
|
```ruby
|
149
|
-
|
198
|
+
require 'time'
|
150
199
|
require 'docspring'
|
151
200
|
# setup authorization
|
152
201
|
DocSpring.configure do |config|
|
@@ -156,22 +205,40 @@ DocSpring.configure do |config|
|
|
156
205
|
end
|
157
206
|
|
158
207
|
api_instance = DocSpring::PDFApi.new
|
159
|
-
|
208
|
+
data = DocSpring::SubmissionBatchData.new({submissions: [DocSpring::SubmissionDataBatchRequest.new({data: 3.56, template_id: 'template_id_example'})]}) # SubmissionBatchData |
|
160
209
|
|
161
210
|
begin
|
162
|
-
#Generates multiple PDFs
|
163
|
-
result = api_instance.batch_generate_pdfs(
|
211
|
+
# Generates multiple PDFs
|
212
|
+
result = api_instance.batch_generate_pdfs(data)
|
164
213
|
p result
|
165
214
|
rescue DocSpring::ApiError => e
|
166
|
-
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}"
|
167
234
|
end
|
168
235
|
```
|
169
236
|
|
170
237
|
### Parameters
|
171
238
|
|
172
|
-
Name | Type | Description
|
173
|
-
|
174
|
-
**
|
239
|
+
| Name | Type | Description | Notes |
|
240
|
+
| ---- | ---- | ----------- | ----- |
|
241
|
+
| **data** | [**SubmissionBatchData**](SubmissionBatchData.md) | | |
|
175
242
|
|
176
243
|
### Return type
|
177
244
|
|
@@ -183,19 +250,20 @@ Name | Type | Description | Notes
|
|
183
250
|
|
184
251
|
### HTTP request headers
|
185
252
|
|
186
|
-
|
187
|
-
|
253
|
+
- **Content-Type**: application/json
|
254
|
+
- **Accept**: application/json
|
188
255
|
|
189
256
|
|
257
|
+
## combine_pdfs
|
190
258
|
|
191
|
-
|
192
|
-
> CreateCombinedSubmissionResponse combine_pdfs(combine_pdfs_data)
|
259
|
+
> <CreateCombinedSubmissionResponse> combine_pdfs(data)
|
193
260
|
|
194
261
|
Merge submission PDFs, template PDFs, or custom files
|
195
262
|
|
196
|
-
###
|
263
|
+
### Examples
|
264
|
+
|
197
265
|
```ruby
|
198
|
-
|
266
|
+
require 'time'
|
199
267
|
require 'docspring'
|
200
268
|
# setup authorization
|
201
269
|
DocSpring.configure do |config|
|
@@ -205,22 +273,40 @@ DocSpring.configure do |config|
|
|
205
273
|
end
|
206
274
|
|
207
275
|
api_instance = DocSpring::PDFApi.new
|
208
|
-
|
276
|
+
data = DocSpring::CombinePdfsData.new({source_pdfs: [3.56]}) # CombinePdfsData |
|
209
277
|
|
210
278
|
begin
|
211
|
-
#Merge submission PDFs, template PDFs, or custom files
|
212
|
-
result = api_instance.combine_pdfs(
|
279
|
+
# Merge submission PDFs, template PDFs, or custom files
|
280
|
+
result = api_instance.combine_pdfs(data)
|
213
281
|
p result
|
214
282
|
rescue DocSpring::ApiError => e
|
215
|
-
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}"
|
216
302
|
end
|
217
303
|
```
|
218
304
|
|
219
305
|
### Parameters
|
220
306
|
|
221
|
-
Name | Type | Description
|
222
|
-
|
223
|
-
**
|
307
|
+
| Name | Type | Description | Notes |
|
308
|
+
| ---- | ---- | ----------- | ----- |
|
309
|
+
| **data** | [**CombinePdfsData**](CombinePdfsData.md) | | |
|
224
310
|
|
225
311
|
### Return type
|
226
312
|
|
@@ -232,19 +318,20 @@ Name | Type | Description | Notes
|
|
232
318
|
|
233
319
|
### HTTP request headers
|
234
320
|
|
235
|
-
|
236
|
-
|
321
|
+
- **Content-Type**: application/json
|
322
|
+
- **Accept**: application/json
|
237
323
|
|
238
324
|
|
325
|
+
## combine_submissions
|
239
326
|
|
240
|
-
|
241
|
-
> CreateCombinedSubmissionResponse combine_submissions(combined_submission_data)
|
327
|
+
> <CreateCombinedSubmissionResponse> combine_submissions(data)
|
242
328
|
|
243
329
|
Merge generated PDFs together
|
244
330
|
|
245
|
-
###
|
331
|
+
### Examples
|
332
|
+
|
246
333
|
```ruby
|
247
|
-
|
334
|
+
require 'time'
|
248
335
|
require 'docspring'
|
249
336
|
# setup authorization
|
250
337
|
DocSpring.configure do |config|
|
@@ -254,22 +341,40 @@ DocSpring.configure do |config|
|
|
254
341
|
end
|
255
342
|
|
256
343
|
api_instance = DocSpring::PDFApi.new
|
257
|
-
|
344
|
+
data = DocSpring::CombinedSubmissionData.new({submission_ids: ['submission_ids_example']}) # CombinedSubmissionData |
|
258
345
|
|
259
346
|
begin
|
260
|
-
#Merge generated PDFs together
|
261
|
-
result = api_instance.combine_submissions(
|
347
|
+
# Merge generated PDFs together
|
348
|
+
result = api_instance.combine_submissions(data)
|
262
349
|
p result
|
263
350
|
rescue DocSpring::ApiError => e
|
264
|
-
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}"
|
265
370
|
end
|
266
371
|
```
|
267
372
|
|
268
373
|
### Parameters
|
269
374
|
|
270
|
-
Name | Type | Description
|
271
|
-
|
272
|
-
**
|
375
|
+
| Name | Type | Description | Notes |
|
376
|
+
| ---- | ---- | ----------- | ----- |
|
377
|
+
| **data** | [**CombinedSubmissionData**](CombinedSubmissionData.md) | | |
|
273
378
|
|
274
379
|
### Return type
|
275
380
|
|
@@ -281,19 +386,20 @@ Name | Type | Description | Notes
|
|
281
386
|
|
282
387
|
### HTTP request headers
|
283
388
|
|
284
|
-
|
285
|
-
|
389
|
+
- **Content-Type**: application/json
|
390
|
+
- **Accept**: application/json
|
286
391
|
|
287
392
|
|
393
|
+
## copy_template
|
288
394
|
|
289
|
-
|
290
|
-
> Template copy_template(template_id, copy_template_data)
|
395
|
+
> <Template> copy_template(template_id, data)
|
291
396
|
|
292
397
|
Copy a Template
|
293
398
|
|
294
|
-
###
|
399
|
+
### Examples
|
400
|
+
|
295
401
|
```ruby
|
296
|
-
|
402
|
+
require 'time'
|
297
403
|
require 'docspring'
|
298
404
|
# setup authorization
|
299
405
|
DocSpring.configure do |config|
|
@@ -304,23 +410,41 @@ end
|
|
304
410
|
|
305
411
|
api_instance = DocSpring::PDFApi.new
|
306
412
|
template_id = 'tpl_000000000000000001' # String |
|
307
|
-
|
413
|
+
data = DocSpring::CopyTemplateData.new({parent_folder_id: 'parent_folder_id_example'}) # CopyTemplateData |
|
308
414
|
|
309
415
|
begin
|
310
|
-
#Copy a Template
|
311
|
-
result = api_instance.copy_template(template_id,
|
416
|
+
# Copy a Template
|
417
|
+
result = api_instance.copy_template(template_id, data)
|
312
418
|
p result
|
313
419
|
rescue DocSpring::ApiError => e
|
314
|
-
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}"
|
315
439
|
end
|
316
440
|
```
|
317
441
|
|
318
442
|
### Parameters
|
319
443
|
|
320
|
-
Name | Type | Description
|
321
|
-
|
322
|
-
**template_id** | **String
|
323
|
-
**
|
444
|
+
| Name | Type | Description | Notes |
|
445
|
+
| ---- | ---- | ----------- | ----- |
|
446
|
+
| **template_id** | **String** | | |
|
447
|
+
| **data** | [**CopyTemplateData**](CopyTemplateData.md) | | |
|
324
448
|
|
325
449
|
### Return type
|
326
450
|
|
@@ -332,19 +456,20 @@ Name | Type | Description | Notes
|
|
332
456
|
|
333
457
|
### HTTP request headers
|
334
458
|
|
335
|
-
|
336
|
-
|
459
|
+
- **Content-Type**: application/json
|
460
|
+
- **Accept**: application/json
|
337
461
|
|
338
462
|
|
463
|
+
## create_custom_file_from_upload
|
339
464
|
|
340
|
-
|
341
|
-
> CreateCustomFileResponse create_custom_file_from_upload(create_custom_file_data)
|
465
|
+
> <CreateCustomFileResponse> create_custom_file_from_upload(data)
|
342
466
|
|
343
467
|
Create a new custom file from a cached presign upload
|
344
468
|
|
345
|
-
###
|
469
|
+
### Examples
|
470
|
+
|
346
471
|
```ruby
|
347
|
-
|
472
|
+
require 'time'
|
348
473
|
require 'docspring'
|
349
474
|
# setup authorization
|
350
475
|
DocSpring.configure do |config|
|
@@ -354,22 +479,40 @@ DocSpring.configure do |config|
|
|
354
479
|
end
|
355
480
|
|
356
481
|
api_instance = DocSpring::PDFApi.new
|
357
|
-
|
482
|
+
data = DocSpring::CreateCustomFileData.new({cache_id: 'cache_id_example'}) # CreateCustomFileData |
|
358
483
|
|
359
484
|
begin
|
360
|
-
#Create a new custom file from a cached presign upload
|
361
|
-
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)
|
362
487
|
p result
|
363
488
|
rescue DocSpring::ApiError => e
|
364
|
-
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}"
|
365
508
|
end
|
366
509
|
```
|
367
510
|
|
368
511
|
### Parameters
|
369
512
|
|
370
|
-
Name | Type | Description
|
371
|
-
|
372
|
-
**
|
513
|
+
| Name | Type | Description | Notes |
|
514
|
+
| ---- | ---- | ----------- | ----- |
|
515
|
+
| **data** | [**CreateCustomFileData**](CreateCustomFileData.md) | | |
|
373
516
|
|
374
517
|
### Return type
|
375
518
|
|
@@ -381,19 +524,20 @@ Name | Type | Description | Notes
|
|
381
524
|
|
382
525
|
### HTTP request headers
|
383
526
|
|
384
|
-
|
385
|
-
|
527
|
+
- **Content-Type**: application/json
|
528
|
+
- **Accept**: application/json
|
386
529
|
|
387
530
|
|
531
|
+
## create_data_request_event
|
388
532
|
|
389
|
-
|
390
|
-
> CreateSubmissionDataRequestTokenResponse create_data_request_token(data_request_id)
|
533
|
+
> <CreateSubmissionDataRequestEventResponse> create_data_request_event(data_request_id, event)
|
391
534
|
|
392
|
-
Creates a new
|
535
|
+
Creates a new event for emailing a signee a request for signature
|
536
|
+
|
537
|
+
### Examples
|
393
538
|
|
394
|
-
### Example
|
395
539
|
```ruby
|
396
|
-
|
540
|
+
require 'time'
|
397
541
|
require 'docspring'
|
398
542
|
# setup authorization
|
399
543
|
DocSpring.configure do |config|
|
@@ -404,25 +548,45 @@ end
|
|
404
548
|
|
405
549
|
api_instance = DocSpring::PDFApi.new
|
406
550
|
data_request_id = 'drq_000000000000000001' # String |
|
551
|
+
event = DocSpring::CreateSubmissionDataRequestEventRequest.new({event_type: 'send_request'}) # CreateSubmissionDataRequestEventRequest |
|
407
552
|
|
408
553
|
begin
|
409
|
-
#Creates a new
|
410
|
-
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)
|
411
556
|
p result
|
412
557
|
rescue DocSpring::ApiError => e
|
413
|
-
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}"
|
414
577
|
end
|
415
578
|
```
|
416
579
|
|
417
580
|
### Parameters
|
418
581
|
|
419
|
-
Name | Type | Description
|
420
|
-
|
421
|
-
**data_request_id** | **String
|
582
|
+
| Name | Type | Description | Notes |
|
583
|
+
| ---- | ---- | ----------- | ----- |
|
584
|
+
| **data_request_id** | **String** | | |
|
585
|
+
| **event** | [**CreateSubmissionDataRequestEventRequest**](CreateSubmissionDataRequestEventRequest.md) | | |
|
422
586
|
|
423
587
|
### Return type
|
424
588
|
|
425
|
-
[**
|
589
|
+
[**CreateSubmissionDataRequestEventResponse**](CreateSubmissionDataRequestEventResponse.md)
|
426
590
|
|
427
591
|
### Authorization
|
428
592
|
|
@@ -430,19 +594,20 @@ Name | Type | Description | Notes
|
|
430
594
|
|
431
595
|
### HTTP request headers
|
432
596
|
|
433
|
-
|
434
|
-
|
597
|
+
- **Content-Type**: application/json
|
598
|
+
- **Accept**: application/json
|
435
599
|
|
436
600
|
|
601
|
+
## create_data_request_token
|
437
602
|
|
438
|
-
|
439
|
-
> Folder create_folder(create_folder_data)
|
603
|
+
> <CreateSubmissionDataRequestTokenResponse> create_data_request_token(data_request_id)
|
440
604
|
|
441
|
-
|
605
|
+
Creates a new data request token for form authentication
|
606
|
+
|
607
|
+
### Examples
|
442
608
|
|
443
|
-
### Example
|
444
609
|
```ruby
|
445
|
-
|
610
|
+
require 'time'
|
446
611
|
require 'docspring'
|
447
612
|
# setup authorization
|
448
613
|
DocSpring.configure do |config|
|
@@ -452,26 +617,44 @@ DocSpring.configure do |config|
|
|
452
617
|
end
|
453
618
|
|
454
619
|
api_instance = DocSpring::PDFApi.new
|
455
|
-
|
620
|
+
data_request_id = 'drq_000000000000000001' # String |
|
456
621
|
|
457
622
|
begin
|
458
|
-
#
|
459
|
-
result = api_instance.
|
623
|
+
# Creates a new data request token for form authentication
|
624
|
+
result = api_instance.create_data_request_token(data_request_id)
|
460
625
|
p result
|
461
626
|
rescue DocSpring::ApiError => e
|
462
|
-
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}"
|
463
646
|
end
|
464
647
|
```
|
465
648
|
|
466
649
|
### Parameters
|
467
650
|
|
468
|
-
Name | Type | Description
|
469
|
-
|
470
|
-
**
|
651
|
+
| Name | Type | Description | Notes |
|
652
|
+
| ---- | ---- | ----------- | ----- |
|
653
|
+
| **data_request_id** | **String** | | |
|
471
654
|
|
472
655
|
### Return type
|
473
656
|
|
474
|
-
[**
|
657
|
+
[**CreateSubmissionDataRequestTokenResponse**](CreateSubmissionDataRequestTokenResponse.md)
|
475
658
|
|
476
659
|
### Authorization
|
477
660
|
|
@@ -479,19 +662,20 @@ Name | Type | Description | Notes
|
|
479
662
|
|
480
663
|
### HTTP request headers
|
481
664
|
|
482
|
-
|
483
|
-
|
665
|
+
- **Content-Type**: Not defined
|
666
|
+
- **Accept**: application/json
|
484
667
|
|
485
668
|
|
669
|
+
## create_folder
|
486
670
|
|
487
|
-
|
488
|
-
> PendingTemplate create_html_template(create_html_template_data)
|
671
|
+
> <Folder> create_folder(data)
|
489
672
|
|
490
|
-
Create a
|
673
|
+
Create a folder
|
674
|
+
|
675
|
+
### Examples
|
491
676
|
|
492
|
-
### Example
|
493
677
|
```ruby
|
494
|
-
|
678
|
+
require 'time'
|
495
679
|
require 'docspring'
|
496
680
|
# setup authorization
|
497
681
|
DocSpring.configure do |config|
|
@@ -501,26 +685,44 @@ DocSpring.configure do |config|
|
|
501
685
|
end
|
502
686
|
|
503
687
|
api_instance = DocSpring::PDFApi.new
|
504
|
-
|
688
|
+
data = DocSpring::CreateFolderData.new({folder: DocSpring::CreateFolderAttributes.new({name: 'name_example'})}) # CreateFolderData |
|
505
689
|
|
506
690
|
begin
|
507
|
-
#Create a
|
508
|
-
result = api_instance.
|
691
|
+
# Create a folder
|
692
|
+
result = api_instance.create_folder(data)
|
509
693
|
p result
|
510
694
|
rescue DocSpring::ApiError => e
|
511
|
-
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}"
|
512
714
|
end
|
513
715
|
```
|
514
716
|
|
515
717
|
### Parameters
|
516
718
|
|
517
|
-
Name | Type | Description
|
518
|
-
|
519
|
-
**
|
719
|
+
| Name | Type | Description | Notes |
|
720
|
+
| ---- | ---- | ----------- | ----- |
|
721
|
+
| **data** | [**CreateFolderData**](CreateFolderData.md) | | |
|
520
722
|
|
521
723
|
### Return type
|
522
724
|
|
523
|
-
[**
|
725
|
+
[**Folder**](Folder.md)
|
524
726
|
|
525
727
|
### Authorization
|
526
728
|
|
@@ -528,19 +730,20 @@ Name | Type | Description | Notes
|
|
528
730
|
|
529
731
|
### HTTP request headers
|
530
732
|
|
531
|
-
|
532
|
-
|
733
|
+
- **Content-Type**: application/json
|
734
|
+
- **Accept**: application/json
|
533
735
|
|
534
736
|
|
737
|
+
## create_html_template
|
535
738
|
|
536
|
-
|
537
|
-
> PendingTemplate create_pdf_template(template_document, template_name, opts)
|
739
|
+
> <PendingTemplate> create_html_template(data)
|
538
740
|
|
539
|
-
Create a new
|
741
|
+
Create a new HTML template
|
742
|
+
|
743
|
+
### Examples
|
540
744
|
|
541
|
-
### Example
|
542
745
|
```ruby
|
543
|
-
|
746
|
+
require 'time'
|
544
747
|
require 'docspring'
|
545
748
|
# setup authorization
|
546
749
|
DocSpring.configure do |config|
|
@@ -550,28 +753,40 @@ DocSpring.configure do |config|
|
|
550
753
|
end
|
551
754
|
|
552
755
|
api_instance = DocSpring::PDFApi.new
|
553
|
-
|
554
|
-
template_name = 'template_name_example' # String |
|
555
|
-
opts = {
|
556
|
-
template_parent_folder_id: 'template_parent_folder_id_example' # String |
|
557
|
-
}
|
756
|
+
data = DocSpring::CreateHtmlTemplateData.new({template: DocSpring::HtmlTemplateData.new({name: 'name_example'})}) # CreateHtmlTemplateData |
|
558
757
|
|
559
758
|
begin
|
560
|
-
#Create a new
|
561
|
-
result = api_instance.
|
759
|
+
# Create a new HTML template
|
760
|
+
result = api_instance.create_html_template(data)
|
562
761
|
p result
|
563
762
|
rescue DocSpring::ApiError => e
|
564
|
-
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}"
|
565
782
|
end
|
566
783
|
```
|
567
784
|
|
568
785
|
### Parameters
|
569
786
|
|
570
|
-
Name | Type | Description
|
571
|
-
|
572
|
-
**
|
573
|
-
**template_name** | **String**| |
|
574
|
-
**template_parent_folder_id** | **String**| | [optional]
|
787
|
+
| Name | Type | Description | Notes |
|
788
|
+
| ---- | ---- | ----------- | ----- |
|
789
|
+
| **data** | [**CreateHtmlTemplateData**](CreateHtmlTemplateData.md) | | |
|
575
790
|
|
576
791
|
### Return type
|
577
792
|
|
@@ -583,19 +798,20 @@ Name | Type | Description | Notes
|
|
583
798
|
|
584
799
|
### HTTP request headers
|
585
800
|
|
586
|
-
|
587
|
-
|
801
|
+
- **Content-Type**: application/json
|
802
|
+
- **Accept**: application/json
|
588
803
|
|
589
804
|
|
805
|
+
## create_pdf_template
|
590
806
|
|
591
|
-
|
592
|
-
> PendingTemplate create_pdf_template_from_upload(create_template_from_upload_data)
|
807
|
+
> <PendingTemplate> create_pdf_template(template_document, template_name, opts)
|
593
808
|
|
594
|
-
Create a new PDF template
|
809
|
+
Create a new PDF template with a form POST file upload
|
810
|
+
|
811
|
+
### Examples
|
595
812
|
|
596
|
-
### Example
|
597
813
|
```ruby
|
598
|
-
|
814
|
+
require 'time'
|
599
815
|
require 'docspring'
|
600
816
|
# setup authorization
|
601
817
|
DocSpring.configure do |config|
|
@@ -605,22 +821,46 @@ DocSpring.configure do |config|
|
|
605
821
|
end
|
606
822
|
|
607
823
|
api_instance = DocSpring::PDFApi.new
|
608
|
-
|
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
|
+
}
|
609
829
|
|
610
830
|
begin
|
611
|
-
#Create a new PDF template
|
612
|
-
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)
|
613
833
|
p result
|
614
834
|
rescue DocSpring::ApiError => e
|
615
|
-
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}"
|
616
854
|
end
|
617
855
|
```
|
618
856
|
|
619
857
|
### Parameters
|
620
858
|
|
621
|
-
Name | Type | Description
|
622
|
-
|
623
|
-
**
|
859
|
+
| Name | Type | Description | Notes |
|
860
|
+
| ---- | ---- | ----------- | ----- |
|
861
|
+
| **template_document** | **File** | | |
|
862
|
+
| **template_name** | **String** | | |
|
863
|
+
| **template_parent_folder_id** | **String** | | [optional] |
|
624
864
|
|
625
865
|
### Return type
|
626
866
|
|
@@ -632,19 +872,20 @@ Name | Type | Description | Notes
|
|
632
872
|
|
633
873
|
### HTTP request headers
|
634
874
|
|
635
|
-
|
636
|
-
|
875
|
+
- **Content-Type**: multipart/form-data
|
876
|
+
- **Accept**: application/json
|
637
877
|
|
638
878
|
|
879
|
+
## create_pdf_template_from_upload
|
639
880
|
|
640
|
-
|
641
|
-
> Folder delete_folder(folder_id)
|
881
|
+
> <PendingTemplate> create_pdf_template_from_upload(data)
|
642
882
|
|
643
|
-
|
883
|
+
Create a new PDF template from a cached presign upload
|
884
|
+
|
885
|
+
### Examples
|
644
886
|
|
645
|
-
### Example
|
646
887
|
```ruby
|
647
|
-
|
888
|
+
require 'time'
|
648
889
|
require 'docspring'
|
649
890
|
# setup authorization
|
650
891
|
DocSpring.configure do |config|
|
@@ -654,26 +895,44 @@ DocSpring.configure do |config|
|
|
654
895
|
end
|
655
896
|
|
656
897
|
api_instance = DocSpring::PDFApi.new
|
657
|
-
|
898
|
+
data = DocSpring::CreateTemplateFromUploadData.new({template: DocSpring::UploadTemplateData.new({name: 'name_example'})}) # CreateTemplateFromUploadData |
|
658
899
|
|
659
900
|
begin
|
660
|
-
#
|
661
|
-
result = api_instance.
|
901
|
+
# Create a new PDF template from a cached presign upload
|
902
|
+
result = api_instance.create_pdf_template_from_upload(data)
|
662
903
|
p result
|
663
904
|
rescue DocSpring::ApiError => e
|
664
|
-
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}"
|
665
924
|
end
|
666
925
|
```
|
667
926
|
|
668
927
|
### Parameters
|
669
928
|
|
670
|
-
Name | Type | Description
|
671
|
-
|
672
|
-
**
|
929
|
+
| Name | Type | Description | Notes |
|
930
|
+
| ---- | ---- | ----------- | ----- |
|
931
|
+
| **data** | [**CreateTemplateFromUploadData**](CreateTemplateFromUploadData.md) | | |
|
673
932
|
|
674
933
|
### Return type
|
675
934
|
|
676
|
-
[**
|
935
|
+
[**PendingTemplate**](PendingTemplate.md)
|
677
936
|
|
678
937
|
### Authorization
|
679
938
|
|
@@ -681,19 +940,20 @@ Name | Type | Description | Notes
|
|
681
940
|
|
682
941
|
### HTTP request headers
|
683
942
|
|
684
|
-
|
685
|
-
|
943
|
+
- **Content-Type**: application/json
|
944
|
+
- **Accept**: application/json
|
686
945
|
|
687
946
|
|
947
|
+
## delete_folder
|
688
948
|
|
689
|
-
|
690
|
-
> CombinedSubmission expire_combined_submission(combined_submission_id)
|
949
|
+
> <Folder> delete_folder(folder_id)
|
691
950
|
|
692
|
-
|
951
|
+
Delete a folder
|
952
|
+
|
953
|
+
### Examples
|
693
954
|
|
694
|
-
### Example
|
695
955
|
```ruby
|
696
|
-
|
956
|
+
require 'time'
|
697
957
|
require 'docspring'
|
698
958
|
# setup authorization
|
699
959
|
DocSpring.configure do |config|
|
@@ -703,26 +963,44 @@ DocSpring.configure do |config|
|
|
703
963
|
end
|
704
964
|
|
705
965
|
api_instance = DocSpring::PDFApi.new
|
706
|
-
|
966
|
+
folder_id = 'fld_0000000000000000001' # String |
|
707
967
|
|
708
968
|
begin
|
709
|
-
#
|
710
|
-
result = api_instance.
|
969
|
+
# Delete a folder
|
970
|
+
result = api_instance.delete_folder(folder_id)
|
711
971
|
p result
|
712
972
|
rescue DocSpring::ApiError => e
|
713
|
-
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}"
|
714
992
|
end
|
715
993
|
```
|
716
994
|
|
717
995
|
### Parameters
|
718
996
|
|
719
|
-
Name | Type | Description
|
720
|
-
|
721
|
-
**
|
997
|
+
| Name | Type | Description | Notes |
|
998
|
+
| ---- | ---- | ----------- | ----- |
|
999
|
+
| **folder_id** | **String** | | |
|
722
1000
|
|
723
1001
|
### Return type
|
724
1002
|
|
725
|
-
[**
|
1003
|
+
[**Folder**](Folder.md)
|
726
1004
|
|
727
1005
|
### Authorization
|
728
1006
|
|
@@ -730,19 +1008,20 @@ Name | Type | Description | Notes
|
|
730
1008
|
|
731
1009
|
### HTTP request headers
|
732
1010
|
|
733
|
-
|
734
|
-
|
1011
|
+
- **Content-Type**: Not defined
|
1012
|
+
- **Accept**: application/json
|
735
1013
|
|
736
1014
|
|
1015
|
+
## delete_template
|
737
1016
|
|
738
|
-
|
739
|
-
> Submission expire_submission(submission_id)
|
1017
|
+
> <DeleteTemplateResponse> delete_template(template_id, opts)
|
740
1018
|
|
741
|
-
|
1019
|
+
Delete a template
|
1020
|
+
|
1021
|
+
### Examples
|
742
1022
|
|
743
|
-
### Example
|
744
1023
|
```ruby
|
745
|
-
|
1024
|
+
require 'time'
|
746
1025
|
require 'docspring'
|
747
1026
|
# setup authorization
|
748
1027
|
DocSpring.configure do |config|
|
@@ -752,26 +1031,48 @@ DocSpring.configure do |config|
|
|
752
1031
|
end
|
753
1032
|
|
754
1033
|
api_instance = DocSpring::PDFApi.new
|
755
|
-
|
1034
|
+
template_id = 'tpl_000000000000000001' # String |
|
1035
|
+
opts = {
|
1036
|
+
version: '0.1.0' # String |
|
1037
|
+
}
|
756
1038
|
|
757
1039
|
begin
|
758
|
-
#
|
759
|
-
result = api_instance.
|
1040
|
+
# Delete a template
|
1041
|
+
result = api_instance.delete_template(template_id, opts)
|
760
1042
|
p result
|
761
1043
|
rescue DocSpring::ApiError => e
|
762
|
-
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}"
|
763
1063
|
end
|
764
1064
|
```
|
765
1065
|
|
766
1066
|
### Parameters
|
767
1067
|
|
768
|
-
Name | Type | Description
|
769
|
-
|
770
|
-
**
|
1068
|
+
| Name | Type | Description | Notes |
|
1069
|
+
| ---- | ---- | ----------- | ----- |
|
1070
|
+
| **template_id** | **String** | | |
|
1071
|
+
| **version** | **String** | | [optional] |
|
771
1072
|
|
772
1073
|
### Return type
|
773
1074
|
|
774
|
-
[**
|
1075
|
+
[**DeleteTemplateResponse**](DeleteTemplateResponse.md)
|
775
1076
|
|
776
1077
|
### Authorization
|
777
1078
|
|
@@ -779,19 +1080,20 @@ Name | Type | Description | Notes
|
|
779
1080
|
|
780
1081
|
### HTTP request headers
|
781
1082
|
|
782
|
-
|
783
|
-
|
1083
|
+
- **Content-Type**: Not defined
|
1084
|
+
- **Accept**: application/json
|
784
1085
|
|
785
1086
|
|
1087
|
+
## expire_combined_submission
|
786
1088
|
|
787
|
-
|
788
|
-
> CreateSubmissionResponse generate_pdf(template_id, submission_data)
|
1089
|
+
> <CombinedSubmission> expire_combined_submission(combined_submission_id)
|
789
1090
|
|
790
|
-
|
1091
|
+
Expire a combined submission
|
1092
|
+
|
1093
|
+
### Examples
|
791
1094
|
|
792
|
-
### Example
|
793
1095
|
```ruby
|
794
|
-
|
1096
|
+
require 'time'
|
795
1097
|
require 'docspring'
|
796
1098
|
# setup authorization
|
797
1099
|
DocSpring.configure do |config|
|
@@ -801,28 +1103,44 @@ DocSpring.configure do |config|
|
|
801
1103
|
end
|
802
1104
|
|
803
1105
|
api_instance = DocSpring::PDFApi.new
|
804
|
-
|
805
|
-
submission_data = DocSpring::SubmissionData.new # SubmissionData |
|
1106
|
+
combined_submission_id = 'com_0000000000000000001' # String |
|
806
1107
|
|
807
1108
|
begin
|
808
|
-
#
|
809
|
-
result = api_instance.
|
1109
|
+
# Expire a combined submission
|
1110
|
+
result = api_instance.expire_combined_submission(combined_submission_id)
|
810
1111
|
p result
|
811
1112
|
rescue DocSpring::ApiError => e
|
812
|
-
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}"
|
813
1132
|
end
|
814
1133
|
```
|
815
1134
|
|
816
1135
|
### Parameters
|
817
1136
|
|
818
|
-
Name | Type | Description
|
819
|
-
|
820
|
-
**
|
821
|
-
**submission_data** | [**SubmissionData**](SubmissionData.md)| |
|
1137
|
+
| Name | Type | Description | Notes |
|
1138
|
+
| ---- | ---- | ----------- | ----- |
|
1139
|
+
| **combined_submission_id** | **String** | | |
|
822
1140
|
|
823
1141
|
### Return type
|
824
1142
|
|
825
|
-
[**
|
1143
|
+
[**CombinedSubmission**](CombinedSubmission.md)
|
826
1144
|
|
827
1145
|
### Authorization
|
828
1146
|
|
@@ -830,19 +1148,20 @@ Name | Type | Description | Notes
|
|
830
1148
|
|
831
1149
|
### HTTP request headers
|
832
1150
|
|
833
|
-
|
834
|
-
|
1151
|
+
- **Content-Type**: Not defined
|
1152
|
+
- **Accept**: application/json
|
835
1153
|
|
836
1154
|
|
1155
|
+
## expire_submission
|
837
1156
|
|
838
|
-
|
839
|
-
> CombinedSubmission get_combined_submission(combined_submission_id)
|
1157
|
+
> <Submission> expire_submission(submission_id)
|
840
1158
|
|
841
|
-
|
1159
|
+
Expire a PDF submission
|
1160
|
+
|
1161
|
+
### Examples
|
842
1162
|
|
843
|
-
### Example
|
844
1163
|
```ruby
|
845
|
-
|
1164
|
+
require 'time'
|
846
1165
|
require 'docspring'
|
847
1166
|
# setup authorization
|
848
1167
|
DocSpring.configure do |config|
|
@@ -852,26 +1171,44 @@ DocSpring.configure do |config|
|
|
852
1171
|
end
|
853
1172
|
|
854
1173
|
api_instance = DocSpring::PDFApi.new
|
855
|
-
|
1174
|
+
submission_id = 'sub_000000000000000001' # String |
|
856
1175
|
|
857
1176
|
begin
|
858
|
-
#
|
859
|
-
result = api_instance.
|
1177
|
+
# Expire a PDF submission
|
1178
|
+
result = api_instance.expire_submission(submission_id)
|
860
1179
|
p result
|
861
1180
|
rescue DocSpring::ApiError => e
|
862
|
-
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}"
|
863
1200
|
end
|
864
1201
|
```
|
865
1202
|
|
866
1203
|
### Parameters
|
867
1204
|
|
868
|
-
Name | Type | Description
|
869
|
-
|
870
|
-
**
|
1205
|
+
| Name | Type | Description | Notes |
|
1206
|
+
| ---- | ---- | ----------- | ----- |
|
1207
|
+
| **submission_id** | **String** | | |
|
871
1208
|
|
872
1209
|
### Return type
|
873
1210
|
|
874
|
-
[**
|
1211
|
+
[**Submission**](Submission.md)
|
875
1212
|
|
876
1213
|
### Authorization
|
877
1214
|
|
@@ -879,19 +1216,20 @@ Name | Type | Description | Notes
|
|
879
1216
|
|
880
1217
|
### HTTP request headers
|
881
1218
|
|
882
|
-
|
883
|
-
|
1219
|
+
- **Content-Type**: Not defined
|
1220
|
+
- **Accept**: application/json
|
884
1221
|
|
885
1222
|
|
1223
|
+
## generate_pdf
|
886
1224
|
|
887
|
-
|
888
|
-
> SubmissionDataRequest get_data_request(data_request_id)
|
1225
|
+
> <CreateSubmissionResponse> generate_pdf(template_id, submission)
|
889
1226
|
|
890
|
-
|
1227
|
+
Generates a new PDF
|
1228
|
+
|
1229
|
+
### Examples
|
891
1230
|
|
892
|
-
### Example
|
893
1231
|
```ruby
|
894
|
-
|
1232
|
+
require 'time'
|
895
1233
|
require 'docspring'
|
896
1234
|
# setup authorization
|
897
1235
|
DocSpring.configure do |config|
|
@@ -901,26 +1239,46 @@ DocSpring.configure do |config|
|
|
901
1239
|
end
|
902
1240
|
|
903
1241
|
api_instance = DocSpring::PDFApi.new
|
904
|
-
|
1242
|
+
template_id = 'tpl_000000000000000001' # String |
|
1243
|
+
submission = DocSpring::CreateSubmissionData.new({data: 3.56}) # CreateSubmissionData |
|
905
1244
|
|
906
1245
|
begin
|
907
|
-
#
|
908
|
-
result = api_instance.
|
1246
|
+
# Generates a new PDF
|
1247
|
+
result = api_instance.generate_pdf(template_id, submission)
|
909
1248
|
p result
|
910
1249
|
rescue DocSpring::ApiError => e
|
911
|
-
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}"
|
912
1269
|
end
|
913
1270
|
```
|
914
1271
|
|
915
1272
|
### Parameters
|
916
1273
|
|
917
|
-
Name | Type | Description
|
918
|
-
|
919
|
-
**
|
1274
|
+
| Name | Type | Description | Notes |
|
1275
|
+
| ---- | ---- | ----------- | ----- |
|
1276
|
+
| **template_id** | **String** | | |
|
1277
|
+
| **submission** | [**CreateSubmissionData**](CreateSubmissionData.md) | | |
|
920
1278
|
|
921
1279
|
### Return type
|
922
1280
|
|
923
|
-
[**
|
1281
|
+
[**CreateSubmissionResponse**](CreateSubmissionResponse.md)
|
924
1282
|
|
925
1283
|
### Authorization
|
926
1284
|
|
@@ -928,19 +1286,20 @@ Name | Type | Description | Notes
|
|
928
1286
|
|
929
1287
|
### HTTP request headers
|
930
1288
|
|
931
|
-
|
932
|
-
|
1289
|
+
- **Content-Type**: application/json
|
1290
|
+
- **Accept**: application/json
|
933
1291
|
|
934
1292
|
|
1293
|
+
## generate_preview
|
935
1294
|
|
936
|
-
|
937
|
-
> Hash<String, Object> get_presign_url
|
1295
|
+
> <PreviewPdfResponse> generate_preview(submission_id)
|
938
1296
|
|
939
|
-
|
1297
|
+
Generated a preview PDF for partially completed data requests
|
1298
|
+
|
1299
|
+
### Examples
|
940
1300
|
|
941
|
-
### Example
|
942
1301
|
```ruby
|
943
|
-
|
1302
|
+
require 'time'
|
944
1303
|
require 'docspring'
|
945
1304
|
# setup authorization
|
946
1305
|
DocSpring.configure do |config|
|
@@ -950,42 +1309,546 @@ DocSpring.configure do |config|
|
|
950
1309
|
end
|
951
1310
|
|
952
1311
|
api_instance = DocSpring::PDFApi.new
|
1312
|
+
submission_id = 'sub_00000000000000001' # String |
|
953
1313
|
|
954
1314
|
begin
|
955
|
-
#
|
956
|
-
result = api_instance.
|
1315
|
+
# Generated a preview PDF for partially completed data requests
|
1316
|
+
result = api_instance.generate_preview(submission_id)
|
957
1317
|
p result
|
958
1318
|
rescue DocSpring::ApiError => e
|
959
|
-
puts "
|
1319
|
+
puts "Error when calling PDFApi->generate_preview: #{e}"
|
960
1320
|
end
|
961
1321
|
```
|
962
1322
|
|
963
|
-
|
964
|
-
This endpoint does not need any parameter.
|
965
|
-
|
966
|
-
### Return type
|
1323
|
+
#### Using the generate_preview_with_http_info variant
|
967
1324
|
|
968
|
-
|
1325
|
+
This returns an Array which contains the response data, status code and headers.
|
969
1326
|
|
970
|
-
|
971
|
-
|
972
|
-
[api_token_basic](../README.md#api_token_basic)
|
1327
|
+
> <Array(<PreviewPdfResponse>, Integer, Hash)> generate_preview_with_http_info(submission_id)
|
973
1328
|
|
974
|
-
|
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)
|
1554
|
+
|
1555
|
+
### Authorization
|
1556
|
+
|
1557
|
+
[api_token_basic](../README.md#api_token_basic)
|
1558
|
+
|
1559
|
+
### HTTP request headers
|
1560
|
+
|
1561
|
+
- **Content-Type**: Not defined
|
1562
|
+
- **Accept**: application/json
|
1563
|
+
|
1564
|
+
|
1565
|
+
## get_presign_url
|
1566
|
+
|
1567
|
+
> <UploadPresign> get_presign_url
|
1568
|
+
|
1569
|
+
Get a presigned URL so that you can upload a file to our AWS S3 bucket
|
1570
|
+
|
1571
|
+
### Examples
|
1572
|
+
|
1573
|
+
```ruby
|
1574
|
+
require 'time'
|
1575
|
+
require 'docspring'
|
1576
|
+
# setup authorization
|
1577
|
+
DocSpring.configure do |config|
|
1578
|
+
# Configure HTTP basic authorization: api_token_basic
|
1579
|
+
config.username = 'YOUR USERNAME'
|
1580
|
+
config.password = 'YOUR PASSWORD'
|
1581
|
+
end
|
1582
|
+
|
1583
|
+
api_instance = DocSpring::PDFApi.new
|
1584
|
+
|
1585
|
+
begin
|
1586
|
+
# Get a presigned URL so that you can upload a file to our AWS S3 bucket
|
1587
|
+
result = api_instance.get_presign_url
|
1588
|
+
p result
|
1589
|
+
rescue DocSpring::ApiError => e
|
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}"
|
1609
|
+
end
|
1610
|
+
```
|
1611
|
+
|
1612
|
+
### Parameters
|
1613
|
+
|
1614
|
+
This endpoint does not need any parameter.
|
1615
|
+
|
1616
|
+
### Return type
|
1617
|
+
|
1618
|
+
[**UploadPresign**](UploadPresign.md)
|
1619
|
+
|
1620
|
+
### Authorization
|
1621
|
+
|
1622
|
+
[api_token_basic](../README.md#api_token_basic)
|
1623
|
+
|
1624
|
+
### HTTP request headers
|
1625
|
+
|
1626
|
+
- **Content-Type**: Not defined
|
1627
|
+
- **Accept**: application/json
|
1628
|
+
|
1629
|
+
|
1630
|
+
## get_submission
|
1631
|
+
|
1632
|
+
> <Submission> get_submission(submission_id, opts)
|
1633
|
+
|
1634
|
+
Check the status of a PDF
|
1635
|
+
|
1636
|
+
### Examples
|
1637
|
+
|
1638
|
+
```ruby
|
1639
|
+
require 'time'
|
1640
|
+
require 'docspring'
|
1641
|
+
# setup authorization
|
1642
|
+
DocSpring.configure do |config|
|
1643
|
+
# Configure HTTP basic authorization: api_token_basic
|
1644
|
+
config.username = 'YOUR USERNAME'
|
1645
|
+
config.password = 'YOUR PASSWORD'
|
1646
|
+
end
|
1647
|
+
|
1648
|
+
api_instance = DocSpring::PDFApi.new
|
1649
|
+
submission_id = 'sub_000000000000000001' # String |
|
1650
|
+
opts = {
|
1651
|
+
include_data: true # Boolean |
|
1652
|
+
}
|
1653
|
+
|
1654
|
+
begin
|
1655
|
+
# Check the status of a PDF
|
1656
|
+
result = api_instance.get_submission(submission_id, opts)
|
1657
|
+
p result
|
1658
|
+
rescue DocSpring::ApiError => e
|
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}"
|
1678
|
+
end
|
1679
|
+
```
|
1680
|
+
|
1681
|
+
### Parameters
|
1682
|
+
|
1683
|
+
| Name | Type | Description | Notes |
|
1684
|
+
| ---- | ---- | ----------- | ----- |
|
1685
|
+
| **submission_id** | **String** | | |
|
1686
|
+
| **include_data** | **Boolean** | | [optional] |
|
1687
|
+
|
1688
|
+
### Return type
|
1689
|
+
|
1690
|
+
[**Submission**](Submission.md)
|
1691
|
+
|
1692
|
+
### Authorization
|
1693
|
+
|
1694
|
+
[api_token_basic](../README.md#api_token_basic)
|
1695
|
+
|
1696
|
+
### HTTP request headers
|
1697
|
+
|
1698
|
+
- **Content-Type**: Not defined
|
1699
|
+
- **Accept**: application/json
|
1700
|
+
|
1701
|
+
|
1702
|
+
## get_submission_batch
|
1703
|
+
|
1704
|
+
> <SubmissionBatch> get_submission_batch(submission_batch_id, opts)
|
1705
|
+
|
1706
|
+
Check the status of a submission batch job
|
1707
|
+
|
1708
|
+
### Examples
|
1709
|
+
|
1710
|
+
```ruby
|
1711
|
+
require 'time'
|
1712
|
+
require 'docspring'
|
1713
|
+
# setup authorization
|
1714
|
+
DocSpring.configure do |config|
|
1715
|
+
# Configure HTTP basic authorization: api_token_basic
|
1716
|
+
config.username = 'YOUR USERNAME'
|
1717
|
+
config.password = 'YOUR PASSWORD'
|
1718
|
+
end
|
1719
|
+
|
1720
|
+
api_instance = DocSpring::PDFApi.new
|
1721
|
+
submission_batch_id = 'sbb_000000000000000001' # String |
|
1722
|
+
opts = {
|
1723
|
+
include_submissions: true # Boolean |
|
1724
|
+
}
|
1725
|
+
|
1726
|
+
begin
|
1727
|
+
# Check the status of a submission batch job
|
1728
|
+
result = api_instance.get_submission_batch(submission_batch_id, opts)
|
1729
|
+
p result
|
1730
|
+
rescue DocSpring::ApiError => e
|
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}"
|
1750
|
+
end
|
1751
|
+
```
|
1752
|
+
|
1753
|
+
### Parameters
|
1754
|
+
|
1755
|
+
| Name | Type | Description | Notes |
|
1756
|
+
| ---- | ---- | ----------- | ----- |
|
1757
|
+
| **submission_batch_id** | **String** | | |
|
1758
|
+
| **include_submissions** | **Boolean** | | [optional] |
|
1759
|
+
|
1760
|
+
### Return type
|
1761
|
+
|
1762
|
+
[**SubmissionBatch**](SubmissionBatch.md)
|
1763
|
+
|
1764
|
+
### Authorization
|
1765
|
+
|
1766
|
+
[api_token_basic](../README.md#api_token_basic)
|
1767
|
+
|
1768
|
+
### HTTP request headers
|
1769
|
+
|
1770
|
+
- **Content-Type**: Not defined
|
1771
|
+
- **Accept**: application/json
|
1772
|
+
|
1773
|
+
|
1774
|
+
## get_template
|
1775
|
+
|
1776
|
+
> <Template> get_template(template_id)
|
1777
|
+
|
1778
|
+
Check the status of an uploaded template
|
1779
|
+
|
1780
|
+
### Examples
|
1781
|
+
|
1782
|
+
```ruby
|
1783
|
+
require 'time'
|
1784
|
+
require 'docspring'
|
1785
|
+
# setup authorization
|
1786
|
+
DocSpring.configure do |config|
|
1787
|
+
# Configure HTTP basic authorization: api_token_basic
|
1788
|
+
config.username = 'YOUR USERNAME'
|
1789
|
+
config.password = 'YOUR PASSWORD'
|
1790
|
+
end
|
1791
|
+
|
1792
|
+
api_instance = DocSpring::PDFApi.new
|
1793
|
+
template_id = 'tpl_000000000000000001' # String |
|
1794
|
+
|
1795
|
+
begin
|
1796
|
+
# Check the status of an uploaded template
|
1797
|
+
result = api_instance.get_template(template_id)
|
1798
|
+
p result
|
1799
|
+
rescue DocSpring::ApiError => e
|
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}"
|
1819
|
+
end
|
1820
|
+
```
|
1821
|
+
|
1822
|
+
### Parameters
|
1823
|
+
|
1824
|
+
| Name | Type | Description | Notes |
|
1825
|
+
| ---- | ---- | ----------- | ----- |
|
1826
|
+
| **template_id** | **String** | | |
|
975
1827
|
|
976
|
-
|
977
|
-
- **Accept**: application/json
|
1828
|
+
### Return type
|
978
1829
|
|
1830
|
+
[**Template**](Template.md)
|
979
1831
|
|
1832
|
+
### Authorization
|
980
1833
|
|
981
|
-
#
|
982
|
-
> Submission get_submission(submission_id, opts)
|
1834
|
+
[api_token_basic](../README.md#api_token_basic)
|
983
1835
|
|
984
|
-
|
1836
|
+
### HTTP request headers
|
1837
|
+
|
1838
|
+
- **Content-Type**: Not defined
|
1839
|
+
- **Accept**: application/json
|
1840
|
+
|
1841
|
+
|
1842
|
+
## get_template_schema
|
1843
|
+
|
1844
|
+
> <TemplateSchema> get_template_schema(template_id)
|
1845
|
+
|
1846
|
+
Fetch the JSON schema for a template
|
1847
|
+
|
1848
|
+
### Examples
|
985
1849
|
|
986
|
-
### Example
|
987
1850
|
```ruby
|
988
|
-
|
1851
|
+
require 'time'
|
989
1852
|
require 'docspring'
|
990
1853
|
# setup authorization
|
991
1854
|
DocSpring.configure do |config|
|
@@ -995,30 +1858,44 @@ DocSpring.configure do |config|
|
|
995
1858
|
end
|
996
1859
|
|
997
1860
|
api_instance = DocSpring::PDFApi.new
|
998
|
-
|
999
|
-
opts = {
|
1000
|
-
include_data: true # BOOLEAN |
|
1001
|
-
}
|
1861
|
+
template_id = 'tpl_000000000000000001' # String |
|
1002
1862
|
|
1003
1863
|
begin
|
1004
|
-
#
|
1005
|
-
result = api_instance.
|
1864
|
+
# Fetch the JSON schema for a template
|
1865
|
+
result = api_instance.get_template_schema(template_id)
|
1006
1866
|
p result
|
1007
1867
|
rescue DocSpring::ApiError => e
|
1008
|
-
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}"
|
1009
1887
|
end
|
1010
1888
|
```
|
1011
1889
|
|
1012
1890
|
### Parameters
|
1013
1891
|
|
1014
|
-
Name | Type | Description
|
1015
|
-
|
1016
|
-
**
|
1017
|
-
**include_data** | **BOOLEAN**| | [optional]
|
1892
|
+
| Name | Type | Description | Notes |
|
1893
|
+
| ---- | ---- | ----------- | ----- |
|
1894
|
+
| **template_id** | **String** | | |
|
1018
1895
|
|
1019
1896
|
### Return type
|
1020
1897
|
|
1021
|
-
[**
|
1898
|
+
[**TemplateSchema**](TemplateSchema.md)
|
1022
1899
|
|
1023
1900
|
### Authorization
|
1024
1901
|
|
@@ -1026,19 +1903,20 @@ Name | Type | Description | Notes
|
|
1026
1903
|
|
1027
1904
|
### HTTP request headers
|
1028
1905
|
|
1029
|
-
|
1030
|
-
|
1906
|
+
- **Content-Type**: Not defined
|
1907
|
+
- **Accept**: application/json
|
1031
1908
|
|
1032
1909
|
|
1910
|
+
## list_combined_submissions
|
1033
1911
|
|
1034
|
-
|
1035
|
-
> SubmissionBatch get_submission_batch(submission_batch_id, opts)
|
1912
|
+
> <Array<CombinedSubmission>> list_combined_submissions(opts)
|
1036
1913
|
|
1037
|
-
|
1914
|
+
Get a list of all combined submissions
|
1915
|
+
|
1916
|
+
### Examples
|
1038
1917
|
|
1039
|
-
### Example
|
1040
1918
|
```ruby
|
1041
|
-
|
1919
|
+
require 'time'
|
1042
1920
|
require 'docspring'
|
1043
1921
|
# setup authorization
|
1044
1922
|
DocSpring.configure do |config|
|
@@ -1048,30 +1926,48 @@ DocSpring.configure do |config|
|
|
1048
1926
|
end
|
1049
1927
|
|
1050
1928
|
api_instance = DocSpring::PDFApi.new
|
1051
|
-
submission_batch_id = 'sbb_000000000000000001' # String |
|
1052
1929
|
opts = {
|
1053
|
-
|
1930
|
+
page: 2, # Integer | Default: 1
|
1931
|
+
per_page: 1 # Integer | Default: 50
|
1054
1932
|
}
|
1055
1933
|
|
1056
1934
|
begin
|
1057
|
-
#
|
1058
|
-
result = api_instance.
|
1935
|
+
# Get a list of all combined submissions
|
1936
|
+
result = api_instance.list_combined_submissions(opts)
|
1059
1937
|
p result
|
1060
1938
|
rescue DocSpring::ApiError => e
|
1061
|
-
puts "
|
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}"
|
1062
1958
|
end
|
1063
1959
|
```
|
1064
1960
|
|
1065
1961
|
### Parameters
|
1066
1962
|
|
1067
|
-
Name | Type | Description
|
1068
|
-
|
1069
|
-
**
|
1070
|
-
**
|
1963
|
+
| Name | Type | Description | Notes |
|
1964
|
+
| ---- | ---- | ----------- | ----- |
|
1965
|
+
| **page** | **Integer** | Default: 1 | [optional] |
|
1966
|
+
| **per_page** | **Integer** | Default: 50 | [optional] |
|
1071
1967
|
|
1072
1968
|
### Return type
|
1073
1969
|
|
1074
|
-
[**
|
1970
|
+
[**Array<CombinedSubmission>**](CombinedSubmission.md)
|
1075
1971
|
|
1076
1972
|
### Authorization
|
1077
1973
|
|
@@ -1079,19 +1975,20 @@ Name | Type | Description | Notes
|
|
1079
1975
|
|
1080
1976
|
### HTTP request headers
|
1081
1977
|
|
1082
|
-
|
1083
|
-
|
1978
|
+
- **Content-Type**: Not defined
|
1979
|
+
- **Accept**: application/json
|
1980
|
+
|
1084
1981
|
|
1982
|
+
## list_folders
|
1085
1983
|
|
1984
|
+
> <Array<Folder>> list_folders(opts)
|
1086
1985
|
|
1087
|
-
|
1088
|
-
> Template get_template(template_id)
|
1986
|
+
Get a list of all folders
|
1089
1987
|
|
1090
|
-
|
1988
|
+
### Examples
|
1091
1989
|
|
1092
|
-
### Example
|
1093
1990
|
```ruby
|
1094
|
-
|
1991
|
+
require 'time'
|
1095
1992
|
require 'docspring'
|
1096
1993
|
# setup authorization
|
1097
1994
|
DocSpring.configure do |config|
|
@@ -1101,26 +1998,46 @@ DocSpring.configure do |config|
|
|
1101
1998
|
end
|
1102
1999
|
|
1103
2000
|
api_instance = DocSpring::PDFApi.new
|
1104
|
-
|
2001
|
+
opts = {
|
2002
|
+
parent_folder_id: 'fld_0000000000000000002' # String | Filter By Folder Id
|
2003
|
+
}
|
1105
2004
|
|
1106
2005
|
begin
|
1107
|
-
#Get a
|
1108
|
-
result = api_instance.
|
2006
|
+
# Get a list of all folders
|
2007
|
+
result = api_instance.list_folders(opts)
|
1109
2008
|
p result
|
1110
2009
|
rescue DocSpring::ApiError => e
|
1111
|
-
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}"
|
1112
2029
|
end
|
1113
2030
|
```
|
1114
2031
|
|
1115
2032
|
### Parameters
|
1116
2033
|
|
1117
|
-
Name | Type | Description
|
1118
|
-
|
1119
|
-
**
|
2034
|
+
| Name | Type | Description | Notes |
|
2035
|
+
| ---- | ---- | ----------- | ----- |
|
2036
|
+
| **parent_folder_id** | **String** | Filter By Folder Id | [optional] |
|
1120
2037
|
|
1121
2038
|
### Return type
|
1122
2039
|
|
1123
|
-
[**
|
2040
|
+
[**Array<Folder>**](Folder.md)
|
1124
2041
|
|
1125
2042
|
### Authorization
|
1126
2043
|
|
@@ -1128,19 +2045,20 @@ Name | Type | Description | Notes
|
|
1128
2045
|
|
1129
2046
|
### HTTP request headers
|
1130
2047
|
|
1131
|
-
|
1132
|
-
|
2048
|
+
- **Content-Type**: Not defined
|
2049
|
+
- **Accept**: application/json
|
1133
2050
|
|
1134
2051
|
|
2052
|
+
## list_submissions
|
1135
2053
|
|
1136
|
-
|
1137
|
-
> Hash<String, Object> get_template_schema(template_id)
|
2054
|
+
> <ListSubmissionsResponse> list_submissions(opts)
|
1138
2055
|
|
1139
|
-
|
2056
|
+
List all submissions
|
2057
|
+
|
2058
|
+
### Examples
|
1140
2059
|
|
1141
|
-
### Example
|
1142
2060
|
```ruby
|
1143
|
-
|
2061
|
+
require 'time'
|
1144
2062
|
require 'docspring'
|
1145
2063
|
# setup authorization
|
1146
2064
|
DocSpring.configure do |config|
|
@@ -1150,26 +2068,56 @@ DocSpring.configure do |config|
|
|
1150
2068
|
end
|
1151
2069
|
|
1152
2070
|
api_instance = DocSpring::PDFApi.new
|
1153
|
-
|
2071
|
+
opts = {
|
2072
|
+
cursor: 'sub_list_000012', # String |
|
2073
|
+
limit: 3, # Float |
|
2074
|
+
created_after: '2019-01-01T09:00:00-05:00', # String |
|
2075
|
+
created_before: '2020-01-01T09:00:00.000+0200', # String |
|
2076
|
+
type: 'test', # String |
|
2077
|
+
include_data: true # Boolean |
|
2078
|
+
}
|
1154
2079
|
|
1155
2080
|
begin
|
1156
|
-
#
|
1157
|
-
result = api_instance.
|
2081
|
+
# List all submissions
|
2082
|
+
result = api_instance.list_submissions(opts)
|
1158
2083
|
p result
|
1159
2084
|
rescue DocSpring::ApiError => e
|
1160
|
-
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}"
|
1161
2104
|
end
|
1162
2105
|
```
|
1163
2106
|
|
1164
2107
|
### Parameters
|
1165
2108
|
|
1166
|
-
Name | Type | Description
|
1167
|
-
|
1168
|
-
**
|
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] |
|
1169
2117
|
|
1170
2118
|
### Return type
|
1171
2119
|
|
1172
|
-
**
|
2120
|
+
[**ListSubmissionsResponse**](ListSubmissionsResponse.md)
|
1173
2121
|
|
1174
2122
|
### Authorization
|
1175
2123
|
|
@@ -1177,19 +2125,20 @@ Name | Type | Description | Notes
|
|
1177
2125
|
|
1178
2126
|
### HTTP request headers
|
1179
2127
|
|
1180
|
-
|
1181
|
-
|
2128
|
+
- **Content-Type**: Not defined
|
2129
|
+
- **Accept**: application/json
|
1182
2130
|
|
1183
2131
|
|
2132
|
+
## list_template_submissions
|
1184
2133
|
|
1185
|
-
|
1186
|
-
> Array<Folder> list_folders(opts)
|
2134
|
+
> <ListSubmissionsResponse> list_template_submissions(template_id, opts)
|
1187
2135
|
|
1188
|
-
|
2136
|
+
List all submissions for a given template
|
2137
|
+
|
2138
|
+
### Examples
|
1189
2139
|
|
1190
|
-
### Example
|
1191
2140
|
```ruby
|
1192
|
-
|
2141
|
+
require 'time'
|
1193
2142
|
require 'docspring'
|
1194
2143
|
# setup authorization
|
1195
2144
|
DocSpring.configure do |config|
|
@@ -1199,28 +2148,58 @@ DocSpring.configure do |config|
|
|
1199
2148
|
end
|
1200
2149
|
|
1201
2150
|
api_instance = DocSpring::PDFApi.new
|
2151
|
+
template_id = 'tpl_000000000000000002' # String |
|
1202
2152
|
opts = {
|
1203
|
-
|
2153
|
+
cursor: 'cursor_example', # String |
|
2154
|
+
limit: 8.14, # Float |
|
2155
|
+
created_after: 'created_after_example', # String |
|
2156
|
+
created_before: 'created_before_example', # String |
|
2157
|
+
type: 'type_example', # String |
|
2158
|
+
include_data: true # Boolean |
|
1204
2159
|
}
|
1205
2160
|
|
1206
2161
|
begin
|
1207
|
-
#
|
1208
|
-
result = api_instance.
|
2162
|
+
# List all submissions for a given template
|
2163
|
+
result = api_instance.list_template_submissions(template_id, opts)
|
1209
2164
|
p result
|
1210
2165
|
rescue DocSpring::ApiError => e
|
1211
|
-
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}"
|
1212
2185
|
end
|
1213
2186
|
```
|
1214
2187
|
|
1215
2188
|
### Parameters
|
1216
2189
|
|
1217
|
-
Name | Type | Description
|
1218
|
-
|
1219
|
-
**
|
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] |
|
1220
2199
|
|
1221
2200
|
### Return type
|
1222
2201
|
|
1223
|
-
[**
|
2202
|
+
[**ListSubmissionsResponse**](ListSubmissionsResponse.md)
|
1224
2203
|
|
1225
2204
|
### Authorization
|
1226
2205
|
|
@@ -1228,19 +2207,20 @@ Name | Type | Description | Notes
|
|
1228
2207
|
|
1229
2208
|
### HTTP request headers
|
1230
2209
|
|
1231
|
-
|
1232
|
-
|
2210
|
+
- **Content-Type**: Not defined
|
2211
|
+
- **Accept**: application/json
|
1233
2212
|
|
1234
2213
|
|
2214
|
+
## list_templates
|
1235
2215
|
|
1236
|
-
|
1237
|
-
> Array<Template> list_templates(opts)
|
2216
|
+
> <Array<Template>> list_templates(opts)
|
1238
2217
|
|
1239
2218
|
Get a list of all templates
|
1240
2219
|
|
1241
|
-
###
|
2220
|
+
### Examples
|
2221
|
+
|
1242
2222
|
```ruby
|
1243
|
-
|
2223
|
+
require 'time'
|
1244
2224
|
require 'docspring'
|
1245
2225
|
# setup authorization
|
1246
2226
|
DocSpring.configure do |config|
|
@@ -1258,22 +2238,40 @@ opts = {
|
|
1258
2238
|
}
|
1259
2239
|
|
1260
2240
|
begin
|
1261
|
-
#Get a list of all templates
|
2241
|
+
# Get a list of all templates
|
1262
2242
|
result = api_instance.list_templates(opts)
|
1263
2243
|
p result
|
1264
2244
|
rescue DocSpring::ApiError => e
|
1265
|
-
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}"
|
1266
2264
|
end
|
1267
2265
|
```
|
1268
2266
|
|
1269
2267
|
### Parameters
|
1270
2268
|
|
1271
|
-
Name | Type | Description
|
1272
|
-
|
1273
|
-
**query** | **String
|
1274
|
-
**parent_folder_id** | **String
|
1275
|
-
**page** | **Integer
|
1276
|
-
**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] |
|
1277
2275
|
|
1278
2276
|
### Return type
|
1279
2277
|
|
@@ -1285,19 +2283,20 @@ Name | Type | Description | Notes
|
|
1285
2283
|
|
1286
2284
|
### HTTP request headers
|
1287
2285
|
|
1288
|
-
|
1289
|
-
|
2286
|
+
- **Content-Type**: Not defined
|
2287
|
+
- **Accept**: application/json
|
1290
2288
|
|
1291
2289
|
|
2290
|
+
## move_folder_to_folder
|
1292
2291
|
|
1293
|
-
|
1294
|
-
> Folder move_folder_to_folder(folder_id, move_folder_data)
|
2292
|
+
> <Folder> move_folder_to_folder(folder_id, data)
|
1295
2293
|
|
1296
2294
|
Move a folder
|
1297
2295
|
|
1298
|
-
###
|
2296
|
+
### Examples
|
2297
|
+
|
1299
2298
|
```ruby
|
1300
|
-
|
2299
|
+
require 'time'
|
1301
2300
|
require 'docspring'
|
1302
2301
|
# setup authorization
|
1303
2302
|
DocSpring.configure do |config|
|
@@ -1307,24 +2306,42 @@ DocSpring.configure do |config|
|
|
1307
2306
|
end
|
1308
2307
|
|
1309
2308
|
api_instance = DocSpring::PDFApi.new
|
1310
|
-
folder_id = '
|
1311
|
-
|
2309
|
+
folder_id = 'fld_0000000000000000001' # String |
|
2310
|
+
data = DocSpring::MoveFolderData.new # MoveFolderData |
|
1312
2311
|
|
1313
2312
|
begin
|
1314
|
-
#Move a folder
|
1315
|
-
result = api_instance.move_folder_to_folder(folder_id,
|
2313
|
+
# Move a folder
|
2314
|
+
result = api_instance.move_folder_to_folder(folder_id, data)
|
1316
2315
|
p result
|
1317
2316
|
rescue DocSpring::ApiError => e
|
1318
|
-
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}"
|
1319
2336
|
end
|
1320
2337
|
```
|
1321
2338
|
|
1322
2339
|
### Parameters
|
1323
2340
|
|
1324
|
-
Name | Type | Description
|
1325
|
-
|
1326
|
-
**folder_id** | **String
|
1327
|
-
**
|
2341
|
+
| Name | Type | Description | Notes |
|
2342
|
+
| ---- | ---- | ----------- | ----- |
|
2343
|
+
| **folder_id** | **String** | | |
|
2344
|
+
| **data** | [**MoveFolderData**](MoveFolderData.md) | | |
|
1328
2345
|
|
1329
2346
|
### Return type
|
1330
2347
|
|
@@ -1336,19 +2353,20 @@ Name | Type | Description | Notes
|
|
1336
2353
|
|
1337
2354
|
### HTTP request headers
|
1338
2355
|
|
1339
|
-
|
1340
|
-
|
2356
|
+
- **Content-Type**: application/json
|
2357
|
+
- **Accept**: application/json
|
1341
2358
|
|
1342
2359
|
|
2360
|
+
## move_template_to_folder
|
1343
2361
|
|
1344
|
-
|
1345
|
-
> Template move_template_to_folder(template_id, move_template_data)
|
2362
|
+
> <Template> move_template_to_folder(template_id, data)
|
1346
2363
|
|
1347
2364
|
Move Template to folder
|
1348
2365
|
|
1349
|
-
###
|
2366
|
+
### Examples
|
2367
|
+
|
1350
2368
|
```ruby
|
1351
|
-
|
2369
|
+
require 'time'
|
1352
2370
|
require 'docspring'
|
1353
2371
|
# setup authorization
|
1354
2372
|
DocSpring.configure do |config|
|
@@ -1359,23 +2377,41 @@ end
|
|
1359
2377
|
|
1360
2378
|
api_instance = DocSpring::PDFApi.new
|
1361
2379
|
template_id = 'tpl_000000000000000001' # String |
|
1362
|
-
|
2380
|
+
data = DocSpring::MoveTemplateData.new({parent_folder_id: 'parent_folder_id_example'}) # MoveTemplateData |
|
1363
2381
|
|
1364
2382
|
begin
|
1365
|
-
#Move Template to folder
|
1366
|
-
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)
|
1367
2385
|
p result
|
1368
2386
|
rescue DocSpring::ApiError => e
|
1369
|
-
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}"
|
1370
2406
|
end
|
1371
2407
|
```
|
1372
2408
|
|
1373
2409
|
### Parameters
|
1374
2410
|
|
1375
|
-
Name | Type | Description
|
1376
|
-
|
1377
|
-
**template_id** | **String
|
1378
|
-
**
|
2411
|
+
| Name | Type | Description | Notes |
|
2412
|
+
| ---- | ---- | ----------- | ----- |
|
2413
|
+
| **template_id** | **String** | | |
|
2414
|
+
| **data** | [**MoveTemplateData**](MoveTemplateData.md) | | |
|
1379
2415
|
|
1380
2416
|
### Return type
|
1381
2417
|
|
@@ -1387,19 +2423,90 @@ Name | Type | Description | Notes
|
|
1387
2423
|
|
1388
2424
|
### HTTP request headers
|
1389
2425
|
|
1390
|
-
|
1391
|
-
|
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
|
1392
2498
|
|
1393
2499
|
|
2500
|
+
## rename_folder
|
1394
2501
|
|
1395
|
-
|
1396
|
-
> rename_folder(folder_id, rename_folder_data)
|
2502
|
+
> rename_folder(folder_id, data)
|
1397
2503
|
|
1398
2504
|
Rename a folder
|
1399
2505
|
|
1400
|
-
###
|
2506
|
+
### Examples
|
2507
|
+
|
1401
2508
|
```ruby
|
1402
|
-
|
2509
|
+
require 'time'
|
1403
2510
|
require 'docspring'
|
1404
2511
|
# setup authorization
|
1405
2512
|
DocSpring.configure do |config|
|
@@ -1409,23 +2516,41 @@ DocSpring.configure do |config|
|
|
1409
2516
|
end
|
1410
2517
|
|
1411
2518
|
api_instance = DocSpring::PDFApi.new
|
1412
|
-
folder_id = '
|
1413
|
-
|
2519
|
+
folder_id = 'fld_0000000000000000001' # String |
|
2520
|
+
data = DocSpring::RenameFolderData.new({name: 'name_example'}) # RenameFolderData |
|
2521
|
+
|
2522
|
+
begin
|
2523
|
+
# Rename a folder
|
2524
|
+
api_instance.rename_folder(folder_id, data)
|
2525
|
+
rescue DocSpring::ApiError => e
|
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.
|
1414
2533
|
|
2534
|
+
> <Array(nil, Integer, Hash)> rename_folder_with_http_info(folder_id, data)
|
2535
|
+
|
2536
|
+
```ruby
|
1415
2537
|
begin
|
1416
|
-
#Rename a folder
|
1417
|
-
api_instance.
|
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
|
1418
2543
|
rescue DocSpring::ApiError => e
|
1419
|
-
puts "
|
2544
|
+
puts "Error when calling PDFApi->rename_folder_with_http_info: #{e}"
|
1420
2545
|
end
|
1421
2546
|
```
|
1422
2547
|
|
1423
2548
|
### Parameters
|
1424
2549
|
|
1425
|
-
Name | Type | Description
|
1426
|
-
|
1427
|
-
**folder_id** | **String
|
1428
|
-
**
|
2550
|
+
| Name | Type | Description | Notes |
|
2551
|
+
| ---- | ---- | ----------- | ----- |
|
2552
|
+
| **folder_id** | **String** | | |
|
2553
|
+
| **data** | [**RenameFolderData**](RenameFolderData.md) | | |
|
1429
2554
|
|
1430
2555
|
### Return type
|
1431
2556
|
|
@@ -1437,19 +2562,90 @@ nil (empty response body)
|
|
1437
2562
|
|
1438
2563
|
### HTTP request headers
|
1439
2564
|
|
1440
|
-
|
1441
|
-
|
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
|
1442
2637
|
|
1443
2638
|
|
2639
|
+
## test_authentication
|
1444
2640
|
|
1445
|
-
|
1446
|
-
> AuthenticationSuccessResponse test_authentication
|
2641
|
+
> <AuthenticationSuccessResponse> test_authentication
|
1447
2642
|
|
1448
2643
|
Test Authentication
|
1449
2644
|
|
1450
|
-
###
|
2645
|
+
### Examples
|
2646
|
+
|
1451
2647
|
```ruby
|
1452
|
-
|
2648
|
+
require 'time'
|
1453
2649
|
require 'docspring'
|
1454
2650
|
# setup authorization
|
1455
2651
|
DocSpring.configure do |config|
|
@@ -1461,15 +2657,34 @@ end
|
|
1461
2657
|
api_instance = DocSpring::PDFApi.new
|
1462
2658
|
|
1463
2659
|
begin
|
1464
|
-
#Test Authentication
|
2660
|
+
# Test Authentication
|
1465
2661
|
result = api_instance.test_authentication
|
1466
2662
|
p result
|
1467
2663
|
rescue DocSpring::ApiError => e
|
1468
|
-
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}"
|
1469
2683
|
end
|
1470
2684
|
```
|
1471
2685
|
|
1472
2686
|
### Parameters
|
2687
|
+
|
1473
2688
|
This endpoint does not need any parameter.
|
1474
2689
|
|
1475
2690
|
### Return type
|
@@ -1482,19 +2697,20 @@ This endpoint does not need any parameter.
|
|
1482
2697
|
|
1483
2698
|
### HTTP request headers
|
1484
2699
|
|
1485
|
-
|
1486
|
-
|
2700
|
+
- **Content-Type**: Not defined
|
2701
|
+
- **Accept**: application/json
|
1487
2702
|
|
1488
2703
|
|
2704
|
+
## update_data_request
|
1489
2705
|
|
1490
|
-
|
1491
|
-
> UpdateDataRequestResponse update_data_request(data_request_id, update_submission_data_request_data)
|
2706
|
+
> <UpdateDataRequestResponse> update_data_request(data_request_id, data)
|
1492
2707
|
|
1493
2708
|
Update a submission data request
|
1494
2709
|
|
1495
|
-
###
|
2710
|
+
### Examples
|
2711
|
+
|
1496
2712
|
```ruby
|
1497
|
-
|
2713
|
+
require 'time'
|
1498
2714
|
require 'docspring'
|
1499
2715
|
# setup authorization
|
1500
2716
|
DocSpring.configure do |config|
|
@@ -1505,23 +2721,41 @@ end
|
|
1505
2721
|
|
1506
2722
|
api_instance = DocSpring::PDFApi.new
|
1507
2723
|
data_request_id = 'drq_000000000000000001' # String |
|
1508
|
-
|
2724
|
+
data = DocSpring::UpdateSubmissionDataRequestData.new # UpdateSubmissionDataRequestData |
|
1509
2725
|
|
1510
2726
|
begin
|
1511
|
-
#Update a submission data request
|
1512
|
-
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)
|
1513
2729
|
p result
|
1514
2730
|
rescue DocSpring::ApiError => e
|
1515
|
-
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}"
|
1516
2750
|
end
|
1517
2751
|
```
|
1518
2752
|
|
1519
2753
|
### Parameters
|
1520
2754
|
|
1521
|
-
Name | Type | Description
|
1522
|
-
|
1523
|
-
**data_request_id** | **String
|
1524
|
-
**
|
2755
|
+
| Name | Type | Description | Notes |
|
2756
|
+
| ---- | ---- | ----------- | ----- |
|
2757
|
+
| **data_request_id** | **String** | | |
|
2758
|
+
| **data** | [**UpdateSubmissionDataRequestData**](UpdateSubmissionDataRequestData.md) | | |
|
1525
2759
|
|
1526
2760
|
### Return type
|
1527
2761
|
|
@@ -1533,19 +2767,20 @@ Name | Type | Description | Notes
|
|
1533
2767
|
|
1534
2768
|
### HTTP request headers
|
1535
2769
|
|
1536
|
-
|
1537
|
-
|
2770
|
+
- **Content-Type**: application/json
|
2771
|
+
- **Accept**: application/json
|
1538
2772
|
|
1539
2773
|
|
2774
|
+
## update_template
|
1540
2775
|
|
1541
|
-
|
1542
|
-
> UpdateTemplateResponse update_template(template_id, update_template_data)
|
2776
|
+
> <UpdateTemplateResponse> update_template(template_id, data)
|
1543
2777
|
|
1544
2778
|
Update a Template
|
1545
2779
|
|
1546
|
-
###
|
2780
|
+
### Examples
|
2781
|
+
|
1547
2782
|
```ruby
|
1548
|
-
|
2783
|
+
require 'time'
|
1549
2784
|
require 'docspring'
|
1550
2785
|
# setup authorization
|
1551
2786
|
DocSpring.configure do |config|
|
@@ -1556,23 +2791,41 @@ end
|
|
1556
2791
|
|
1557
2792
|
api_instance = DocSpring::PDFApi.new
|
1558
2793
|
template_id = 'tpl_000000000000000003' # String |
|
1559
|
-
|
2794
|
+
data = DocSpring::UpdateTemplateData.new({template: DocSpring::TemplateData.new}) # UpdateTemplateData |
|
1560
2795
|
|
1561
2796
|
begin
|
1562
|
-
#Update a Template
|
1563
|
-
result = api_instance.update_template(template_id,
|
2797
|
+
# Update a Template
|
2798
|
+
result = api_instance.update_template(template_id, data)
|
1564
2799
|
p result
|
1565
2800
|
rescue DocSpring::ApiError => e
|
1566
|
-
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}"
|
1567
2820
|
end
|
1568
2821
|
```
|
1569
2822
|
|
1570
2823
|
### Parameters
|
1571
2824
|
|
1572
|
-
Name | Type | Description
|
1573
|
-
|
1574
|
-
**template_id** | **String
|
1575
|
-
**
|
2825
|
+
| Name | Type | Description | Notes |
|
2826
|
+
| ---- | ---- | ----------- | ----- |
|
2827
|
+
| **template_id** | **String** | | |
|
2828
|
+
| **data** | [**UpdateTemplateData**](UpdateTemplateData.md) | | |
|
1576
2829
|
|
1577
2830
|
### Return type
|
1578
2831
|
|
@@ -1584,8 +2837,6 @@ Name | Type | Description | Notes
|
|
1584
2837
|
|
1585
2838
|
### HTTP request headers
|
1586
2839
|
|
1587
|
-
|
1588
|
-
|
1589
|
-
|
1590
|
-
|
2840
|
+
- **Content-Type**: application/json
|
2841
|
+
- **Accept**: application/json
|
1591
2842
|
|