docspring 1.1.0 → 1.3.2
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/.openapi-generator/VERSION +1 -1
- data/CHANGELOG.md +20 -0
- data/Gemfile.lock +1 -1
- data/LICENSE +1 -1
- data/README.md +22 -15
- data/docs/AddFieldsData.md +8 -0
- data/docs/AddFieldsTemplateResponse.md +10 -0
- data/docs/CombinePdfsData.md +4 -4
- data/docs/CombinedSubmissionData.md +3 -3
- data/docs/CopyTemplateData.md +9 -0
- data/docs/CreateHtmlTemplateData.md +8 -0
- data/docs/CreateSubmissionDataRequestData.md +2 -2
- data/docs/CreateTemplateFromUploadData.md +8 -0
- data/docs/{TemplatesdesccachedUploadTemplate.md → HtmlTemplateData.md} +3 -4
- data/docs/MoveTemplateData.md +1 -1
- data/docs/PDFApi.md +113 -9
- data/docs/PendingTemplate.md +1 -0
- data/docs/Submission.md +4 -0
- data/docs/SubmissionBatchData.md +2 -2
- data/docs/SubmissionData.md +4 -4
- data/docs/SubmissionDataBatchRequest.md +2 -2
- data/docs/SubmissionDataRequest.md +1 -0
- data/docs/Template.md +1 -0
- data/docs/{TemplatestemplateIdTemplate.md → TemplateData.md} +3 -3
- data/docs/TemplatestemplateIdaddFieldsFields.md +92 -0
- data/docs/UpdateSubmissionDataRequestData.md +9 -9
- data/docs/UpdateTemplateData.md +1 -1
- data/docs/UploadTemplateData.md +25 -0
- data/docs/UploadTemplateDataDocument.md +10 -0
- data/docs/{TemplatesdesccachedUploadTemplateDocumentMetadata.md → UploadTemplateDataDocumentMetadata.md} +1 -1
- data/docspring.gemspec +2 -2
- data/lib/docspring.rb +12 -7
- data/lib/docspring/api/pdf_api.rb +137 -19
- data/lib/docspring/api_client.rb +1 -1
- data/lib/docspring/api_error.rb +1 -1
- data/lib/docspring/configuration.rb +1 -1
- data/lib/docspring/models/add_fields_data.rb +190 -0
- data/lib/docspring/models/add_fields_template_response.rb +239 -0
- data/lib/docspring/models/authentication_error.rb +1 -1
- data/lib/docspring/models/authentication_success_response.rb +1 -1
- data/lib/docspring/models/combine_pdfs_data.rb +28 -28
- data/lib/docspring/models/combined_submission.rb +1 -1
- data/lib/docspring/models/combined_submission_action.rb +1 -6
- data/lib/docspring/models/combined_submission_data.rb +23 -23
- data/lib/docspring/models/copy_template_data.rb +197 -0
- data/lib/docspring/models/create_combined_submission_response.rb +1 -1
- data/lib/docspring/models/create_custom_file_data.rb +1 -1
- data/lib/docspring/models/create_custom_file_response.rb +1 -1
- data/lib/docspring/models/create_folder_data.rb +1 -1
- data/lib/docspring/models/{create_template_data.rb → create_html_template_data.rb} +3 -3
- data/lib/docspring/models/create_submission_batch_response.rb +1 -1
- data/lib/docspring/models/create_submission_batch_submissions_response.rb +1 -1
- data/lib/docspring/models/create_submission_data_request_data.rb +20 -20
- data/lib/docspring/models/create_submission_data_request_token_response.rb +1 -1
- data/lib/docspring/models/create_submission_data_request_token_response_token.rb +1 -1
- data/lib/docspring/models/create_submission_response.rb +1 -1
- data/lib/docspring/models/{create_template_data1.rb → create_template_from_upload_data.rb} +3 -3
- data/lib/docspring/models/custom_file.rb +1 -1
- data/lib/docspring/models/error.rb +1 -1
- data/lib/docspring/models/folder.rb +1 -1
- data/lib/docspring/models/folders_folder.rb +1 -1
- data/lib/docspring/models/html_template_data.rb +373 -0
- data/lib/docspring/models/invalid_request.rb +1 -1
- data/lib/docspring/models/move_folder_data.rb +1 -1
- data/lib/docspring/models/move_template_data.rb +6 -1
- data/lib/docspring/models/pending_template.rb +11 -2
- data/lib/docspring/models/rename_folder_data.rb +1 -1
- data/lib/docspring/models/submission.rb +41 -5
- data/lib/docspring/models/submission_action.rb +1 -6
- data/lib/docspring/models/submission_batch.rb +1 -1
- data/lib/docspring/models/submission_batch_data.rb +16 -16
- data/lib/docspring/models/submission_data.rb +34 -34
- data/lib/docspring/models/submission_data_batch_request.rb +20 -20
- data/lib/docspring/models/submission_data_request.rb +14 -15
- data/lib/docspring/models/template.rb +11 -2
- data/lib/docspring/models/{templatestemplate_id_template.rb → template_data.rb} +21 -21
- data/lib/docspring/models/templatestemplate_idadd_fields_fields.rb +1306 -0
- data/lib/docspring/models/update_data_request_response.rb +1 -1
- data/lib/docspring/models/update_submission_data_request_data.rb +79 -79
- data/lib/docspring/models/update_template_data.rb +2 -2
- data/lib/docspring/models/update_template_response.rb +1 -1
- data/lib/docspring/models/{templatesdesccached_upload_template.rb → upload_template_data.rb} +22 -22
- data/lib/docspring/models/{templatesdesccached_upload_template_document.rb → upload_template_data_document.rb} +3 -3
- data/lib/docspring/models/{templatesdesccached_upload_template_document_metadata.rb → upload_template_data_document_metadata.rb} +2 -2
- data/lib/docspring/version.rb +2 -2
- data/spec/api/pdf_api_integration_spec.rb +49 -18
- data/spec/api/pdf_api_spec_original.skipped.rb +36 -8
- data/spec/api_client_spec.rb +1 -1
- data/spec/configuration_spec.rb +1 -1
- data/spec/models/add_fields_data_spec.rb +41 -0
- data/spec/models/add_fields_template_response_spec.rb +57 -0
- data/spec/models/authentication_error_spec.rb +1 -1
- data/spec/models/authentication_success_response_spec.rb +1 -1
- data/spec/models/combine_pdfs_data_spec.rb +5 -5
- data/spec/models/combined_submission_action_spec.rb +1 -1
- data/spec/models/combined_submission_data_spec.rb +5 -5
- data/spec/models/combined_submission_spec.rb +1 -1
- data/spec/models/copy_template_data_spec.rb +47 -0
- data/spec/models/create_combined_submission_response_spec.rb +1 -1
- data/spec/models/create_custom_file_data_spec.rb +1 -1
- data/spec/models/create_custom_file_response_spec.rb +1 -1
- data/spec/models/create_folder_data_spec.rb +1 -1
- data/spec/models/{create_template_data_spec.rb → create_html_template_data_spec.rb} +7 -7
- data/spec/models/create_submission_batch_response_spec.rb +1 -1
- data/spec/models/create_submission_batch_submissions_response_spec.rb +1 -1
- data/spec/models/create_submission_data_request_data_spec.rb +9 -9
- data/spec/models/create_submission_data_request_token_response_spec.rb +1 -1
- data/spec/models/create_submission_data_request_token_response_token_spec.rb +1 -1
- data/spec/models/create_submission_response_spec.rb +1 -1
- data/spec/models/{create_template_data1_spec.rb → create_template_from_upload_data_spec.rb} +7 -7
- data/spec/models/custom_file_spec.rb +1 -1
- data/spec/models/error_spec.rb +1 -1
- data/spec/models/folder_spec.rb +1 -1
- data/spec/models/folders_folder_spec.rb +1 -1
- data/spec/models/html_template_data_spec.rb +145 -0
- data/spec/models/invalid_request_spec.rb +1 -1
- data/spec/models/move_folder_data_spec.rb +1 -1
- data/spec/models/move_template_data_spec.rb +1 -1
- data/spec/models/pending_template_spec.rb +7 -1
- data/spec/models/rename_folder_data_spec.rb +1 -1
- data/spec/models/submission_action_spec.rb +1 -1
- data/spec/models/submission_batch_data_spec.rb +3 -3
- data/spec/models/submission_batch_spec.rb +1 -1
- data/spec/models/submission_data_batch_request_spec.rb +5 -5
- data/spec/models/submission_data_request_spec.rb +7 -1
- data/spec/models/submission_data_spec.rb +7 -7
- data/spec/models/submission_spec.rb +25 -1
- data/spec/models/{templatestemplate_id_template_spec.rb → template_data_spec.rb} +11 -11
- data/spec/models/template_spec.rb +7 -1
- data/spec/models/templatestemplate_idadd_fields_fields_spec.rb +589 -0
- data/spec/models/update_data_request_response_spec.rb +1 -1
- data/spec/models/update_submission_data_request_data_spec.rb +17 -17
- data/spec/models/update_template_data_spec.rb +1 -1
- data/spec/models/update_template_response_spec.rb +1 -1
- data/spec/models/{templatesdesccached_upload_template_document_metadata_spec.rb → upload_template_data_document_metadata_spec.rb} +7 -7
- data/spec/models/{templatesdesccached_upload_template_document_spec.rb → upload_template_data_document_spec.rb} +7 -7
- data/spec/models/{templatesdesccached_upload_template_spec.rb → upload_template_data_spec.rb} +12 -12
- data/spec/spec_helper.rb +1 -1
- metadata +50 -30
- data/docs/CreateTemplateData.md +0 -8
- data/docs/CreateTemplateData1.md +0 -8
- data/docs/TemplatesdesccachedUploadTemplateDocument.md +0 -10
data/docs/PendingTemplate.md
CHANGED
data/docs/Submission.md
CHANGED
@@ -11,12 +11,16 @@ Name | Type | Description | Notes
|
|
11
11
|
**expires_at** | **String** | | [optional]
|
12
12
|
**processed_at** | **String** | | [optional]
|
13
13
|
**state** | **String** | |
|
14
|
+
**data** | **Object** | | [optional]
|
14
15
|
**metadata** | **Object** | | [optional]
|
16
|
+
**truncated_text** | **Object** | | [optional]
|
15
17
|
**pdf_hash** | **String** | | [optional]
|
16
18
|
**download_url** | **String** | | [optional]
|
17
19
|
**permanent_download_url** | **String** | | [optional]
|
18
20
|
**batch_id** | **String** | | [optional]
|
19
21
|
**data_requests** | [**Array<SubmissionDataRequest>**](SubmissionDataRequest.md) | | [optional]
|
20
22
|
**actions** | [**Array<SubmissionAction>**](SubmissionAction.md) | | [optional]
|
23
|
+
**source** | **String** | | [optional]
|
24
|
+
**referrer** | **String** | | [optional]
|
21
25
|
|
22
26
|
|
data/docs/SubmissionBatchData.md
CHANGED
@@ -4,8 +4,8 @@
|
|
4
4
|
Name | Type | Description | Notes
|
5
5
|
------------ | ------------- | ------------- | -------------
|
6
6
|
**metadata** | **Object** | | [optional]
|
7
|
-
**test** | **BOOLEAN** | | [optional]
|
8
|
-
**template_id** | **String** | | [optional]
|
9
7
|
**submissions** | [**Array<SubmissionDataBatchRequest>**](SubmissionDataBatchRequest.md) | |
|
8
|
+
**template_id** | **String** | | [optional]
|
9
|
+
**test** | **BOOLEAN** | | [optional]
|
10
10
|
|
11
11
|
|
data/docs/SubmissionData.md
CHANGED
@@ -3,12 +3,12 @@
|
|
3
3
|
## Properties
|
4
4
|
Name | Type | Description | Notes
|
5
5
|
------------ | ------------- | ------------- | -------------
|
6
|
-
**
|
6
|
+
**css** | **String** | | [optional]
|
7
7
|
**data** | **Object** | |
|
8
|
+
**data_requests** | [**Array<CreateSubmissionDataRequestData>**](CreateSubmissionDataRequestData.md) | | [optional]
|
9
|
+
**field_overrides** | **Object** | | [optional]
|
8
10
|
**html** | **String** | | [optional]
|
9
|
-
**css** | **String** | | [optional]
|
10
11
|
**metadata** | **Object** | | [optional]
|
11
|
-
**
|
12
|
-
**data_requests** | [**Array<CreateSubmissionDataRequestData>**](CreateSubmissionDataRequestData.md) | | [optional]
|
12
|
+
**test** | **BOOLEAN** | | [optional]
|
13
13
|
|
14
14
|
|
@@ -5,9 +5,9 @@ Name | Type | Description | Notes
|
|
5
5
|
------------ | ------------- | ------------- | -------------
|
6
6
|
**css** | **String** | | [optional]
|
7
7
|
**metadata** | **Object** | | [optional]
|
8
|
-
**test** | **BOOLEAN** | | [optional]
|
9
8
|
**data** | **Object** | | [optional]
|
10
|
-
**
|
9
|
+
**test** | **BOOLEAN** | | [optional]
|
11
10
|
**html** | **String** | | [optional]
|
11
|
+
**template_id** | **String** | | [optional]
|
12
12
|
|
13
13
|
|
data/docs/Template.md
CHANGED
@@ -20,6 +20,7 @@ Name | Type | Description | Notes
|
|
20
20
|
**template_type** | **String** | | [optional]
|
21
21
|
**id** | **String** | | [optional]
|
22
22
|
**page_dimensions** | **Array<Array<Float>>** | | [optional]
|
23
|
+
**locked** | **BOOLEAN** | | [optional]
|
23
24
|
**redirect_url** | **String** | | [optional]
|
24
25
|
**document_url** | **String** | | [optional]
|
25
26
|
|
@@ -1,4 +1,4 @@
|
|
1
|
-
# DocSpring::
|
1
|
+
# DocSpring::TemplateData
|
2
2
|
|
3
3
|
## Properties
|
4
4
|
Name | Type | Description | Notes
|
@@ -6,8 +6,8 @@ Name | Type | Description | Notes
|
|
6
6
|
**expiration_interval** | **String** | | [optional]
|
7
7
|
**webhook_url** | **String** | | [optional]
|
8
8
|
**scss** | **String** | | [optional]
|
9
|
-
**expire_after** | **Float** | | [optional]
|
10
9
|
**allow_additional_properties** | **BOOLEAN** | | [optional]
|
10
|
+
**expire_after** | **Float** | | [optional]
|
11
11
|
**description** | **String** | | [optional]
|
12
12
|
**public_submissions** | **BOOLEAN** | | [optional]
|
13
13
|
**slack_webhook_url** | **String** | | [optional]
|
@@ -16,8 +16,8 @@ Name | Type | Description | Notes
|
|
16
16
|
**editable_submissions** | **BOOLEAN** | | [optional]
|
17
17
|
**expire_submissions** | **BOOLEAN** | | [optional]
|
18
18
|
**name** | **String** | | [optional]
|
19
|
-
**html** | **String** | | [optional]
|
20
19
|
**footer_html** | **String** | | [optional]
|
20
|
+
**html** | **String** | | [optional]
|
21
21
|
**redirect_url** | **String** | | [optional]
|
22
22
|
|
23
23
|
|
@@ -0,0 +1,92 @@
|
|
1
|
+
# DocSpring::TemplatestemplateIdaddFieldsFields
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**background_color_field_name** | **String** | | [optional]
|
7
|
+
**uppercase** | **BOOLEAN** | | [optional]
|
8
|
+
**metadata** | **String** | | [optional]
|
9
|
+
**barcode_symbology** | **String** | | [optional]
|
10
|
+
**min_length** | **Float** | | [optional]
|
11
|
+
**integer** | **BOOLEAN** | | [optional]
|
12
|
+
**type** | **String** | | [optional]
|
13
|
+
**required** | **BOOLEAN** | | [optional]
|
14
|
+
**comb_value_offset** | **Float** | | [optional]
|
15
|
+
**image_gravity** | **String** | | [optional]
|
16
|
+
**overflow** | **String** | | [optional]
|
17
|
+
**qrcode_color** | **String** | | [optional]
|
18
|
+
**color_field_required** | **BOOLEAN** | | [optional]
|
19
|
+
**background_color_field_required** | **BOOLEAN** | | [optional]
|
20
|
+
**id** | **Float** | | [optional]
|
21
|
+
**image_scale_type** | **String** | | [optional]
|
22
|
+
**exclusive_minimum** | **BOOLEAN** | | [optional]
|
23
|
+
**height** | **Float** | | [optional]
|
24
|
+
**number_condition_range_exclusive_max** | **BOOLEAN** | | [optional]
|
25
|
+
**invert_boolean_condition** | **BOOLEAN** | | [optional]
|
26
|
+
**shape_fill_color_field_name** | **String** | | [optional]
|
27
|
+
**static** | **BOOLEAN** | | [optional]
|
28
|
+
**shape_border_color_field_name** | **String** | | [optional]
|
29
|
+
**v_alignment** | **String** | | [optional]
|
30
|
+
**bold** | **BOOLEAN** | | [optional]
|
31
|
+
**shape_border_width** | **Float** | | [optional]
|
32
|
+
**comb_number_of_cells** | **Float** | | [optional]
|
33
|
+
**shape_border_color** | **String** | | [optional]
|
34
|
+
**comb** | **BOOLEAN** | | [optional]
|
35
|
+
**typeface** | **String** | | [optional]
|
36
|
+
**shape_type** | **String** | | [optional]
|
37
|
+
**condition** | **String** | | [optional]
|
38
|
+
**display_type** | **String** | | [optional]
|
39
|
+
**check_color** | **String** | | [optional]
|
40
|
+
**multiline_lines** | **Float** | | [optional]
|
41
|
+
**multiline** | **BOOLEAN** | | [optional]
|
42
|
+
**true_text** | **String** | | [optional]
|
43
|
+
**name** | **String** | | [optional]
|
44
|
+
**font_size** | **Float** | | [optional]
|
45
|
+
**page** | **Float** | | [optional]
|
46
|
+
**alignment** | **String** | | [optional]
|
47
|
+
**max_length** | **Float** | | [optional]
|
48
|
+
**auto_calculate_max_length** | **BOOLEAN** | | [optional]
|
49
|
+
**color_field_name** | **String** | | [optional]
|
50
|
+
**qrcode_color_field_name** | **String** | | [optional]
|
51
|
+
**number_condition_range_min** | **Float** | | [optional]
|
52
|
+
**color** | **String** | | [optional]
|
53
|
+
**hidden** | **BOOLEAN** | | [optional]
|
54
|
+
**check_color_field_required** | **BOOLEAN** | | [optional]
|
55
|
+
**combined_field_format** | **String** | | [optional]
|
56
|
+
**description** | **String** | | [optional]
|
57
|
+
**shape_border_color_field_required** | **BOOLEAN** | | [optional]
|
58
|
+
**combined_field_names** | **String** | | [optional]
|
59
|
+
**title** | **String** | | [optional]
|
60
|
+
**number_condition_range_exclusive_min** | **BOOLEAN** | | [optional]
|
61
|
+
**combined_field_separator** | **String** | | [optional]
|
62
|
+
**exclusive_maximum** | **BOOLEAN** | | [optional]
|
63
|
+
**default** | **String** | | [optional]
|
64
|
+
**combined_field_type** | **String** | | [optional]
|
65
|
+
**date_time_format** | **String** | | [optional]
|
66
|
+
**qrcode_color_field_required** | **BOOLEAN** | | [optional]
|
67
|
+
**currency** | **BOOLEAN** | | [optional]
|
68
|
+
**false_text** | **String** | | [optional]
|
69
|
+
**strikethrough** | **BOOLEAN** | | [optional]
|
70
|
+
**character_spacing** | **Float** | | [optional]
|
71
|
+
**number_condition_range_max** | **Float** | | [optional]
|
72
|
+
**background_color** | **String** | | [optional]
|
73
|
+
**check_color_field_name** | **String** | | [optional]
|
74
|
+
**check_character** | **String** | | [optional]
|
75
|
+
**rotation** | **Float** | | [optional]
|
76
|
+
**option_list** | **String** | | [optional]
|
77
|
+
**shape_fill_color** | **String** | | [optional]
|
78
|
+
**string_condition_type** | **String** | | [optional]
|
79
|
+
**shape_fill_color_field_required** | **BOOLEAN** | | [optional]
|
80
|
+
**decimal_places** | **Float** | | [optional]
|
81
|
+
**include_time** | **BOOLEAN** | | [optional]
|
82
|
+
**width** | **Float** | | [optional]
|
83
|
+
**x** | **Float** | | [optional]
|
84
|
+
**maximum** | **Float** | | [optional]
|
85
|
+
**y** | **Float** | | [optional]
|
86
|
+
**signature_allow_draw** | **BOOLEAN** | | [optional]
|
87
|
+
**number_condition_type** | **String** | | [optional]
|
88
|
+
**opacity** | **Float** | | [optional]
|
89
|
+
**minimum** | **Float** | | [optional]
|
90
|
+
**signature_allow_type** | **BOOLEAN** | | [optional]
|
91
|
+
|
92
|
+
|
@@ -3,18 +3,18 @@
|
|
3
3
|
## Properties
|
4
4
|
Name | Type | Description | Notes
|
5
5
|
------------ | ------------- | ------------- | -------------
|
6
|
-
**
|
7
|
-
**email** | **String** | | [optional]
|
8
|
-
**order** | **Integer** | | [optional]
|
9
|
-
**fields** | **Array<String>** | | [optional]
|
10
|
-
**metadata** | **Object** | | [optional]
|
11
|
-
**auth_type** | **String** | | [optional]
|
12
|
-
**auth_second_factor_type** | **String** | | [optional]
|
6
|
+
**auth_phone_number_hash** | **String** | | [optional]
|
13
7
|
**auth_provider** | **String** | | [optional]
|
14
|
-
**
|
8
|
+
**auth_second_factor_type** | **String** | | [optional]
|
15
9
|
**auth_session_id_hash** | **String** | | [optional]
|
10
|
+
**auth_session_started_at** | **String** | | [optional]
|
11
|
+
**auth_type** | **String** | | [optional]
|
16
12
|
**auth_user_id_hash** | **String** | | [optional]
|
17
13
|
**auth_username_hash** | **String** | | [optional]
|
18
|
-
**
|
14
|
+
**email** | **String** | | [optional]
|
15
|
+
**fields** | **Array<String>** | | [optional]
|
16
|
+
**metadata** | **Object** | | [optional]
|
17
|
+
**name** | **String** | | [optional]
|
18
|
+
**order** | **Integer** | | [optional]
|
19
19
|
|
20
20
|
|
data/docs/UpdateTemplateData.md
CHANGED
@@ -0,0 +1,25 @@
|
|
1
|
+
# DocSpring::UploadTemplateData
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**expiration_interval** | **String** | | [optional]
|
7
|
+
**webhook_url** | **String** | | [optional]
|
8
|
+
**scss** | **String** | | [optional]
|
9
|
+
**allow_additional_properties** | **BOOLEAN** | | [optional]
|
10
|
+
**document** | [**UploadTemplateDataDocument**](UploadTemplateDataDocument.md) | | [optional]
|
11
|
+
**expire_after** | **Float** | | [optional]
|
12
|
+
**description** | **String** | | [optional]
|
13
|
+
**public_submissions** | **BOOLEAN** | | [optional]
|
14
|
+
**slack_webhook_url** | **String** | | [optional]
|
15
|
+
**header_html** | **String** | | [optional]
|
16
|
+
**public_web_form** | **BOOLEAN** | | [optional]
|
17
|
+
**editable_submissions** | **BOOLEAN** | | [optional]
|
18
|
+
**expire_submissions** | **BOOLEAN** | | [optional]
|
19
|
+
**name** | **String** | | [optional]
|
20
|
+
**footer_html** | **String** | | [optional]
|
21
|
+
**html** | **String** | | [optional]
|
22
|
+
**template_type** | **String** | | [optional]
|
23
|
+
**redirect_url** | **String** | | [optional]
|
24
|
+
|
25
|
+
|
@@ -0,0 +1,10 @@
|
|
1
|
+
# DocSpring::UploadTemplateDataDocument
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**metadata** | [**UploadTemplateDataDocumentMetadata**](UploadTemplateDataDocumentMetadata.md) | | [optional]
|
7
|
+
**id** | **String** | | [optional]
|
8
|
+
**storage** | **String** | | [optional]
|
9
|
+
|
10
|
+
|
data/docspring.gemspec
CHANGED
@@ -8,7 +8,7 @@
|
|
8
8
|
OpenAPI spec version: v1
|
9
9
|
|
10
10
|
Generated by: https://openapi-generator.tech
|
11
|
-
OpenAPI Generator version: 3.3.0
|
11
|
+
OpenAPI Generator version: 3.3.0
|
12
12
|
|
13
13
|
=end
|
14
14
|
|
@@ -19,7 +19,7 @@ Gem::Specification.new do |s|
|
|
19
19
|
s.name = "docspring"
|
20
20
|
s.version = DocSpring::VERSION
|
21
21
|
s.platform = Gem::Platform::RUBY
|
22
|
-
s.authors = ["
|
22
|
+
s.authors = ["DocSpring"]
|
23
23
|
s.email = ["support@docspring.com"]
|
24
24
|
s.homepage = "https://github.com/DocSpring/docspring-ruby"
|
25
25
|
s.summary = "DocSpring API Client"
|
data/lib/docspring.rb
CHANGED
@@ -6,7 +6,7 @@
|
|
6
6
|
OpenAPI spec version: v1
|
7
7
|
|
8
8
|
Generated by: https://openapi-generator.tech
|
9
|
-
OpenAPI Generator version: 3.3.0
|
9
|
+
OpenAPI Generator version: 3.3.0
|
10
10
|
|
11
11
|
=end
|
12
12
|
|
@@ -17,28 +17,32 @@ require 'docspring/version'
|
|
17
17
|
require 'docspring/configuration'
|
18
18
|
|
19
19
|
# Models
|
20
|
+
require 'docspring/models/add_fields_data'
|
21
|
+
require 'docspring/models/add_fields_template_response'
|
20
22
|
require 'docspring/models/authentication_error'
|
21
23
|
require 'docspring/models/authentication_success_response'
|
22
24
|
require 'docspring/models/combine_pdfs_data'
|
23
25
|
require 'docspring/models/combined_submission'
|
24
26
|
require 'docspring/models/combined_submission_action'
|
25
27
|
require 'docspring/models/combined_submission_data'
|
28
|
+
require 'docspring/models/copy_template_data'
|
26
29
|
require 'docspring/models/create_combined_submission_response'
|
27
30
|
require 'docspring/models/create_custom_file_data'
|
28
31
|
require 'docspring/models/create_custom_file_response'
|
29
32
|
require 'docspring/models/create_folder_data'
|
33
|
+
require 'docspring/models/create_html_template_data'
|
30
34
|
require 'docspring/models/create_submission_batch_response'
|
31
35
|
require 'docspring/models/create_submission_batch_submissions_response'
|
32
36
|
require 'docspring/models/create_submission_data_request_data'
|
33
37
|
require 'docspring/models/create_submission_data_request_token_response'
|
34
38
|
require 'docspring/models/create_submission_data_request_token_response_token'
|
35
39
|
require 'docspring/models/create_submission_response'
|
36
|
-
require 'docspring/models/
|
37
|
-
require 'docspring/models/create_template_data1'
|
40
|
+
require 'docspring/models/create_template_from_upload_data'
|
38
41
|
require 'docspring/models/custom_file'
|
39
42
|
require 'docspring/models/error'
|
40
43
|
require 'docspring/models/folder'
|
41
44
|
require 'docspring/models/folders_folder'
|
45
|
+
require 'docspring/models/html_template_data'
|
42
46
|
require 'docspring/models/invalid_request'
|
43
47
|
require 'docspring/models/move_folder_data'
|
44
48
|
require 'docspring/models/move_template_data'
|
@@ -52,14 +56,15 @@ require 'docspring/models/submission_data'
|
|
52
56
|
require 'docspring/models/submission_data_batch_request'
|
53
57
|
require 'docspring/models/submission_data_request'
|
54
58
|
require 'docspring/models/template'
|
55
|
-
require 'docspring/models/
|
56
|
-
require 'docspring/models/
|
57
|
-
require 'docspring/models/templatesdesccached_upload_template_document_metadata'
|
58
|
-
require 'docspring/models/templatestemplate_id_template'
|
59
|
+
require 'docspring/models/template_data'
|
60
|
+
require 'docspring/models/templatestemplate_idadd_fields_fields'
|
59
61
|
require 'docspring/models/update_data_request_response'
|
60
62
|
require 'docspring/models/update_submission_data_request_data'
|
61
63
|
require 'docspring/models/update_template_data'
|
62
64
|
require 'docspring/models/update_template_response'
|
65
|
+
require 'docspring/models/upload_template_data'
|
66
|
+
require 'docspring/models/upload_template_data_document'
|
67
|
+
require 'docspring/models/upload_template_data_document_metadata'
|
63
68
|
|
64
69
|
# APIs
|
65
70
|
require 'docspring/api/pdf_api'
|
@@ -6,7 +6,7 @@
|
|
6
6
|
OpenAPI spec version: v1
|
7
7
|
|
8
8
|
Generated by: https://openapi-generator.tech
|
9
|
-
OpenAPI Generator version: 3.3.0
|
9
|
+
OpenAPI Generator version: 3.3.0
|
10
10
|
|
11
11
|
=end
|
12
12
|
|
@@ -19,6 +19,65 @@ module DocSpring
|
|
19
19
|
def initialize(api_client = ApiClient.default)
|
20
20
|
@api_client = api_client
|
21
21
|
end
|
22
|
+
# Add new fields to a Template
|
23
|
+
# @param template_id
|
24
|
+
# @param add_fields_data
|
25
|
+
# @param [Hash] opts the optional parameters
|
26
|
+
# @return [AddFieldsTemplateResponse]
|
27
|
+
def add_fields_to_template(template_id, add_fields_data, opts = {})
|
28
|
+
data, _status_code, _headers = add_fields_to_template_with_http_info(template_id, add_fields_data, opts)
|
29
|
+
data
|
30
|
+
end
|
31
|
+
|
32
|
+
# Add new fields to a Template
|
33
|
+
# @param template_id
|
34
|
+
# @param add_fields_data
|
35
|
+
# @param [Hash] opts the optional parameters
|
36
|
+
# @return [Array<(AddFieldsTemplateResponse, Fixnum, Hash)>] AddFieldsTemplateResponse data, response status code and response headers
|
37
|
+
def add_fields_to_template_with_http_info(template_id, add_fields_data, opts = {})
|
38
|
+
if @api_client.config.debugging
|
39
|
+
@api_client.config.logger.debug 'Calling API: PDFApi.add_fields_to_template ...'
|
40
|
+
end
|
41
|
+
# verify the required parameter 'template_id' is set
|
42
|
+
if @api_client.config.client_side_validation && template_id.nil?
|
43
|
+
fail ArgumentError, "Missing the required parameter 'template_id' when calling PDFApi.add_fields_to_template"
|
44
|
+
end
|
45
|
+
# verify the required parameter 'add_fields_data' is set
|
46
|
+
if @api_client.config.client_side_validation && add_fields_data.nil?
|
47
|
+
fail ArgumentError, "Missing the required parameter 'add_fields_data' when calling PDFApi.add_fields_to_template"
|
48
|
+
end
|
49
|
+
# resource path
|
50
|
+
local_var_path = '/templates/{template_id}/add_fields'.sub('{' + 'template_id' + '}', template_id.to_s)
|
51
|
+
|
52
|
+
# query parameters
|
53
|
+
query_params = {}
|
54
|
+
|
55
|
+
# header parameters
|
56
|
+
header_params = {}
|
57
|
+
# HTTP header 'Accept' (if needed)
|
58
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
59
|
+
# HTTP header 'Content-Type'
|
60
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
61
|
+
|
62
|
+
# form parameters
|
63
|
+
form_params = {}
|
64
|
+
|
65
|
+
# http body (model)
|
66
|
+
post_body = @api_client.object_to_http_body(add_fields_data)
|
67
|
+
auth_names = ['api_token_basic']
|
68
|
+
data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
|
69
|
+
:header_params => header_params,
|
70
|
+
:query_params => query_params,
|
71
|
+
:form_params => form_params,
|
72
|
+
:body => post_body,
|
73
|
+
:auth_names => auth_names,
|
74
|
+
:return_type => 'AddFieldsTemplateResponse')
|
75
|
+
if @api_client.config.debugging
|
76
|
+
@api_client.config.logger.debug "API called: PDFApi#add_fields_to_template\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
77
|
+
end
|
78
|
+
return data, status_code, headers
|
79
|
+
end
|
80
|
+
|
22
81
|
# Generates multiple PDFs
|
23
82
|
# @param template_id
|
24
83
|
# @param request_body
|
@@ -237,6 +296,65 @@ module DocSpring
|
|
237
296
|
return data, status_code, headers
|
238
297
|
end
|
239
298
|
|
299
|
+
# Copy a Template
|
300
|
+
# @param template_id
|
301
|
+
# @param copy_template_data
|
302
|
+
# @param [Hash] opts the optional parameters
|
303
|
+
# @return [Template]
|
304
|
+
def copy_template(template_id, copy_template_data, opts = {})
|
305
|
+
data, _status_code, _headers = copy_template_with_http_info(template_id, copy_template_data, opts)
|
306
|
+
data
|
307
|
+
end
|
308
|
+
|
309
|
+
# Copy a Template
|
310
|
+
# @param template_id
|
311
|
+
# @param copy_template_data
|
312
|
+
# @param [Hash] opts the optional parameters
|
313
|
+
# @return [Array<(Template, Fixnum, Hash)>] Template data, response status code and response headers
|
314
|
+
def copy_template_with_http_info(template_id, copy_template_data, opts = {})
|
315
|
+
if @api_client.config.debugging
|
316
|
+
@api_client.config.logger.debug 'Calling API: PDFApi.copy_template ...'
|
317
|
+
end
|
318
|
+
# verify the required parameter 'template_id' is set
|
319
|
+
if @api_client.config.client_side_validation && template_id.nil?
|
320
|
+
fail ArgumentError, "Missing the required parameter 'template_id' when calling PDFApi.copy_template"
|
321
|
+
end
|
322
|
+
# verify the required parameter 'copy_template_data' is set
|
323
|
+
if @api_client.config.client_side_validation && copy_template_data.nil?
|
324
|
+
fail ArgumentError, "Missing the required parameter 'copy_template_data' when calling PDFApi.copy_template"
|
325
|
+
end
|
326
|
+
# resource path
|
327
|
+
local_var_path = '/templates/{template_id}/copy'.sub('{' + 'template_id' + '}', template_id.to_s)
|
328
|
+
|
329
|
+
# query parameters
|
330
|
+
query_params = {}
|
331
|
+
|
332
|
+
# header parameters
|
333
|
+
header_params = {}
|
334
|
+
# HTTP header 'Accept' (if needed)
|
335
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
336
|
+
# HTTP header 'Content-Type'
|
337
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
338
|
+
|
339
|
+
# form parameters
|
340
|
+
form_params = {}
|
341
|
+
|
342
|
+
# http body (model)
|
343
|
+
post_body = @api_client.object_to_http_body(copy_template_data)
|
344
|
+
auth_names = ['api_token_basic']
|
345
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path,
|
346
|
+
:header_params => header_params,
|
347
|
+
:query_params => query_params,
|
348
|
+
:form_params => form_params,
|
349
|
+
:body => post_body,
|
350
|
+
:auth_names => auth_names,
|
351
|
+
:return_type => 'Template')
|
352
|
+
if @api_client.config.debugging
|
353
|
+
@api_client.config.logger.debug "API called: PDFApi#copy_template\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
354
|
+
end
|
355
|
+
return data, status_code, headers
|
356
|
+
end
|
357
|
+
|
240
358
|
# Create a new custom file from a cached presign upload
|
241
359
|
# @param create_custom_file_data
|
242
360
|
# @param [Hash] opts the optional parameters
|
@@ -395,25 +513,25 @@ module DocSpring
|
|
395
513
|
end
|
396
514
|
|
397
515
|
# Create a new HTML template
|
398
|
-
# @param
|
516
|
+
# @param create_html_template_data
|
399
517
|
# @param [Hash] opts the optional parameters
|
400
518
|
# @return [PendingTemplate]
|
401
|
-
def create_html_template(
|
402
|
-
data, _status_code, _headers = create_html_template_with_http_info(
|
519
|
+
def create_html_template(create_html_template_data, opts = {})
|
520
|
+
data, _status_code, _headers = create_html_template_with_http_info(create_html_template_data, opts)
|
403
521
|
data
|
404
522
|
end
|
405
523
|
|
406
524
|
# Create a new HTML template
|
407
|
-
# @param
|
525
|
+
# @param create_html_template_data
|
408
526
|
# @param [Hash] opts the optional parameters
|
409
527
|
# @return [Array<(PendingTemplate, Fixnum, Hash)>] PendingTemplate data, response status code and response headers
|
410
|
-
def create_html_template_with_http_info(
|
528
|
+
def create_html_template_with_http_info(create_html_template_data, opts = {})
|
411
529
|
if @api_client.config.debugging
|
412
530
|
@api_client.config.logger.debug 'Calling API: PDFApi.create_html_template ...'
|
413
531
|
end
|
414
|
-
# verify the required parameter '
|
415
|
-
if @api_client.config.client_side_validation &&
|
416
|
-
fail ArgumentError, "Missing the required parameter '
|
532
|
+
# verify the required parameter 'create_html_template_data' is set
|
533
|
+
if @api_client.config.client_side_validation && create_html_template_data.nil?
|
534
|
+
fail ArgumentError, "Missing the required parameter 'create_html_template_data' when calling PDFApi.create_html_template"
|
417
535
|
end
|
418
536
|
# resource path
|
419
537
|
local_var_path = '/templates?desc=html'
|
@@ -432,7 +550,7 @@ module DocSpring
|
|
432
550
|
form_params = {}
|
433
551
|
|
434
552
|
# http body (model)
|
435
|
-
post_body = @api_client.object_to_http_body(
|
553
|
+
post_body = @api_client.object_to_http_body(create_html_template_data)
|
436
554
|
auth_names = ['api_token_basic']
|
437
555
|
data, status_code, headers = @api_client.call_api(:POST, local_var_path,
|
438
556
|
:header_params => header_params,
|
@@ -512,25 +630,25 @@ module DocSpring
|
|
512
630
|
end
|
513
631
|
|
514
632
|
# Create a new PDF template from a cached presign upload
|
515
|
-
# @param
|
633
|
+
# @param create_template_from_upload_data
|
516
634
|
# @param [Hash] opts the optional parameters
|
517
635
|
# @return [PendingTemplate]
|
518
|
-
def create_pdf_template_from_upload(
|
519
|
-
data, _status_code, _headers = create_pdf_template_from_upload_with_http_info(
|
636
|
+
def create_pdf_template_from_upload(create_template_from_upload_data, opts = {})
|
637
|
+
data, _status_code, _headers = create_pdf_template_from_upload_with_http_info(create_template_from_upload_data, opts)
|
520
638
|
data
|
521
639
|
end
|
522
640
|
|
523
641
|
# Create a new PDF template from a cached presign upload
|
524
|
-
# @param
|
642
|
+
# @param create_template_from_upload_data
|
525
643
|
# @param [Hash] opts the optional parameters
|
526
644
|
# @return [Array<(PendingTemplate, Fixnum, Hash)>] PendingTemplate data, response status code and response headers
|
527
|
-
def create_pdf_template_from_upload_with_http_info(
|
645
|
+
def create_pdf_template_from_upload_with_http_info(create_template_from_upload_data, opts = {})
|
528
646
|
if @api_client.config.debugging
|
529
647
|
@api_client.config.logger.debug 'Calling API: PDFApi.create_pdf_template_from_upload ...'
|
530
648
|
end
|
531
|
-
# verify the required parameter '
|
532
|
-
if @api_client.config.client_side_validation &&
|
533
|
-
fail ArgumentError, "Missing the required parameter '
|
649
|
+
# verify the required parameter 'create_template_from_upload_data' is set
|
650
|
+
if @api_client.config.client_side_validation && create_template_from_upload_data.nil?
|
651
|
+
fail ArgumentError, "Missing the required parameter 'create_template_from_upload_data' when calling PDFApi.create_pdf_template_from_upload"
|
534
652
|
end
|
535
653
|
# resource path
|
536
654
|
local_var_path = '/templates?desc=cached_upload'
|
@@ -549,7 +667,7 @@ module DocSpring
|
|
549
667
|
form_params = {}
|
550
668
|
|
551
669
|
# http body (model)
|
552
|
-
post_body = @api_client.object_to_http_body(
|
670
|
+
post_body = @api_client.object_to_http_body(create_template_from_upload_data)
|
553
671
|
auth_names = ['api_token_basic']
|
554
672
|
data, status_code, headers = @api_client.call_api(:POST, local_var_path,
|
555
673
|
:header_params => header_params,
|