docspring 1.4.1 → 2.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/.gitlab-ci.yml +26 -0
- data/.openapi-generator/FILES +220 -0
- data/.openapi-generator/VERSION +1 -1
- data/.rubocop.yml +6 -12
- data/.travis.yml +11 -0
- data/CHANGELOG.md +5 -0
- data/Gemfile +5 -1
- data/Gemfile.lock +85 -48
- data/README.md +43 -18
- data/docs/AddFieldsData.md +13 -3
- data/docs/AddFieldsTemplateResponse.md +17 -5
- data/docs/AuthenticationError.md +15 -4
- data/docs/AuthenticationSuccessResponse.md +13 -3
- data/docs/CombinePdfsData.md +23 -8
- data/docs/CombinedSubmission.md +37 -13
- data/docs/CombinedSubmissionAction.md +23 -8
- data/docs/CombinedSubmissionData.md +21 -7
- data/docs/CopyTemplateData.md +15 -4
- data/docs/CreateCombinedSubmissionResponse.md +17 -5
- data/docs/CreateCustomFileData.md +13 -3
- data/docs/CreateCustomFileResponse.md +17 -5
- data/docs/CreateFolderAttributes.md +20 -0
- data/docs/CreateFolderData.md +13 -3
- data/docs/CreateHtmlTemplateData.md +13 -3
- data/docs/CreateSubmissionBatchResponse.md +21 -7
- data/docs/CreateSubmissionBatchSubmissionsResponse.md +17 -5
- data/docs/CreateSubmissionData.md +36 -0
- data/docs/CreateSubmissionDataRequestData.md +37 -15
- data/docs/CreateSubmissionDataRequestEventRequest.md +24 -0
- data/docs/CreateSubmissionDataRequestEventResponse.md +22 -0
- data/docs/CreateSubmissionDataRequestTokenResponse.md +17 -5
- data/docs/CreateSubmissionResponse.md +17 -5
- data/docs/CreateTemplateFromUploadData.md +13 -3
- data/docs/DataRequestToken.md +24 -0
- data/docs/DeleteTemplateResponse.md +20 -0
- data/docs/ErrorResponse.md +20 -0
- data/docs/Folder.md +19 -6
- data/docs/FullTemplate.md +94 -0
- data/docs/HtmlTemplateData.md +51 -19
- data/docs/HtmlTemplateDataWebhookOptions.md +18 -0
- data/docs/InvalidRequest.md +15 -4
- data/docs/InvalidRequestSingleError.md +20 -0
- data/docs/ListSubmissionsResponse.md +17 -5
- data/docs/MoveFolderData.md +13 -3
- data/docs/MoveTemplateData.md +13 -3
- data/docs/PDFApi.md +1598 -523
- data/docs/PendingTemplate.md +45 -19
- data/docs/PreviewPdfResponse.md +20 -0
- data/docs/PublishTemplateVersion404Response.md +20 -0
- data/docs/PublishTemplateVersion422Response.md +20 -0
- data/docs/PublishTemplateVersionResponse.md +20 -0
- data/docs/PublishTemplateVersionResponseResult.md +24 -0
- data/docs/PublishVersionData.md +20 -0
- data/docs/RenameFolderData.md +13 -3
- data/docs/RestoreTemplateVersionResponse.md +18 -0
- data/docs/RestoreVersionData.md +18 -0
- data/docs/Submission.md +49 -21
- data/docs/SubmissionAction.md +23 -8
- data/docs/SubmissionBatch.md +29 -11
- data/docs/SubmissionBatchData.md +21 -6
- data/docs/SubmissionData.md +23 -10
- data/docs/SubmissionDataBatchRequest.md +25 -8
- data/docs/SubmissionDataRequest.md +53 -22
- data/docs/SubmissionDataRequestEvent.md +30 -0
- data/docs/Template.md +51 -22
- data/docs/TemplateData.md +49 -18
- data/docs/TemplateDefaults.md +22 -0
- data/docs/TemplateDocument.md +22 -0
- data/docs/TemplateDocumentMetadata.md +22 -0
- data/docs/TemplateSchema.md +34 -0
- data/docs/UpdateDataRequestResponse.md +17 -5
- data/docs/UpdateSubmissionDataRequestData.md +37 -15
- data/docs/UpdateTemplateData.md +13 -3
- data/docs/UpdateTemplateResponse.md +15 -4
- data/docs/UploadPresign.md +24 -0
- data/docs/UploadTemplateData.md +53 -20
- data/docspring.gemspec +14 -11
- data/git_push.sh +11 -9
- data/lib/docspring/api/pdf_api.rb +1344 -539
- data/lib/docspring/api_client.rb +106 -98
- data/lib/docspring/api_error.rb +22 -2
- data/lib/docspring/configuration.rb +127 -16
- data/lib/docspring/models/add_fields_data.rb +59 -26
- data/lib/docspring/models/add_fields_template_response.rb +81 -43
- data/lib/docspring/models/authentication_error.rb +62 -29
- data/lib/docspring/models/authentication_success_response.rb +66 -28
- data/lib/docspring/models/combine_pdfs_data.rb +65 -32
- data/lib/docspring/models/combined_submission.rb +165 -75
- data/lib/docspring/models/combined_submission_action.rb +83 -39
- data/lib/docspring/models/combined_submission_data.rb +63 -30
- data/lib/docspring/models/copy_template_data.rb +59 -26
- data/lib/docspring/models/create_combined_submission_response.rb +86 -41
- data/lib/docspring/models/create_custom_file_data.rb +58 -25
- data/lib/docspring/models/create_custom_file_response.rb +86 -41
- data/lib/docspring/models/create_folder_attributes.rb +230 -0
- data/lib/docspring/models/create_folder_data.rb +59 -26
- data/lib/docspring/models/create_html_template_data.rb +58 -25
- data/lib/docspring/models/create_submission_batch_response.rb +104 -52
- data/lib/docspring/models/create_submission_batch_submissions_response.rb +79 -41
- data/lib/docspring/models/create_submission_data.rb +304 -0
- data/lib/docspring/models/create_submission_data_request_data.rb +139 -90
- data/lib/docspring/models/create_submission_data_request_event_request.rb +297 -0
- data/lib/docspring/models/create_submission_data_request_event_response.rb +282 -0
- data/lib/docspring/models/create_submission_data_request_token_response.rb +85 -40
- data/lib/docspring/models/create_submission_response.rb +86 -41
- data/lib/docspring/models/create_template_from_upload_data.rb +58 -25
- data/lib/docspring/models/{custom_file.rb → data_request_token.rb} +110 -33
- data/lib/docspring/models/delete_template_response.rb +266 -0
- data/lib/docspring/models/{error.rb → error_response.rb} +65 -30
- data/lib/docspring/models/folder.rb +78 -46
- data/lib/docspring/models/{template1.rb → full_template.rb} +476 -240
- data/lib/docspring/models/html_template_data.rb +180 -110
- data/lib/docspring/models/{folders_folder.rb → html_template_data_webhook_options.rb} +63 -41
- data/lib/docspring/models/invalid_request.rb +64 -29
- data/lib/docspring/models/invalid_request_single_error.rb +271 -0
- data/lib/docspring/models/list_submissions_response.rb +87 -39
- data/lib/docspring/models/move_folder_data.rb +56 -25
- data/lib/docspring/models/move_template_data.rb +58 -25
- data/lib/docspring/models/pending_template.rb +221 -118
- data/lib/docspring/models/preview_pdf_response.rb +264 -0
- data/lib/docspring/models/publish_template_version404_response.rb +271 -0
- data/lib/docspring/models/publish_template_version422_response.rb +273 -0
- data/lib/docspring/models/publish_template_version_response.rb +271 -0
- data/lib/docspring/models/publish_template_version_response_result.rb +263 -0
- data/lib/docspring/models/publish_version_data.rb +230 -0
- data/lib/docspring/models/rename_folder_data.rb +58 -25
- data/lib/docspring/models/restore_template_version_response.rb +255 -0
- data/lib/docspring/models/{create_submission_data_request_token_response_token.rb → restore_version_data.rb} +69 -58
- data/lib/docspring/models/submission.rb +98 -49
- data/lib/docspring/models/submission_action.rb +83 -39
- data/lib/docspring/models/submission_batch.rb +158 -75
- data/lib/docspring/models/submission_batch_data.rb +74 -30
- data/lib/docspring/models/submission_data.rb +65 -50
- data/lib/docspring/models/submission_data_batch_request.rb +100 -49
- data/lib/docspring/models/submission_data_request.rb +123 -54
- data/lib/docspring/models/submission_data_request_event.rb +309 -0
- data/lib/docspring/models/template.rb +267 -132
- data/lib/docspring/models/template_data.rb +173 -105
- data/lib/docspring/models/{template1_defaults.rb → template_defaults.rb} +77 -29
- data/lib/docspring/models/{upload_template_data_document.rb → template_document.rb} +91 -39
- data/lib/docspring/models/{upload_template_data_document_metadata.rb → template_document_metadata.rb} +94 -42
- data/lib/docspring/models/template_schema.rb +288 -0
- data/lib/docspring/models/update_data_request_response.rb +86 -41
- data/lib/docspring/models/update_submission_data_request_data.rb +82 -43
- data/lib/docspring/models/update_template_data.rb +58 -25
- data/lib/docspring/models/update_template_response.rb +79 -41
- data/lib/docspring/models/upload_presign.rb +296 -0
- data/lib/docspring/models/upload_template_data.rb +186 -116
- data/lib/docspring/version.rb +3 -3
- data/lib/docspring.rb +29 -12
- data/spec/api/client_integration_spec.rb +26 -19
- data/spec/api/pdf_api_integration_spec.rb +21 -19
- data/spec/api/pdf_api_spec_original.skipped.rb +427 -118
- data/spec/models/add_fields_data_spec.rb +8 -13
- data/spec/models/add_fields_template_response_spec.rb +16 -21
- data/spec/models/authentication_error_spec.rb +10 -15
- data/spec/models/authentication_success_response_spec.rb +9 -14
- data/spec/models/combine_pdfs_data_spec.rb +13 -18
- data/spec/models/combined_submission_action_spec.rb +16 -21
- data/spec/models/combined_submission_data_spec.rb +12 -17
- data/spec/models/combined_submission_spec.rb +42 -35
- data/spec/models/copy_template_data_spec.rb +9 -14
- data/spec/models/create_combined_submission_response_spec.rb +16 -21
- data/spec/models/create_custom_file_data_spec.rb +8 -13
- data/spec/models/create_custom_file_response_spec.rb +16 -21
- data/spec/models/create_folder_attributes_spec.rb +42 -0
- data/spec/models/create_folder_data_spec.rb +8 -13
- data/spec/models/create_html_template_data_spec.rb +8 -13
- data/spec/models/create_submission_batch_response_spec.rb +21 -26
- data/spec/models/create_submission_batch_submissions_response_spec.rb +16 -21
- data/spec/models/create_submission_data_request_data_spec.rb +33 -38
- data/spec/models/create_submission_data_request_event_request_spec.rb +62 -0
- data/spec/models/create_submission_data_request_event_response_spec.rb +52 -0
- data/spec/models/create_submission_data_request_token_response_spec.rb +15 -20
- data/spec/models/create_submission_data_spec.rb +90 -0
- data/spec/models/create_submission_response_spec.rb +16 -21
- data/spec/models/create_template_from_upload_data_spec.rb +8 -13
- data/spec/models/data_request_token_spec.rb +54 -0
- data/spec/models/delete_template_response_spec.rb +46 -0
- data/spec/models/error_response_spec.rb +46 -0
- data/spec/models/folder_spec.rb +15 -20
- data/spec/models/full_template_spec.rb +268 -0
- data/spec/models/html_template_data_spec.rb +62 -49
- data/spec/models/html_template_data_webhook_options_spec.rb +36 -0
- data/spec/models/invalid_request_single_error_spec.rb +46 -0
- data/spec/models/invalid_request_spec.rb +10 -15
- data/spec/models/list_submissions_response_spec.rb +13 -18
- data/spec/models/move_folder_data_spec.rb +8 -13
- data/spec/models/move_template_data_spec.rb +8 -13
- data/spec/models/pending_template_spec.rb +45 -50
- data/spec/models/preview_pdf_response_spec.rb +46 -0
- data/spec/models/publish_template_version404_response_spec.rb +46 -0
- data/spec/models/publish_template_version422_response_spec.rb +46 -0
- data/spec/models/publish_template_version_response_result_spec.rb +54 -0
- data/spec/models/publish_template_version_response_spec.rb +46 -0
- data/spec/models/publish_version_data_spec.rb +42 -0
- data/spec/models/rename_folder_data_spec.rb +8 -13
- data/spec/models/restore_template_version_response_spec.rb +40 -0
- data/spec/models/restore_version_data_spec.rb +36 -0
- data/spec/models/submission_action_spec.rb +16 -21
- data/spec/models/submission_batch_data_spec.rb +17 -16
- data/spec/models/submission_batch_spec.rb +29 -34
- data/spec/models/submission_data_batch_request_spec.rb +24 -23
- data/spec/models/submission_data_request_event_spec.rb +72 -0
- data/spec/models/submission_data_request_spec.rb +36 -35
- data/spec/models/submission_data_spec.rb +13 -30
- data/spec/models/submission_spec.rb +27 -32
- data/spec/models/template_data_spec.rb +59 -46
- data/spec/models/template_defaults_spec.rb +48 -0
- data/spec/models/template_document_metadata_spec.rb +52 -0
- data/spec/models/template_document_spec.rb +52 -0
- data/spec/models/template_schema_spec.rb +84 -0
- data/spec/models/template_spec.rb +50 -55
- data/spec/models/update_data_request_response_spec.rb +16 -21
- data/spec/models/update_submission_data_request_data_spec.rb +22 -27
- data/spec/models/update_template_data_spec.rb +8 -13
- data/spec/models/update_template_response_spec.rb +14 -19
- data/spec/models/upload_presign_spec.rb +58 -0
- data/spec/models/upload_template_data_spec.rb +64 -51
- data/spec/spec_helper.rb +5 -5
- metadata +108 -132
- data/docs/CreateSubmissionDataRequestTokenResponseToken.md +0 -11
- data/docs/CustomFile.md +0 -9
- data/docs/Error.md +0 -9
- data/docs/FoldersFolder.md +0 -9
- data/docs/Template1.md +0 -46
- data/docs/Template1Defaults.md +0 -10
- data/docs/TemplatestemplateIdaddFieldsFields.md +0 -92
- data/docs/UploadTemplateDataDocument.md +0 -10
- data/docs/UploadTemplateDataDocumentMetadata.md +0 -10
- data/lib/docspring/models/templatestemplate_idadd_fields_fields.rb +0 -1306
- data/spec/api_client_spec.rb +0 -226
- data/spec/configuration_spec.rb +0 -53
- data/spec/models/create_submission_data_request_token_response_token_spec.rb +0 -59
- data/spec/models/custom_file_spec.rb +0 -47
- data/spec/models/error_spec.rb +0 -51
- data/spec/models/folders_folder_spec.rb +0 -47
- data/spec/models/template1_defaults_spec.rb +0 -53
- data/spec/models/template1_spec.rb +0 -273
- data/spec/models/templatestemplate_idadd_fields_fields_spec.rb +0 -589
- data/spec/models/upload_template_data_document_metadata_spec.rb +0 -57
- data/spec/models/upload_template_data_document_spec.rb +0 -57
|
@@ -3,10 +3,10 @@
|
|
|
3
3
|
|
|
4
4
|
#DocSpring is a service that helps you fill out and sign PDF templates.
|
|
5
5
|
|
|
6
|
-
OpenAPI
|
|
6
|
+
The version of the OpenAPI document: v1
|
|
7
7
|
|
|
8
8
|
Generated by: https://openapi-generator.tech
|
|
9
|
-
|
|
9
|
+
Generator version: 7.11.0
|
|
10
10
|
|
|
11
11
|
=end
|
|
12
12
|
|
|
@@ -18,15 +18,19 @@ require 'json'
|
|
|
18
18
|
# Please update as you see appropriate
|
|
19
19
|
describe 'PDFApi' do
|
|
20
20
|
before do
|
|
21
|
+
# <--------------- BEGIN DOCSPRING CUSTOMIZATION ----------------->
|
|
22
|
+
# Description: Configure auth and host for testing,
|
|
23
|
+
# replace @api_instance with let(:api_instance)
|
|
21
24
|
DocSpring.configure do |c|
|
|
22
25
|
c.username = 'api_token123'
|
|
23
26
|
c.password = 'testsecret123'
|
|
24
|
-
c.host = 'api.docspring.
|
|
27
|
+
c.host = 'api.docspring.localhost:31337'
|
|
25
28
|
c.scheme = 'http'
|
|
26
29
|
end
|
|
27
30
|
end
|
|
28
31
|
|
|
29
32
|
let(:api_instance) { DocSpring::PDFApi.new }
|
|
33
|
+
# <--------------- END DOCSPRING CUSTOMIZATION ----------------->
|
|
30
34
|
|
|
31
35
|
after do
|
|
32
36
|
# run after each test
|
|
@@ -34,100 +38,163 @@ describe 'PDFApi' do
|
|
|
34
38
|
|
|
35
39
|
describe 'test an instance of PDFApi' do
|
|
36
40
|
it 'should create an instance of PDFApi' do
|
|
41
|
+
# <--------------- BEGIN DOCSPRING CUSTOMIZATION ----------------->
|
|
42
|
+
# Description: Replace @api_instance with api_instance
|
|
37
43
|
expect(api_instance).to be_instance_of(DocSpring::PDFApi)
|
|
44
|
+
# <--------------- END DOCSPRING CUSTOMIZATION ----------------->
|
|
38
45
|
end
|
|
39
46
|
end
|
|
40
47
|
|
|
48
|
+
# <--------------- BEGIN DOCSPRING CUSTOMIZATION ----------------->
|
|
49
|
+
# Description: Replace empty test with e2e integration test
|
|
41
50
|
# integration tests for add_fields_to_template
|
|
42
51
|
# Add new fields to a Template
|
|
43
52
|
# @param template_id
|
|
44
|
-
# @param
|
|
53
|
+
# @param data
|
|
45
54
|
# @param [Hash] opts the optional parameters
|
|
46
55
|
# @return [AddFieldsTemplateResponse]
|
|
47
56
|
describe 'add_fields_to_template test' do
|
|
48
57
|
it 'should work' do
|
|
49
|
-
template_id =
|
|
50
|
-
|
|
51
|
-
result = api_instance.
|
|
58
|
+
template_id = tpl_000000000000000002 # String |
|
|
59
|
+
data = # AddFieldsData |
|
|
60
|
+
result = api_instance.
|
|
61
|
+
add_fields_to_template(
|
|
62
|
+
template_id,
|
|
63
|
+
data
|
|
64
|
+
)
|
|
52
65
|
expect(result).to_not be_nil
|
|
66
|
+
# <--------------- END DOCSPRING CUSTOMIZATION ----------------->
|
|
53
67
|
end
|
|
54
68
|
end
|
|
69
|
+
|
|
55
70
|
# integration tests for batch_generate_pdf_v1
|
|
56
71
|
# Generates multiple PDFs
|
|
57
72
|
# @param template_id
|
|
58
|
-
# @param
|
|
73
|
+
# @param data
|
|
59
74
|
# @param [Hash] opts the optional parameters
|
|
60
75
|
# @return [Array<CreateSubmissionResponse>]
|
|
61
76
|
describe 'batch_generate_pdf_v1 test' do
|
|
62
77
|
it 'should work' do
|
|
63
|
-
template_id =
|
|
64
|
-
|
|
65
|
-
result = api_instance.
|
|
78
|
+
template_id = tpl_000000000000000001 # String |
|
|
79
|
+
data = # Array<SubmissionData> |
|
|
80
|
+
result = api_instance.
|
|
81
|
+
batch_generate_pdf_v1(
|
|
82
|
+
template_id,
|
|
83
|
+
data
|
|
84
|
+
)
|
|
66
85
|
expect(result).to_not be_nil
|
|
86
|
+
# <--------------- END DOCSPRING CUSTOMIZATION ----------------->
|
|
67
87
|
end
|
|
68
88
|
end
|
|
89
|
+
|
|
69
90
|
# integration tests for batch_generate_pdfs
|
|
70
91
|
# Generates multiple PDFs
|
|
71
|
-
# @param
|
|
92
|
+
# @param data
|
|
72
93
|
# @param [Hash] opts the optional parameters
|
|
73
94
|
# @return [CreateSubmissionBatchResponse]
|
|
74
95
|
describe 'batch_generate_pdfs test' do
|
|
75
96
|
it 'should work' do
|
|
76
|
-
|
|
77
|
-
result = api_instance.
|
|
97
|
+
data = # SubmissionBatchData |
|
|
98
|
+
result = api_instance.
|
|
99
|
+
batch_generate_pdfs(
|
|
100
|
+
data
|
|
101
|
+
)
|
|
78
102
|
expect(result).to_not be_nil
|
|
103
|
+
# <--------------- END DOCSPRING CUSTOMIZATION ----------------->
|
|
79
104
|
end
|
|
80
105
|
end
|
|
106
|
+
|
|
81
107
|
# integration tests for combine_pdfs
|
|
82
108
|
# Merge submission PDFs, template PDFs, or custom files
|
|
83
|
-
# @param
|
|
109
|
+
# @param data
|
|
84
110
|
# @param [Hash] opts the optional parameters
|
|
85
111
|
# @return [CreateCombinedSubmissionResponse]
|
|
86
112
|
describe 'combine_pdfs test' do
|
|
87
113
|
it 'should work' do
|
|
88
|
-
|
|
89
|
-
result = api_instance.
|
|
114
|
+
data = # CombinePdfsData |
|
|
115
|
+
result = api_instance.
|
|
116
|
+
combine_pdfs(
|
|
117
|
+
data
|
|
118
|
+
)
|
|
90
119
|
expect(result).to_not be_nil
|
|
120
|
+
# <--------------- END DOCSPRING CUSTOMIZATION ----------------->
|
|
91
121
|
end
|
|
92
122
|
end
|
|
123
|
+
|
|
93
124
|
# integration tests for combine_submissions
|
|
94
125
|
# Merge generated PDFs together
|
|
95
|
-
# @param
|
|
126
|
+
# @param data
|
|
96
127
|
# @param [Hash] opts the optional parameters
|
|
97
128
|
# @return [CreateCombinedSubmissionResponse]
|
|
98
129
|
describe 'combine_submissions test' do
|
|
99
130
|
it 'should work' do
|
|
100
|
-
|
|
101
|
-
result = api_instance.
|
|
131
|
+
data = # CombinedSubmissionData |
|
|
132
|
+
result = api_instance.
|
|
133
|
+
combine_submissions(
|
|
134
|
+
data
|
|
135
|
+
)
|
|
102
136
|
expect(result).to_not be_nil
|
|
137
|
+
# <--------------- END DOCSPRING CUSTOMIZATION ----------------->
|
|
103
138
|
end
|
|
104
139
|
end
|
|
140
|
+
|
|
105
141
|
# integration tests for copy_template
|
|
106
142
|
# Copy a Template
|
|
107
143
|
# @param template_id
|
|
108
|
-
# @param
|
|
144
|
+
# @param data
|
|
109
145
|
# @param [Hash] opts the optional parameters
|
|
110
146
|
# @return [Template]
|
|
111
147
|
describe 'copy_template test' do
|
|
112
148
|
it 'should work' do
|
|
113
|
-
template_id =
|
|
114
|
-
|
|
115
|
-
result = api_instance.
|
|
149
|
+
template_id = tpl_000000000000000001 # String |
|
|
150
|
+
data = # CopyTemplateData |
|
|
151
|
+
result = api_instance.
|
|
152
|
+
copy_template(
|
|
153
|
+
template_id,
|
|
154
|
+
data
|
|
155
|
+
)
|
|
116
156
|
expect(result).to_not be_nil
|
|
157
|
+
# <--------------- END DOCSPRING CUSTOMIZATION ----------------->
|
|
117
158
|
end
|
|
118
159
|
end
|
|
160
|
+
|
|
119
161
|
# integration tests for create_custom_file_from_upload
|
|
120
162
|
# Create a new custom file from a cached presign upload
|
|
121
|
-
# @param
|
|
163
|
+
# @param data
|
|
122
164
|
# @param [Hash] opts the optional parameters
|
|
123
165
|
# @return [CreateCustomFileResponse]
|
|
124
166
|
describe 'create_custom_file_from_upload test' do
|
|
125
167
|
it 'should work' do
|
|
126
|
-
|
|
127
|
-
result = api_instance.
|
|
168
|
+
data = # CreateCustomFileData |
|
|
169
|
+
result = api_instance.
|
|
170
|
+
create_custom_file_from_upload(
|
|
171
|
+
data
|
|
172
|
+
)
|
|
128
173
|
expect(result).to_not be_nil
|
|
174
|
+
# <--------------- END DOCSPRING CUSTOMIZATION ----------------->
|
|
129
175
|
end
|
|
130
176
|
end
|
|
177
|
+
|
|
178
|
+
# integration tests for create_data_request_event
|
|
179
|
+
# Creates a new event for emailing a signee a request for signature
|
|
180
|
+
# @param data_request_id
|
|
181
|
+
# @param event
|
|
182
|
+
# @param [Hash] opts the optional parameters
|
|
183
|
+
# @return [CreateSubmissionDataRequestEventResponse]
|
|
184
|
+
describe 'create_data_request_event test' do
|
|
185
|
+
it 'should work' do
|
|
186
|
+
data_request_id = drq_000000000000000001 # String |
|
|
187
|
+
event = # CreateSubmissionDataRequestEventRequest |
|
|
188
|
+
result = api_instance.
|
|
189
|
+
create_data_request_event(
|
|
190
|
+
data_request_id,
|
|
191
|
+
event
|
|
192
|
+
)
|
|
193
|
+
expect(result).to_not be_nil
|
|
194
|
+
# <--------------- END DOCSPRING CUSTOMIZATION ----------------->
|
|
195
|
+
end
|
|
196
|
+
end
|
|
197
|
+
|
|
131
198
|
# integration tests for create_data_request_token
|
|
132
199
|
# Creates a new data request token for form authentication
|
|
133
200
|
# @param data_request_id
|
|
@@ -135,35 +202,50 @@ describe 'PDFApi' do
|
|
|
135
202
|
# @return [CreateSubmissionDataRequestTokenResponse]
|
|
136
203
|
describe 'create_data_request_token test' do
|
|
137
204
|
it 'should work' do
|
|
138
|
-
data_request_id =
|
|
139
|
-
result = api_instance.
|
|
205
|
+
data_request_id = drq_000000000000000001 # String |
|
|
206
|
+
result = api_instance.
|
|
207
|
+
create_data_request_token(
|
|
208
|
+
data_request_id
|
|
209
|
+
)
|
|
140
210
|
expect(result).to_not be_nil
|
|
211
|
+
# <--------------- END DOCSPRING CUSTOMIZATION ----------------->
|
|
141
212
|
end
|
|
142
213
|
end
|
|
214
|
+
|
|
143
215
|
# integration tests for create_folder
|
|
144
216
|
# Create a folder
|
|
145
|
-
# @param
|
|
217
|
+
# @param data
|
|
146
218
|
# @param [Hash] opts the optional parameters
|
|
147
219
|
# @return [Folder]
|
|
148
220
|
describe 'create_folder test' do
|
|
149
221
|
it 'should work' do
|
|
150
|
-
|
|
151
|
-
result = api_instance.
|
|
222
|
+
data = # CreateFolderData |
|
|
223
|
+
result = api_instance.
|
|
224
|
+
create_folder(
|
|
225
|
+
data
|
|
226
|
+
)
|
|
152
227
|
expect(result).to_not be_nil
|
|
228
|
+
# <--------------- END DOCSPRING CUSTOMIZATION ----------------->
|
|
153
229
|
end
|
|
154
230
|
end
|
|
231
|
+
|
|
155
232
|
# integration tests for create_html_template
|
|
156
233
|
# Create a new HTML template
|
|
157
|
-
# @param
|
|
234
|
+
# @param data
|
|
158
235
|
# @param [Hash] opts the optional parameters
|
|
159
236
|
# @return [PendingTemplate]
|
|
160
237
|
describe 'create_html_template test' do
|
|
161
238
|
it 'should work' do
|
|
162
|
-
|
|
163
|
-
result = api_instance.
|
|
239
|
+
data = # CreateHtmlTemplateData |
|
|
240
|
+
result = api_instance.
|
|
241
|
+
create_html_template(
|
|
242
|
+
data
|
|
243
|
+
)
|
|
164
244
|
expect(result).to_not be_nil
|
|
245
|
+
# <--------------- END DOCSPRING CUSTOMIZATION ----------------->
|
|
165
246
|
end
|
|
166
247
|
end
|
|
248
|
+
|
|
167
249
|
# integration tests for create_pdf_template
|
|
168
250
|
# Create a new PDF template with a form POST file upload
|
|
169
251
|
# @param template_document
|
|
@@ -173,27 +255,39 @@ describe 'PDFApi' do
|
|
|
173
255
|
# @return [PendingTemplate]
|
|
174
256
|
describe 'create_pdf_template test' do
|
|
175
257
|
it 'should work' do
|
|
176
|
-
template_document =
|
|
177
|
-
template_name =
|
|
258
|
+
template_document = BINARY_DATA_HERE # File |
|
|
259
|
+
template_name = template_name_example # String |
|
|
178
260
|
opts = {
|
|
179
|
-
template_parent_folder_id:
|
|
261
|
+
template_parent_folder_id: template_parent_folder_id_example # String |
|
|
180
262
|
}
|
|
181
|
-
result = api_instance.
|
|
263
|
+
result = api_instance.
|
|
264
|
+
create_pdf_template(
|
|
265
|
+
template_document,
|
|
266
|
+
template_name,
|
|
267
|
+
opts
|
|
268
|
+
)
|
|
182
269
|
expect(result).to_not be_nil
|
|
270
|
+
# <--------------- END DOCSPRING CUSTOMIZATION ----------------->
|
|
183
271
|
end
|
|
184
272
|
end
|
|
273
|
+
|
|
185
274
|
# integration tests for create_pdf_template_from_upload
|
|
186
275
|
# Create a new PDF template from a cached presign upload
|
|
187
|
-
# @param
|
|
276
|
+
# @param data
|
|
188
277
|
# @param [Hash] opts the optional parameters
|
|
189
278
|
# @return [PendingTemplate]
|
|
190
279
|
describe 'create_pdf_template_from_upload test' do
|
|
191
280
|
it 'should work' do
|
|
192
|
-
|
|
193
|
-
result = api_instance.
|
|
281
|
+
data = # CreateTemplateFromUploadData |
|
|
282
|
+
result = api_instance.
|
|
283
|
+
create_pdf_template_from_upload(
|
|
284
|
+
data
|
|
285
|
+
)
|
|
194
286
|
expect(result).to_not be_nil
|
|
287
|
+
# <--------------- END DOCSPRING CUSTOMIZATION ----------------->
|
|
195
288
|
end
|
|
196
289
|
end
|
|
290
|
+
|
|
197
291
|
# integration tests for delete_folder
|
|
198
292
|
# Delete a folder
|
|
199
293
|
# @param folder_id
|
|
@@ -201,11 +295,38 @@ describe 'PDFApi' do
|
|
|
201
295
|
# @return [Folder]
|
|
202
296
|
describe 'delete_folder test' do
|
|
203
297
|
it 'should work' do
|
|
204
|
-
folder_id =
|
|
205
|
-
result = api_instance.
|
|
298
|
+
folder_id = fld_0000000000000000001 # String |
|
|
299
|
+
result = api_instance.
|
|
300
|
+
delete_folder(
|
|
301
|
+
folder_id
|
|
302
|
+
)
|
|
303
|
+
expect(result).to_not be_nil
|
|
304
|
+
# <--------------- END DOCSPRING CUSTOMIZATION ----------------->
|
|
305
|
+
end
|
|
306
|
+
end
|
|
307
|
+
|
|
308
|
+
# integration tests for delete_template
|
|
309
|
+
# Delete a template
|
|
310
|
+
# @param template_id
|
|
311
|
+
# @param [Hash] opts the optional parameters
|
|
312
|
+
# @option opts [String] :version
|
|
313
|
+
# @return [DeleteTemplateResponse]
|
|
314
|
+
describe 'delete_template test' do
|
|
315
|
+
it 'should work' do
|
|
316
|
+
template_id = tpl_000000000000000001 # String |
|
|
317
|
+
opts = {
|
|
318
|
+
version: 0.1.0 # String |
|
|
319
|
+
}
|
|
320
|
+
result = api_instance.
|
|
321
|
+
delete_template(
|
|
322
|
+
template_id,
|
|
323
|
+
opts
|
|
324
|
+
)
|
|
206
325
|
expect(result).to_not be_nil
|
|
326
|
+
# <--------------- END DOCSPRING CUSTOMIZATION ----------------->
|
|
207
327
|
end
|
|
208
328
|
end
|
|
329
|
+
|
|
209
330
|
# integration tests for expire_combined_submission
|
|
210
331
|
# Expire a combined submission
|
|
211
332
|
# @param combined_submission_id
|
|
@@ -213,11 +334,16 @@ describe 'PDFApi' do
|
|
|
213
334
|
# @return [CombinedSubmission]
|
|
214
335
|
describe 'expire_combined_submission test' do
|
|
215
336
|
it 'should work' do
|
|
216
|
-
combined_submission_id =
|
|
217
|
-
result = api_instance.
|
|
337
|
+
combined_submission_id = com_0000000000000000001 # String |
|
|
338
|
+
result = api_instance.
|
|
339
|
+
expire_combined_submission(
|
|
340
|
+
combined_submission_id
|
|
341
|
+
)
|
|
218
342
|
expect(result).to_not be_nil
|
|
343
|
+
# <--------------- END DOCSPRING CUSTOMIZATION ----------------->
|
|
219
344
|
end
|
|
220
345
|
end
|
|
346
|
+
|
|
221
347
|
# integration tests for expire_submission
|
|
222
348
|
# Expire a PDF submission
|
|
223
349
|
# @param submission_id
|
|
@@ -225,25 +351,53 @@ describe 'PDFApi' do
|
|
|
225
351
|
# @return [Submission]
|
|
226
352
|
describe 'expire_submission test' do
|
|
227
353
|
it 'should work' do
|
|
228
|
-
submission_id =
|
|
229
|
-
result = api_instance.
|
|
354
|
+
submission_id = sub_000000000000000001 # String |
|
|
355
|
+
result = api_instance.
|
|
356
|
+
expire_submission(
|
|
357
|
+
submission_id
|
|
358
|
+
)
|
|
230
359
|
expect(result).to_not be_nil
|
|
360
|
+
# <--------------- END DOCSPRING CUSTOMIZATION ----------------->
|
|
231
361
|
end
|
|
232
362
|
end
|
|
363
|
+
|
|
233
364
|
# integration tests for generate_pdf
|
|
234
365
|
# Generates a new PDF
|
|
235
366
|
# @param template_id
|
|
236
|
-
# @param
|
|
367
|
+
# @param submission
|
|
237
368
|
# @param [Hash] opts the optional parameters
|
|
238
369
|
# @return [CreateSubmissionResponse]
|
|
239
370
|
describe 'generate_pdf test' do
|
|
240
371
|
it 'should work' do
|
|
241
|
-
template_id =
|
|
242
|
-
|
|
243
|
-
result = api_instance.
|
|
372
|
+
template_id = tpl_000000000000000001 # String |
|
|
373
|
+
submission = # CreateSubmissionData |
|
|
374
|
+
result = api_instance.
|
|
375
|
+
generate_pdf(
|
|
376
|
+
template_id,
|
|
377
|
+
submission
|
|
378
|
+
)
|
|
244
379
|
expect(result).to_not be_nil
|
|
380
|
+
# <--------------- END DOCSPRING CUSTOMIZATION ----------------->
|
|
245
381
|
end
|
|
246
382
|
end
|
|
383
|
+
|
|
384
|
+
# integration tests for generate_preview
|
|
385
|
+
# Generated a preview PDF for partially completed data requests
|
|
386
|
+
# @param submission_id
|
|
387
|
+
# @param [Hash] opts the optional parameters
|
|
388
|
+
# @return [PreviewPdfResponse]
|
|
389
|
+
describe 'generate_preview test' do
|
|
390
|
+
it 'should work' do
|
|
391
|
+
submission_id = sub_00000000000000001 # String |
|
|
392
|
+
result = api_instance.
|
|
393
|
+
generate_preview(
|
|
394
|
+
submission_id
|
|
395
|
+
)
|
|
396
|
+
expect(result).to_not be_nil
|
|
397
|
+
# <--------------- END DOCSPRING CUSTOMIZATION ----------------->
|
|
398
|
+
end
|
|
399
|
+
end
|
|
400
|
+
|
|
247
401
|
# integration tests for get_combined_submission
|
|
248
402
|
# Check the status of a combined submission (merged PDFs)
|
|
249
403
|
# @param combined_submission_id
|
|
@@ -251,11 +405,16 @@ describe 'PDFApi' do
|
|
|
251
405
|
# @return [CombinedSubmission]
|
|
252
406
|
describe 'get_combined_submission test' do
|
|
253
407
|
it 'should work' do
|
|
254
|
-
combined_submission_id =
|
|
255
|
-
result = api_instance.
|
|
408
|
+
combined_submission_id = com_0000000000000000001 # String |
|
|
409
|
+
result = api_instance.
|
|
410
|
+
get_combined_submission(
|
|
411
|
+
combined_submission_id
|
|
412
|
+
)
|
|
256
413
|
expect(result).to_not be_nil
|
|
414
|
+
# <--------------- END DOCSPRING CUSTOMIZATION ----------------->
|
|
257
415
|
end
|
|
258
416
|
end
|
|
417
|
+
|
|
259
418
|
# integration tests for get_data_request
|
|
260
419
|
# Look up a submission data request
|
|
261
420
|
# @param data_request_id
|
|
@@ -263,65 +422,90 @@ describe 'PDFApi' do
|
|
|
263
422
|
# @return [SubmissionDataRequest]
|
|
264
423
|
describe 'get_data_request test' do
|
|
265
424
|
it 'should work' do
|
|
266
|
-
data_request_id =
|
|
267
|
-
result = api_instance.
|
|
425
|
+
data_request_id = drq_000000000000000001 # String |
|
|
426
|
+
result = api_instance.
|
|
427
|
+
get_data_request(
|
|
428
|
+
data_request_id
|
|
429
|
+
)
|
|
268
430
|
expect(result).to_not be_nil
|
|
431
|
+
# <--------------- END DOCSPRING CUSTOMIZATION ----------------->
|
|
269
432
|
end
|
|
270
433
|
end
|
|
434
|
+
|
|
271
435
|
# integration tests for get_full_template
|
|
272
436
|
# Fetch the full template attributes
|
|
273
437
|
# @param template_id
|
|
274
438
|
# @param [Hash] opts the optional parameters
|
|
275
|
-
# @return [
|
|
439
|
+
# @return [FullTemplate]
|
|
276
440
|
describe 'get_full_template test' do
|
|
277
441
|
it 'should work' do
|
|
278
|
-
template_id =
|
|
279
|
-
result = api_instance.
|
|
442
|
+
template_id = tpl_000000000000000001 # String |
|
|
443
|
+
result = api_instance.
|
|
444
|
+
get_full_template(
|
|
445
|
+
template_id
|
|
446
|
+
)
|
|
280
447
|
expect(result).to_not be_nil
|
|
448
|
+
# <--------------- END DOCSPRING CUSTOMIZATION ----------------->
|
|
281
449
|
end
|
|
282
450
|
end
|
|
451
|
+
|
|
283
452
|
# integration tests for get_presign_url
|
|
284
453
|
# Get a presigned URL so that you can upload a file to our AWS S3 bucket
|
|
285
454
|
# @param [Hash] opts the optional parameters
|
|
286
|
-
# @return [
|
|
455
|
+
# @return [UploadPresign]
|
|
287
456
|
describe 'get_presign_url test' do
|
|
288
457
|
it 'should work' do
|
|
289
|
-
result = api_instance.
|
|
458
|
+
result = api_instance.
|
|
459
|
+
get_presign_url
|
|
290
460
|
expect(result).to_not be_nil
|
|
461
|
+
# <--------------- END DOCSPRING CUSTOMIZATION ----------------->
|
|
291
462
|
end
|
|
292
463
|
end
|
|
464
|
+
|
|
293
465
|
# integration tests for get_submission
|
|
294
466
|
# Check the status of a PDF
|
|
295
467
|
# @param submission_id
|
|
296
468
|
# @param [Hash] opts the optional parameters
|
|
297
|
-
# @option opts [
|
|
469
|
+
# @option opts [Boolean] :include_data
|
|
298
470
|
# @return [Submission]
|
|
299
471
|
describe 'get_submission test' do
|
|
300
472
|
it 'should work' do
|
|
301
|
-
submission_id =
|
|
473
|
+
submission_id = sub_000000000000000001 # String |
|
|
302
474
|
opts = {
|
|
303
|
-
include_data: true #
|
|
475
|
+
include_data: true # Boolean |
|
|
304
476
|
}
|
|
305
|
-
result = api_instance.
|
|
477
|
+
result = api_instance.
|
|
478
|
+
get_submission(
|
|
479
|
+
submission_id,
|
|
480
|
+
opts
|
|
481
|
+
)
|
|
306
482
|
expect(result).to_not be_nil
|
|
483
|
+
# <--------------- END DOCSPRING CUSTOMIZATION ----------------->
|
|
307
484
|
end
|
|
308
485
|
end
|
|
486
|
+
|
|
309
487
|
# integration tests for get_submission_batch
|
|
310
488
|
# Check the status of a submission batch job
|
|
311
489
|
# @param submission_batch_id
|
|
312
490
|
# @param [Hash] opts the optional parameters
|
|
313
|
-
# @option opts [
|
|
491
|
+
# @option opts [Boolean] :include_submissions
|
|
314
492
|
# @return [SubmissionBatch]
|
|
315
493
|
describe 'get_submission_batch test' do
|
|
316
494
|
it 'should work' do
|
|
317
|
-
submission_batch_id =
|
|
495
|
+
submission_batch_id = sbb_000000000000000001 # String |
|
|
318
496
|
opts = {
|
|
319
|
-
include_submissions: true #
|
|
497
|
+
include_submissions: true # Boolean |
|
|
320
498
|
}
|
|
321
|
-
result = api_instance.
|
|
499
|
+
result = api_instance.
|
|
500
|
+
get_submission_batch(
|
|
501
|
+
submission_batch_id,
|
|
502
|
+
opts
|
|
503
|
+
)
|
|
322
504
|
expect(result).to_not be_nil
|
|
505
|
+
# <--------------- END DOCSPRING CUSTOMIZATION ----------------->
|
|
323
506
|
end
|
|
324
507
|
end
|
|
508
|
+
|
|
325
509
|
# integration tests for get_template
|
|
326
510
|
# Check the status of an uploaded template
|
|
327
511
|
# @param template_id
|
|
@@ -329,23 +513,54 @@ describe 'PDFApi' do
|
|
|
329
513
|
# @return [Template]
|
|
330
514
|
describe 'get_template test' do
|
|
331
515
|
it 'should work' do
|
|
332
|
-
template_id =
|
|
333
|
-
result = api_instance.
|
|
516
|
+
template_id = tpl_000000000000000001 # String |
|
|
517
|
+
result = api_instance.
|
|
518
|
+
get_template(
|
|
519
|
+
template_id
|
|
520
|
+
)
|
|
334
521
|
expect(result).to_not be_nil
|
|
522
|
+
# <--------------- END DOCSPRING CUSTOMIZATION ----------------->
|
|
335
523
|
end
|
|
336
524
|
end
|
|
525
|
+
|
|
337
526
|
# integration tests for get_template_schema
|
|
338
527
|
# Fetch the JSON schema for a template
|
|
339
528
|
# @param template_id
|
|
340
529
|
# @param [Hash] opts the optional parameters
|
|
341
|
-
# @return [
|
|
530
|
+
# @return [TemplateSchema]
|
|
342
531
|
describe 'get_template_schema test' do
|
|
343
532
|
it 'should work' do
|
|
344
|
-
template_id =
|
|
345
|
-
result = api_instance.
|
|
533
|
+
template_id = tpl_000000000000000001 # String |
|
|
534
|
+
result = api_instance.
|
|
535
|
+
get_template_schema(
|
|
536
|
+
template_id
|
|
537
|
+
)
|
|
346
538
|
expect(result).to_not be_nil
|
|
539
|
+
# <--------------- END DOCSPRING CUSTOMIZATION ----------------->
|
|
347
540
|
end
|
|
348
541
|
end
|
|
542
|
+
|
|
543
|
+
# integration tests for list_combined_submissions
|
|
544
|
+
# Get a list of all combined submissions
|
|
545
|
+
# @param [Hash] opts the optional parameters
|
|
546
|
+
# @option opts [Integer] :page Default: 1
|
|
547
|
+
# @option opts [Integer] :per_page Default: 50
|
|
548
|
+
# @return [Array<CombinedSubmission>]
|
|
549
|
+
describe 'list_combined_submissions test' do
|
|
550
|
+
it 'should work' do
|
|
551
|
+
opts = {
|
|
552
|
+
page: 2, # Integer | Default: 1
|
|
553
|
+
per_page: 1 # Integer | Default: 50
|
|
554
|
+
}
|
|
555
|
+
result = api_instance.
|
|
556
|
+
list_combined_submissions(
|
|
557
|
+
opts
|
|
558
|
+
)
|
|
559
|
+
expect(result).to_not be_nil
|
|
560
|
+
# <--------------- END DOCSPRING CUSTOMIZATION ----------------->
|
|
561
|
+
end
|
|
562
|
+
end
|
|
563
|
+
|
|
349
564
|
# integration tests for list_folders
|
|
350
565
|
# Get a list of all folders
|
|
351
566
|
# @param [Hash] opts the optional parameters
|
|
@@ -354,12 +569,17 @@ describe 'PDFApi' do
|
|
|
354
569
|
describe 'list_folders test' do
|
|
355
570
|
it 'should work' do
|
|
356
571
|
opts = {
|
|
357
|
-
parent_folder_id:
|
|
572
|
+
parent_folder_id: fld_0000000000000000002 # String | Filter By Folder Id
|
|
358
573
|
}
|
|
359
|
-
result = api_instance.
|
|
574
|
+
result = api_instance.
|
|
575
|
+
list_folders(
|
|
576
|
+
opts
|
|
577
|
+
)
|
|
360
578
|
expect(result).to_not be_nil
|
|
579
|
+
# <--------------- END DOCSPRING CUSTOMIZATION ----------------->
|
|
361
580
|
end
|
|
362
581
|
end
|
|
582
|
+
|
|
363
583
|
# integration tests for list_submissions
|
|
364
584
|
# List all submissions
|
|
365
585
|
# @param [Hash] opts the optional parameters
|
|
@@ -368,23 +588,28 @@ describe 'PDFApi' do
|
|
|
368
588
|
# @option opts [String] :created_after
|
|
369
589
|
# @option opts [String] :created_before
|
|
370
590
|
# @option opts [String] :type
|
|
371
|
-
# @option opts [
|
|
591
|
+
# @option opts [Boolean] :include_data
|
|
372
592
|
# @return [ListSubmissionsResponse]
|
|
373
593
|
describe 'list_submissions test' do
|
|
374
594
|
it 'should work' do
|
|
375
595
|
opts = {
|
|
376
|
-
cursor:
|
|
596
|
+
cursor: sub_list_000012, # String |
|
|
377
597
|
limit: 3, # Float |
|
|
378
|
-
created_after:
|
|
379
|
-
created_before:
|
|
380
|
-
type:
|
|
381
|
-
include_data: true #
|
|
598
|
+
created_after: 2019-01-01T09:00:00-05:00, # String |
|
|
599
|
+
created_before: 2020-01-01T09:00:00.000+0200, # String |
|
|
600
|
+
type: test, # String |
|
|
601
|
+
include_data: true # Boolean |
|
|
382
602
|
}
|
|
383
|
-
result = api_instance.
|
|
603
|
+
result = api_instance.
|
|
604
|
+
list_submissions(
|
|
605
|
+
opts
|
|
606
|
+
)
|
|
384
607
|
expect(result).to_not be_nil
|
|
608
|
+
# <--------------- END DOCSPRING CUSTOMIZATION ----------------->
|
|
385
609
|
end
|
|
386
610
|
end
|
|
387
|
-
|
|
611
|
+
|
|
612
|
+
# integration tests for list_template_submissions
|
|
388
613
|
# List all submissions for a given template
|
|
389
614
|
# @param template_id
|
|
390
615
|
# @param [Hash] opts the optional parameters
|
|
@@ -393,23 +618,29 @@ describe 'PDFApi' do
|
|
|
393
618
|
# @option opts [String] :created_after
|
|
394
619
|
# @option opts [String] :created_before
|
|
395
620
|
# @option opts [String] :type
|
|
396
|
-
# @option opts [
|
|
621
|
+
# @option opts [Boolean] :include_data
|
|
397
622
|
# @return [ListSubmissionsResponse]
|
|
398
|
-
describe '
|
|
623
|
+
describe 'list_template_submissions test' do
|
|
399
624
|
it 'should work' do
|
|
400
|
-
template_id =
|
|
625
|
+
template_id = tpl_000000000000000002 # String |
|
|
401
626
|
opts = {
|
|
402
|
-
cursor:
|
|
403
|
-
limit:
|
|
404
|
-
created_after:
|
|
405
|
-
created_before:
|
|
406
|
-
type:
|
|
407
|
-
include_data: true #
|
|
627
|
+
cursor: cursor_example, # String |
|
|
628
|
+
limit: 8.14, # Float |
|
|
629
|
+
created_after: created_after_example, # String |
|
|
630
|
+
created_before: created_before_example, # String |
|
|
631
|
+
type: type_example, # String |
|
|
632
|
+
include_data: true # Boolean |
|
|
408
633
|
}
|
|
409
|
-
result = api_instance.
|
|
634
|
+
result = api_instance.
|
|
635
|
+
list_template_submissions(
|
|
636
|
+
template_id,
|
|
637
|
+
opts
|
|
638
|
+
)
|
|
410
639
|
expect(result).to_not be_nil
|
|
640
|
+
# <--------------- END DOCSPRING CUSTOMIZATION ----------------->
|
|
411
641
|
end
|
|
412
642
|
end
|
|
643
|
+
|
|
413
644
|
# integration tests for list_templates
|
|
414
645
|
# Get a list of all templates
|
|
415
646
|
# @param [Hash] opts the optional parameters
|
|
@@ -421,93 +652,171 @@ describe 'PDFApi' do
|
|
|
421
652
|
describe 'list_templates test' do
|
|
422
653
|
it 'should work' do
|
|
423
654
|
opts = {
|
|
424
|
-
query:
|
|
425
|
-
parent_folder_id:
|
|
655
|
+
query: 2, # String | Search By Name
|
|
656
|
+
parent_folder_id: fld_000000000000000001, # String | Filter By Folder Id
|
|
426
657
|
page: 2, # Integer | Default: 1
|
|
427
658
|
per_page: 1 # Integer | Default: 50
|
|
428
659
|
}
|
|
429
|
-
result = api_instance.
|
|
660
|
+
result = api_instance.
|
|
661
|
+
list_templates(
|
|
662
|
+
opts
|
|
663
|
+
)
|
|
430
664
|
expect(result).to_not be_nil
|
|
665
|
+
# <--------------- END DOCSPRING CUSTOMIZATION ----------------->
|
|
431
666
|
end
|
|
432
667
|
end
|
|
668
|
+
|
|
433
669
|
# integration tests for move_folder_to_folder
|
|
434
670
|
# Move a folder
|
|
435
671
|
# @param folder_id
|
|
436
|
-
# @param
|
|
672
|
+
# @param data
|
|
437
673
|
# @param [Hash] opts the optional parameters
|
|
438
674
|
# @return [Folder]
|
|
439
675
|
describe 'move_folder_to_folder test' do
|
|
440
676
|
it 'should work' do
|
|
441
|
-
folder_id =
|
|
442
|
-
|
|
443
|
-
result = api_instance.
|
|
677
|
+
folder_id = fld_0000000000000000001 # String |
|
|
678
|
+
data = # MoveFolderData |
|
|
679
|
+
result = api_instance.
|
|
680
|
+
move_folder_to_folder(
|
|
681
|
+
folder_id,
|
|
682
|
+
data
|
|
683
|
+
)
|
|
444
684
|
expect(result).to_not be_nil
|
|
685
|
+
# <--------------- END DOCSPRING CUSTOMIZATION ----------------->
|
|
445
686
|
end
|
|
446
687
|
end
|
|
688
|
+
|
|
447
689
|
# integration tests for move_template_to_folder
|
|
448
690
|
# Move Template to folder
|
|
449
691
|
# @param template_id
|
|
450
|
-
# @param
|
|
692
|
+
# @param data
|
|
451
693
|
# @param [Hash] opts the optional parameters
|
|
452
694
|
# @return [Template]
|
|
453
695
|
describe 'move_template_to_folder test' do
|
|
454
696
|
it 'should work' do
|
|
455
|
-
template_id =
|
|
456
|
-
|
|
457
|
-
result = api_instance.
|
|
697
|
+
template_id = tpl_000000000000000001 # String |
|
|
698
|
+
data = # MoveTemplateData |
|
|
699
|
+
result = api_instance.
|
|
700
|
+
move_template_to_folder(
|
|
701
|
+
template_id,
|
|
702
|
+
data
|
|
703
|
+
)
|
|
704
|
+
expect(result).to_not be_nil
|
|
705
|
+
# <--------------- END DOCSPRING CUSTOMIZATION ----------------->
|
|
706
|
+
end
|
|
707
|
+
end
|
|
708
|
+
|
|
709
|
+
# integration tests for publish_template_version
|
|
710
|
+
# Publish a template version
|
|
711
|
+
# @param template_id
|
|
712
|
+
# @param data
|
|
713
|
+
# @param [Hash] opts the optional parameters
|
|
714
|
+
# @return [PublishTemplateVersionResponse]
|
|
715
|
+
describe 'publish_template_version test' do
|
|
716
|
+
it 'should work' do
|
|
717
|
+
template_id = tpl_000000000000000001 # String |
|
|
718
|
+
data = # PublishVersionData |
|
|
719
|
+
result = api_instance.
|
|
720
|
+
publish_template_version(
|
|
721
|
+
template_id,
|
|
722
|
+
data
|
|
723
|
+
)
|
|
458
724
|
expect(result).to_not be_nil
|
|
725
|
+
# <--------------- END DOCSPRING CUSTOMIZATION ----------------->
|
|
459
726
|
end
|
|
460
727
|
end
|
|
728
|
+
|
|
461
729
|
# integration tests for rename_folder
|
|
462
730
|
# Rename a folder
|
|
463
731
|
# @param folder_id
|
|
464
|
-
# @param
|
|
732
|
+
# @param data
|
|
465
733
|
# @param [Hash] opts the optional parameters
|
|
466
734
|
# @return [nil]
|
|
467
735
|
describe 'rename_folder test' do
|
|
468
736
|
it 'should work' do
|
|
469
|
-
folder_id =
|
|
470
|
-
|
|
471
|
-
api_instance.
|
|
737
|
+
folder_id = fld_0000000000000000001 # String |
|
|
738
|
+
data = # RenameFolderData |
|
|
739
|
+
api_instance.
|
|
740
|
+
rename_folder(
|
|
741
|
+
folder_id,
|
|
742
|
+
data
|
|
743
|
+
)
|
|
744
|
+
expect(result).to_not be_nil
|
|
745
|
+
# <--------------- END DOCSPRING CUSTOMIZATION ----------------->
|
|
746
|
+
end
|
|
747
|
+
end
|
|
748
|
+
|
|
749
|
+
# integration tests for restore_template_version
|
|
750
|
+
# Restore a template version
|
|
751
|
+
# @param template_id
|
|
752
|
+
# @param data
|
|
753
|
+
# @param [Hash] opts the optional parameters
|
|
754
|
+
# @return [RestoreTemplateVersionResponse]
|
|
755
|
+
describe 'restore_template_version test' do
|
|
756
|
+
it 'should work' do
|
|
757
|
+
template_id = tpl_000000000000000001 # String |
|
|
758
|
+
data = # RestoreVersionData |
|
|
759
|
+
result = api_instance.
|
|
760
|
+
restore_template_version(
|
|
761
|
+
template_id,
|
|
762
|
+
data
|
|
763
|
+
)
|
|
472
764
|
expect(result).to_not be_nil
|
|
765
|
+
# <--------------- END DOCSPRING CUSTOMIZATION ----------------->
|
|
473
766
|
end
|
|
474
767
|
end
|
|
768
|
+
|
|
475
769
|
# integration tests for test_authentication
|
|
476
770
|
# Test Authentication
|
|
477
771
|
# @param [Hash] opts the optional parameters
|
|
478
772
|
# @return [AuthenticationSuccessResponse]
|
|
479
773
|
describe 'test_authentication test' do
|
|
480
774
|
it 'should work' do
|
|
481
|
-
result = api_instance.
|
|
775
|
+
result = api_instance.
|
|
776
|
+
test_authentication
|
|
482
777
|
expect(result).to_not be_nil
|
|
778
|
+
# <--------------- END DOCSPRING CUSTOMIZATION ----------------->
|
|
483
779
|
end
|
|
484
780
|
end
|
|
781
|
+
|
|
485
782
|
# integration tests for update_data_request
|
|
486
783
|
# Update a submission data request
|
|
487
784
|
# @param data_request_id
|
|
488
|
-
# @param
|
|
785
|
+
# @param data
|
|
489
786
|
# @param [Hash] opts the optional parameters
|
|
490
787
|
# @return [UpdateDataRequestResponse]
|
|
491
788
|
describe 'update_data_request test' do
|
|
492
789
|
it 'should work' do
|
|
493
|
-
data_request_id =
|
|
494
|
-
|
|
495
|
-
result = api_instance.
|
|
790
|
+
data_request_id = drq_000000000000000001 # String |
|
|
791
|
+
data = # UpdateSubmissionDataRequestData |
|
|
792
|
+
result = api_instance.
|
|
793
|
+
update_data_request(
|
|
794
|
+
data_request_id,
|
|
795
|
+
data
|
|
796
|
+
)
|
|
496
797
|
expect(result).to_not be_nil
|
|
798
|
+
# <--------------- END DOCSPRING CUSTOMIZATION ----------------->
|
|
497
799
|
end
|
|
498
800
|
end
|
|
801
|
+
|
|
499
802
|
# integration tests for update_template
|
|
500
803
|
# Update a Template
|
|
501
804
|
# @param template_id
|
|
502
|
-
# @param
|
|
805
|
+
# @param data
|
|
503
806
|
# @param [Hash] opts the optional parameters
|
|
504
807
|
# @return [UpdateTemplateResponse]
|
|
505
808
|
describe 'update_template test' do
|
|
506
809
|
it 'should work' do
|
|
507
|
-
template_id =
|
|
508
|
-
|
|
509
|
-
result = api_instance.
|
|
810
|
+
template_id = tpl_000000000000000003 # String |
|
|
811
|
+
data = # UpdateTemplateData |
|
|
812
|
+
result = api_instance.
|
|
813
|
+
update_template(
|
|
814
|
+
template_id,
|
|
815
|
+
data
|
|
816
|
+
)
|
|
510
817
|
expect(result).to_not be_nil
|
|
818
|
+
# <--------------- END DOCSPRING CUSTOMIZATION ----------------->
|
|
511
819
|
end
|
|
512
820
|
end
|
|
821
|
+
|
|
513
822
|
end
|