docspring 1.3.0 → 1.4.1

Sign up to get free protection for your applications and to get access to all the features.
Files changed (44) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +16 -0
  3. data/Gemfile.lock +3 -8
  4. data/LICENSE +1 -1
  5. data/README.md +13 -5
  6. data/docs/CombinePdfsData.md +1 -0
  7. data/docs/CombinedSubmission.md +1 -0
  8. data/docs/CombinedSubmissionData.md +1 -0
  9. data/docs/CopyTemplateData.md +9 -0
  10. data/docs/ListSubmissionsResponse.md +10 -0
  11. data/docs/MoveTemplateData.md +1 -1
  12. data/docs/PDFApi.md +232 -4
  13. data/docs/SubmissionData.md +1 -0
  14. data/docs/SubmissionDataRequest.md +1 -0
  15. data/docs/Template1.md +46 -0
  16. data/docs/Template1Defaults.md +10 -0
  17. data/docspring.gemspec +1 -2
  18. data/lib/docspring/api/pdf_api.rb +244 -2
  19. data/lib/docspring/api_client.rb +1 -1
  20. data/lib/docspring/configuration.rb +1 -2
  21. data/lib/docspring/models/combine_pdfs_data.rb +10 -1
  22. data/lib/docspring/models/combined_submission.rb +10 -1
  23. data/lib/docspring/models/combined_submission_data.rb +10 -1
  24. data/lib/docspring/models/copy_template_data.rb +197 -0
  25. data/lib/docspring/models/list_submissions_response.rb +203 -0
  26. data/lib/docspring/models/move_template_data.rb +5 -0
  27. data/lib/docspring/models/submission_data.rb +10 -1
  28. data/lib/docspring/models/submission_data_request.rb +15 -1
  29. data/lib/docspring/models/template1.rb +565 -0
  30. data/lib/docspring/models/template1_defaults.rb +201 -0
  31. data/lib/docspring/version.rb +1 -1
  32. data/lib/docspring.rb +4 -0
  33. data/spec/api/client_integration_spec.rb +1 -1
  34. data/spec/api/pdf_api_spec_original.skipped.rb +78 -2
  35. data/spec/models/combine_pdfs_data_spec.rb +6 -0
  36. data/spec/models/combined_submission_data_spec.rb +6 -0
  37. data/spec/models/combined_submission_spec.rb +6 -0
  38. data/spec/models/copy_template_data_spec.rb +47 -0
  39. data/spec/models/list_submissions_response_spec.rb +53 -0
  40. data/spec/models/submission_data_request_spec.rb +6 -0
  41. data/spec/models/submission_data_spec.rb +6 -0
  42. data/spec/models/template1_defaults_spec.rb +53 -0
  43. data/spec/models/template1_spec.rb +273 -0
  44. metadata +23 -27
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 5dad40afca68243b35255c0aac23fb07117f050fc0e269d17c4b04044275ede6
4
- data.tar.gz: 1c8e7586b637dcef57e8cf7f3040e6ec3f130211cb355059463b86f56467531f
3
+ metadata.gz: 2aa2757c50c27c3591eb99e17b2ecc5da96139752b6b835f7ce220901be4d0b9
4
+ data.tar.gz: 30eb05f3677c4fa80aca25216d33231347d94ef301c9a76b44d593a195089eac
5
5
  SHA512:
6
- metadata.gz: 48bcefb591a19ce9abf213be441cc398091040552f505991cc9b262d6a13b6c8587b0130a24472c1030d23ce767ccd72a4a6d52ec40e73a9633402cf4779f766
7
- data.tar.gz: 5a8af6f0121031e3e9d7089a7ef95541956dd01cc75364899923bc57bf4d0415f8dd1e5fb8094c9239b1128c92bf67ef8e51209e4fb4ef38543edbca05530283
6
+ metadata.gz: d0ed063dc65587713433df12884e85d7d3af152e1f5d4d61f8b11c02d1dccbe41ba78907251cbab86f41ccc812eb37829715680c116d6bd075cc78a385d1e5ab
7
+ data.tar.gz: 65632654aa83bdb60abab40c3be6330f4e4c520d900ae70e45c693b2cdd528fbef44e2406baab3854eb6b2a4bcab4f2fbe8a37b3ad1c11f259b8736b09a77397
data/CHANGELOG.md CHANGED
@@ -1,3 +1,19 @@
1
+ ### 1.4.1 [November 28, 2021]
2
+
3
+ - Added 'password' parameter to Generate PDF and Combine PDF API endpoints. You can now encrypt each generated PDF with a unique password.
4
+
5
+ ### 1.4.0 [May 21, 2021]
6
+
7
+ - Fix URI.escape deprecation warning for Ruby 2.7.0
8
+
9
+ ### 1.3.2 [November 19, 2020]
10
+
11
+ - Added "sort_order" property for Submission Data Requests
12
+
13
+ ### 1.3.1 [September 27, 2020]
14
+
15
+ - Changed gem author to DocSpring
16
+
1
17
  ### 1.3.0 [September 26, 2020]
2
18
 
3
19
  - Updated OpenAPI Generator to v3.3.0
data/Gemfile.lock CHANGED
@@ -1,7 +1,7 @@
1
1
  PATH
2
2
  remote: .
3
3
  specs:
4
- docspring (1.3.0)
4
+ docspring (1.4.1)
5
5
  ffi (~> 1.0, >= 1.9.24)
6
6
  json (>= 1.8)
7
7
  typhoeus (~> 1.0, >= 1.0.1)
@@ -10,12 +10,10 @@ GEM
10
10
  remote: https://rubygems.org/
11
11
  specs:
12
12
  ZenTest (4.12.0)
13
- addressable (2.7.0)
13
+ addressable (2.8.0)
14
14
  public_suffix (>= 2.0.2, < 5.0)
15
15
  autotest (4.4.6)
16
16
  ZenTest (>= 4.4.1)
17
- autotest-fsevent (0.2.15)
18
- sys-uname
19
17
  autotest-growl (0.2.16)
20
18
  autotest-rails-pure (4.1.2)
21
19
  bundler-audit (0.6.1)
@@ -54,8 +52,6 @@ GEM
54
52
  rspec-support (~> 3.9.0)
55
53
  rspec-support (3.9.2)
56
54
  safe_yaml (1.0.5)
57
- sys-uname (1.2.0)
58
- ffi (>= 1.0.0)
59
55
  thor (0.20.3)
60
56
  typhoeus (1.3.1)
61
57
  ethon (>= 0.9.0)
@@ -70,7 +66,6 @@ PLATFORMS
70
66
 
71
67
  DEPENDENCIES
72
68
  autotest (~> 4.4, >= 4.4.6)
73
- autotest-fsevent (~> 0.2, >= 0.2.15)
74
69
  autotest-growl (~> 0.2, >= 0.2.16)
75
70
  autotest-rails-pure (~> 4.1, >= 4.1.2)
76
71
  bundler-audit
@@ -82,4 +77,4 @@ DEPENDENCIES
82
77
  webmock (~> 1.24, >= 1.24.3)
83
78
 
84
79
  BUNDLED WITH
85
- 2.1.4
80
+ 2.2.29
data/LICENSE CHANGED
@@ -1,4 +1,4 @@
1
- Copyright © 2018 Form Applications Inc.
1
+ Copyright © 2018-2020 DocSpring, Inc.
2
2
 
3
3
  Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
4
4
 
data/README.md CHANGED
@@ -7,7 +7,7 @@ DocSpring is a service that helps you fill out and sign PDF templates.
7
7
  This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
8
8
 
9
9
  - API version: v1
10
- - Package version: 1.3.0
10
+ - Package version: 1.4.1
11
11
  - Build package: com.docspring.codegen.DocSpringRubyClientCodegen
12
12
 
13
13
  ## Installation
@@ -23,15 +23,15 @@ gem build docspring.gemspec
23
23
  Then either install the gem locally:
24
24
 
25
25
  ```shell
26
- gem install ./docspring-1.3.0.gem
26
+ gem install ./docspring-1.4.1.gem
27
27
  ```
28
- (for development, run `gem install --dev ./docspring-1.3.0.gem` to install the development dependencies)
28
+ (for development, run `gem install --dev ./docspring-1.4.1.gem` to install the development dependencies)
29
29
 
30
30
  or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
31
31
 
32
32
  Finally add this to the Gemfile:
33
33
 
34
- gem 'docspring', '~> 1.3.0'
34
+ gem 'docspring', '~> 1.4.1'
35
35
 
36
36
  ### Install from Git
37
37
 
@@ -86,6 +86,7 @@ Class | Method | HTTP request | Description
86
86
  *DocSpring::PDFApi* | [**batch_generate_pdfs**](docs/PDFApi.md#batch_generate_pdfs) | **POST** /submissions/batches | Generates multiple PDFs
87
87
  *DocSpring::PDFApi* | [**combine_pdfs**](docs/PDFApi.md#combine_pdfs) | **POST** /combined_submissions?v&#x3D;2 | Merge submission PDFs, template PDFs, or custom files
88
88
  *DocSpring::PDFApi* | [**combine_submissions**](docs/PDFApi.md#combine_submissions) | **POST** /combined_submissions | Merge generated PDFs together
89
+ *DocSpring::PDFApi* | [**copy_template**](docs/PDFApi.md#copy_template) | **POST** /templates/{template_id}/copy | Copy a Template
89
90
  *DocSpring::PDFApi* | [**create_custom_file_from_upload**](docs/PDFApi.md#create_custom_file_from_upload) | **POST** /custom_files | Create a new custom file from a cached presign upload
90
91
  *DocSpring::PDFApi* | [**create_data_request_token**](docs/PDFApi.md#create_data_request_token) | **POST** /data_requests/{data_request_id}/tokens | Creates a new data request token for form authentication
91
92
  *DocSpring::PDFApi* | [**create_folder**](docs/PDFApi.md#create_folder) | **POST** /folders/ | Create a folder
@@ -98,12 +99,15 @@ Class | Method | HTTP request | Description
98
99
  *DocSpring::PDFApi* | [**generate_pdf**](docs/PDFApi.md#generate_pdf) | **POST** /templates/{template_id}/submissions | Generates a new PDF
99
100
  *DocSpring::PDFApi* | [**get_combined_submission**](docs/PDFApi.md#get_combined_submission) | **GET** /combined_submissions/{combined_submission_id} | Check the status of a combined submission (merged PDFs)
100
101
  *DocSpring::PDFApi* | [**get_data_request**](docs/PDFApi.md#get_data_request) | **GET** /data_requests/{data_request_id} | Look up a submission data request
102
+ *DocSpring::PDFApi* | [**get_full_template**](docs/PDFApi.md#get_full_template) | **GET** /templates/{template_id}?full&#x3D;true | Fetch the full template attributes
101
103
  *DocSpring::PDFApi* | [**get_presign_url**](docs/PDFApi.md#get_presign_url) | **GET** /uploads/presign | Get a presigned URL so that you can upload a file to our AWS S3 bucket
102
104
  *DocSpring::PDFApi* | [**get_submission**](docs/PDFApi.md#get_submission) | **GET** /submissions/{submission_id} | Check the status of a PDF
103
105
  *DocSpring::PDFApi* | [**get_submission_batch**](docs/PDFApi.md#get_submission_batch) | **GET** /submissions/batches/{submission_batch_id} | Check the status of a submission batch job
104
- *DocSpring::PDFApi* | [**get_template**](docs/PDFApi.md#get_template) | **GET** /templates/{template_id} | Get a single template
106
+ *DocSpring::PDFApi* | [**get_template**](docs/PDFApi.md#get_template) | **GET** /templates/{template_id} | Check the status of an uploaded template
105
107
  *DocSpring::PDFApi* | [**get_template_schema**](docs/PDFApi.md#get_template_schema) | **GET** /templates/{template_id}/schema | Fetch the JSON schema for a template
106
108
  *DocSpring::PDFApi* | [**list_folders**](docs/PDFApi.md#list_folders) | **GET** /folders/ | Get a list of all folders
109
+ *DocSpring::PDFApi* | [**list_submissions**](docs/PDFApi.md#list_submissions) | **GET** /submissions | List all submissions
110
+ *DocSpring::PDFApi* | [**list_submissions_0**](docs/PDFApi.md#list_submissions_0) | **GET** /templates/{template_id}/submissions | List all submissions for a given template
107
111
  *DocSpring::PDFApi* | [**list_templates**](docs/PDFApi.md#list_templates) | **GET** /templates | Get a list of all templates
108
112
  *DocSpring::PDFApi* | [**move_folder_to_folder**](docs/PDFApi.md#move_folder_to_folder) | **POST** /folders/{folder_id}/move | Move a folder
109
113
  *DocSpring::PDFApi* | [**move_template_to_folder**](docs/PDFApi.md#move_template_to_folder) | **POST** /templates/{template_id}/move | Move Template to folder
@@ -123,6 +127,7 @@ Class | Method | HTTP request | Description
123
127
  - [DocSpring::CombinedSubmission](docs/CombinedSubmission.md)
124
128
  - [DocSpring::CombinedSubmissionAction](docs/CombinedSubmissionAction.md)
125
129
  - [DocSpring::CombinedSubmissionData](docs/CombinedSubmissionData.md)
130
+ - [DocSpring::CopyTemplateData](docs/CopyTemplateData.md)
126
131
  - [DocSpring::CreateCombinedSubmissionResponse](docs/CreateCombinedSubmissionResponse.md)
127
132
  - [DocSpring::CreateCustomFileData](docs/CreateCustomFileData.md)
128
133
  - [DocSpring::CreateCustomFileResponse](docs/CreateCustomFileResponse.md)
@@ -141,6 +146,7 @@ Class | Method | HTTP request | Description
141
146
  - [DocSpring::FoldersFolder](docs/FoldersFolder.md)
142
147
  - [DocSpring::HtmlTemplateData](docs/HtmlTemplateData.md)
143
148
  - [DocSpring::InvalidRequest](docs/InvalidRequest.md)
149
+ - [DocSpring::ListSubmissionsResponse](docs/ListSubmissionsResponse.md)
144
150
  - [DocSpring::MoveFolderData](docs/MoveFolderData.md)
145
151
  - [DocSpring::MoveTemplateData](docs/MoveTemplateData.md)
146
152
  - [DocSpring::PendingTemplate](docs/PendingTemplate.md)
@@ -153,6 +159,8 @@ Class | Method | HTTP request | Description
153
159
  - [DocSpring::SubmissionDataBatchRequest](docs/SubmissionDataBatchRequest.md)
154
160
  - [DocSpring::SubmissionDataRequest](docs/SubmissionDataRequest.md)
155
161
  - [DocSpring::Template](docs/Template.md)
162
+ - [DocSpring::Template1](docs/Template1.md)
163
+ - [DocSpring::Template1Defaults](docs/Template1Defaults.md)
156
164
  - [DocSpring::TemplateData](docs/TemplateData.md)
157
165
  - [DocSpring::TemplatestemplateIdaddFieldsFields](docs/TemplatestemplateIdaddFieldsFields.md)
158
166
  - [DocSpring::UpdateDataRequestResponse](docs/UpdateDataRequestResponse.md)
@@ -6,6 +6,7 @@ Name | Type | Description | Notes
6
6
  **delete_custom_files** | **BOOLEAN** | | [optional]
7
7
  **expires_in** | **Integer** | | [optional]
8
8
  **metadata** | **Object** | | [optional]
9
+ **password** | **String** | | [optional]
9
10
  **source_pdfs** | **Array&lt;Object&gt;** | |
10
11
  **test** | **BOOLEAN** | | [optional]
11
12
 
@@ -4,6 +4,7 @@
4
4
  Name | Type | Description | Notes
5
5
  ------------ | ------------- | ------------- | -------------
6
6
  **metadata** | **Object** | | [optional]
7
+ **password** | **String** | | [optional]
7
8
  **expired** | **BOOLEAN** | | [optional]
8
9
  **expires_at** | **String** | | [optional]
9
10
  **source_pdfs** | **Array&lt;Object&gt;** | | [optional]
@@ -5,6 +5,7 @@ Name | Type | Description | Notes
5
5
  ------------ | ------------- | ------------- | -------------
6
6
  **expires_in** | **Integer** | | [optional]
7
7
  **metadata** | **Object** | | [optional]
8
+ **password** | **String** | | [optional]
8
9
  **submission_ids** | **Array&lt;String&gt;** | |
9
10
  **test** | **BOOLEAN** | | [optional]
10
11
 
@@ -0,0 +1,9 @@
1
+ # DocSpring::CopyTemplateData
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **name** | **String** | | [optional]
7
+ **parent_folder_id** | **String** | |
8
+
9
+
@@ -0,0 +1,10 @@
1
+ # DocSpring::ListSubmissionsResponse
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **next_cursor** | **String** | | [optional]
7
+ **submissions** | [**Array&lt;Submission&gt;**](Submission.md) | | [optional]
8
+ **limit** | **Float** | | [optional]
9
+
10
+
@@ -3,6 +3,6 @@
3
3
  ## Properties
4
4
  Name | Type | Description | Notes
5
5
  ------------ | ------------- | ------------- | -------------
6
- **parent_folder_id** | **String** | | [optional]
6
+ **parent_folder_id** | **String** | |
7
7
 
8
8
 
data/docs/PDFApi.md CHANGED
@@ -9,6 +9,7 @@ Method | HTTP request | Description
9
9
  [**batch_generate_pdfs**](PDFApi.md#batch_generate_pdfs) | **POST** /submissions/batches | Generates multiple PDFs
10
10
  [**combine_pdfs**](PDFApi.md#combine_pdfs) | **POST** /combined_submissions?v&#x3D;2 | Merge submission PDFs, template PDFs, or custom files
11
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
12
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
13
14
  [**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
14
15
  [**create_folder**](PDFApi.md#create_folder) | **POST** /folders/ | Create a folder
@@ -21,12 +22,15 @@ Method | HTTP request | Description
21
22
  [**generate_pdf**](PDFApi.md#generate_pdf) | **POST** /templates/{template_id}/submissions | Generates a new PDF
22
23
  [**get_combined_submission**](PDFApi.md#get_combined_submission) | **GET** /combined_submissions/{combined_submission_id} | Check the status of a combined submission (merged PDFs)
23
24
  [**get_data_request**](PDFApi.md#get_data_request) | **GET** /data_requests/{data_request_id} | Look up a submission data request
25
+ [**get_full_template**](PDFApi.md#get_full_template) | **GET** /templates/{template_id}?full&#x3D;true | Fetch the full template attributes
24
26
  [**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
25
27
  [**get_submission**](PDFApi.md#get_submission) | **GET** /submissions/{submission_id} | Check the status of a PDF
26
28
  [**get_submission_batch**](PDFApi.md#get_submission_batch) | **GET** /submissions/batches/{submission_batch_id} | Check the status of a submission batch job
27
- [**get_template**](PDFApi.md#get_template) | **GET** /templates/{template_id} | Get a single template
29
+ [**get_template**](PDFApi.md#get_template) | **GET** /templates/{template_id} | Check the status of an uploaded template
28
30
  [**get_template_schema**](PDFApi.md#get_template_schema) | **GET** /templates/{template_id}/schema | Fetch the JSON schema for a template
29
31
  [**list_folders**](PDFApi.md#list_folders) | **GET** /folders/ | Get a list of all folders
32
+ [**list_submissions**](PDFApi.md#list_submissions) | **GET** /submissions | List all submissions
33
+ [**list_submissions_0**](PDFApi.md#list_submissions_0) | **GET** /templates/{template_id}/submissions | List all submissions for a given template
30
34
  [**list_templates**](PDFApi.md#list_templates) | **GET** /templates | Get a list of all templates
31
35
  [**move_folder_to_folder**](PDFApi.md#move_folder_to_folder) | **POST** /folders/{folder_id}/move | Move a folder
32
36
  [**move_template_to_folder**](PDFApi.md#move_template_to_folder) | **POST** /templates/{template_id}/move | Move Template to folder
@@ -285,6 +289,57 @@ Name | Type | Description | Notes
285
289
 
286
290
 
287
291
 
292
+ # **copy_template**
293
+ > Template copy_template(template_id, copy_template_data)
294
+
295
+ Copy a Template
296
+
297
+ ### Example
298
+ ```ruby
299
+ # load the gem
300
+ require 'docspring'
301
+ # setup authorization
302
+ DocSpring.configure do |config|
303
+ # Configure HTTP basic authorization: api_token_basic
304
+ config.username = 'YOUR USERNAME'
305
+ config.password = 'YOUR PASSWORD'
306
+ end
307
+
308
+ api_instance = DocSpring::PDFApi.new
309
+ template_id = 'tpl_000000000000000001' # String |
310
+ copy_template_data = DocSpring::CopyTemplateData.new # CopyTemplateData |
311
+
312
+ begin
313
+ #Copy a Template
314
+ result = api_instance.copy_template(template_id, copy_template_data)
315
+ p result
316
+ rescue DocSpring::ApiError => e
317
+ puts "Exception when calling PDFApi->copy_template: #{e}"
318
+ end
319
+ ```
320
+
321
+ ### Parameters
322
+
323
+ Name | Type | Description | Notes
324
+ ------------- | ------------- | ------------- | -------------
325
+ **template_id** | **String**| |
326
+ **copy_template_data** | [**CopyTemplateData**](CopyTemplateData.md)| |
327
+
328
+ ### Return type
329
+
330
+ [**Template**](Template.md)
331
+
332
+ ### Authorization
333
+
334
+ [api_token_basic](../README.md#api_token_basic)
335
+
336
+ ### HTTP request headers
337
+
338
+ - **Content-Type**: application/json
339
+ - **Accept**: application/json
340
+
341
+
342
+
288
343
  # **create_custom_file_from_upload**
289
344
  > CreateCustomFileResponse create_custom_file_from_upload(create_custom_file_data)
290
345
 
@@ -881,6 +936,55 @@ Name | Type | Description | Notes
881
936
 
882
937
 
883
938
 
939
+ # **get_full_template**
940
+ > Template1 get_full_template(template_id)
941
+
942
+ Fetch the full template attributes
943
+
944
+ ### Example
945
+ ```ruby
946
+ # load the gem
947
+ require 'docspring'
948
+ # setup authorization
949
+ DocSpring.configure do |config|
950
+ # Configure HTTP basic authorization: api_token_basic
951
+ config.username = 'YOUR USERNAME'
952
+ config.password = 'YOUR PASSWORD'
953
+ end
954
+
955
+ api_instance = DocSpring::PDFApi.new
956
+ template_id = 'tpl_000000000000000001' # String |
957
+
958
+ begin
959
+ #Fetch the full template attributes
960
+ result = api_instance.get_full_template(template_id)
961
+ p result
962
+ rescue DocSpring::ApiError => e
963
+ puts "Exception when calling PDFApi->get_full_template: #{e}"
964
+ end
965
+ ```
966
+
967
+ ### Parameters
968
+
969
+ Name | Type | Description | Notes
970
+ ------------- | ------------- | ------------- | -------------
971
+ **template_id** | **String**| |
972
+
973
+ ### Return type
974
+
975
+ [**Template1**](Template1.md)
976
+
977
+ ### Authorization
978
+
979
+ [api_token_basic](../README.md#api_token_basic)
980
+
981
+ ### HTTP request headers
982
+
983
+ - **Content-Type**: Not defined
984
+ - **Accept**: application/json
985
+
986
+
987
+
884
988
  # **get_presign_url**
885
989
  > Hash&lt;String, Object&gt; get_presign_url
886
990
 
@@ -1035,7 +1139,7 @@ Name | Type | Description | Notes
1035
1139
  # **get_template**
1036
1140
  > Template get_template(template_id)
1037
1141
 
1038
- Get a single template
1142
+ Check the status of an uploaded template
1039
1143
 
1040
1144
  ### Example
1041
1145
  ```ruby
@@ -1049,10 +1153,10 @@ DocSpring.configure do |config|
1049
1153
  end
1050
1154
 
1051
1155
  api_instance = DocSpring::PDFApi.new
1052
- template_id = 'tpl_000000000000000011' # String |
1156
+ template_id = 'tpl_000000000000000001' # String |
1053
1157
 
1054
1158
  begin
1055
- #Get a single template
1159
+ #Check the status of an uploaded template
1056
1160
  result = api_instance.get_template(template_id)
1057
1161
  p result
1058
1162
  rescue DocSpring::ApiError => e
@@ -1181,6 +1285,130 @@ Name | Type | Description | Notes
1181
1285
 
1182
1286
 
1183
1287
 
1288
+ # **list_submissions**
1289
+ > ListSubmissionsResponse list_submissions(opts)
1290
+
1291
+ List all submissions
1292
+
1293
+ ### Example
1294
+ ```ruby
1295
+ # load the gem
1296
+ require 'docspring'
1297
+ # setup authorization
1298
+ DocSpring.configure do |config|
1299
+ # Configure HTTP basic authorization: api_token_basic
1300
+ config.username = 'YOUR USERNAME'
1301
+ config.password = 'YOUR PASSWORD'
1302
+ end
1303
+
1304
+ api_instance = DocSpring::PDFApi.new
1305
+ opts = {
1306
+ cursor: 'sub_list_000012', # String |
1307
+ limit: 3, # Float |
1308
+ created_after: '2019-01-01T09:00:00-05:00', # String |
1309
+ created_before: '2020-01-01T09:00:00-05:00', # String |
1310
+ type: 'test', # String |
1311
+ include_data: true # BOOLEAN |
1312
+ }
1313
+
1314
+ begin
1315
+ #List all submissions
1316
+ result = api_instance.list_submissions(opts)
1317
+ p result
1318
+ rescue DocSpring::ApiError => e
1319
+ puts "Exception when calling PDFApi->list_submissions: #{e}"
1320
+ end
1321
+ ```
1322
+
1323
+ ### Parameters
1324
+
1325
+ Name | Type | Description | Notes
1326
+ ------------- | ------------- | ------------- | -------------
1327
+ **cursor** | **String**| | [optional]
1328
+ **limit** | **Float**| | [optional]
1329
+ **created_after** | **String**| | [optional]
1330
+ **created_before** | **String**| | [optional]
1331
+ **type** | **String**| | [optional]
1332
+ **include_data** | **BOOLEAN**| | [optional]
1333
+
1334
+ ### Return type
1335
+
1336
+ [**ListSubmissionsResponse**](ListSubmissionsResponse.md)
1337
+
1338
+ ### Authorization
1339
+
1340
+ [api_token_basic](../README.md#api_token_basic)
1341
+
1342
+ ### HTTP request headers
1343
+
1344
+ - **Content-Type**: Not defined
1345
+ - **Accept**: application/json
1346
+
1347
+
1348
+
1349
+ # **list_submissions_0**
1350
+ > ListSubmissionsResponse list_submissions_0(template_id, opts)
1351
+
1352
+ List all submissions for a given template
1353
+
1354
+ ### Example
1355
+ ```ruby
1356
+ # load the gem
1357
+ require 'docspring'
1358
+ # setup authorization
1359
+ DocSpring.configure do |config|
1360
+ # Configure HTTP basic authorization: api_token_basic
1361
+ config.username = 'YOUR USERNAME'
1362
+ config.password = 'YOUR PASSWORD'
1363
+ end
1364
+
1365
+ api_instance = DocSpring::PDFApi.new
1366
+ template_id = 'tpl_000000000000000002' # String |
1367
+ opts = {
1368
+ cursor: 'cursor_example', # String |
1369
+ limit: 3.4, # Float |
1370
+ created_after: 'created_after_example', # String |
1371
+ created_before: 'created_before_example', # String |
1372
+ type: 'type_example', # String |
1373
+ include_data: true # BOOLEAN |
1374
+ }
1375
+
1376
+ begin
1377
+ #List all submissions for a given template
1378
+ result = api_instance.list_submissions_0(template_id, opts)
1379
+ p result
1380
+ rescue DocSpring::ApiError => e
1381
+ puts "Exception when calling PDFApi->list_submissions_0: #{e}"
1382
+ end
1383
+ ```
1384
+
1385
+ ### Parameters
1386
+
1387
+ Name | Type | Description | Notes
1388
+ ------------- | ------------- | ------------- | -------------
1389
+ **template_id** | **String**| |
1390
+ **cursor** | **String**| | [optional]
1391
+ **limit** | **Float**| | [optional]
1392
+ **created_after** | **String**| | [optional]
1393
+ **created_before** | **String**| | [optional]
1394
+ **type** | **String**| | [optional]
1395
+ **include_data** | **BOOLEAN**| | [optional]
1396
+
1397
+ ### Return type
1398
+
1399
+ [**ListSubmissionsResponse**](ListSubmissionsResponse.md)
1400
+
1401
+ ### Authorization
1402
+
1403
+ [api_token_basic](../README.md#api_token_basic)
1404
+
1405
+ ### HTTP request headers
1406
+
1407
+ - **Content-Type**: Not defined
1408
+ - **Accept**: application/json
1409
+
1410
+
1411
+
1184
1412
  # **list_templates**
1185
1413
  > Array&lt;Template&gt; list_templates(opts)
1186
1414
 
@@ -9,6 +9,7 @@ Name | Type | Description | Notes
9
9
  **field_overrides** | **Object** | | [optional]
10
10
  **html** | **String** | | [optional]
11
11
  **metadata** | **Object** | | [optional]
12
+ **password** | **String** | | [optional]
12
13
  **test** | **BOOLEAN** | | [optional]
13
14
 
14
15
 
@@ -7,6 +7,7 @@ Name | Type | Description | Notes
7
7
  **name** | **String** | |
8
8
  **email** | **String** | |
9
9
  **order** | **Integer** | |
10
+ **sort_order** | **Integer** | |
10
11
  **fields** | **Array&lt;String&gt;** | |
11
12
  **metadata** | **Object** | |
12
13
  **state** | **String** | |
data/docs/Template1.md ADDED
@@ -0,0 +1,46 @@
1
+ # DocSpring::Template1
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **document_processed** | **BOOLEAN** | | [optional]
7
+ **expiration_interval** | **String** | | [optional]
8
+ **scss** | **String** | | [optional]
9
+ **document_state** | **String** | | [optional]
10
+ **expire_after** | **Float** | | [optional]
11
+ **description** | **String** | | [optional]
12
+ **slack_webhook_url** | **String** | | [optional]
13
+ **demo** | **BOOLEAN** | | [optional]
14
+ **path** | **String** | | [optional]
15
+ **header_html** | **String** | | [optional]
16
+ **public_web_form** | **BOOLEAN** | | [optional]
17
+ **field_order** | **Array&lt;Array&lt;Float&gt;&gt;** | | [optional]
18
+ **permanent_document_url** | **String** | | [optional]
19
+ **html** | **String** | | [optional]
20
+ **template_type** | **String** | | [optional]
21
+ **id** | **String** | | [optional]
22
+ **page_dimensions** | **Array&lt;Array&lt;Float&gt;&gt;** | | [optional]
23
+ **locked** | **BOOLEAN** | | [optional]
24
+ **page_count** | **Float** | | [optional]
25
+ **encrypt_pdfs** | **BOOLEAN** | | [optional]
26
+ **webhook_url** | **String** | | [optional]
27
+ **embed_domains** | **Array&lt;String&gt;** | | [optional]
28
+ **parent_folder_id** | **String** | | [optional]
29
+ **allow_additional_properties** | **BOOLEAN** | | [optional]
30
+ **encrypt_pdfs_password** | **String** | | [optional]
31
+ **public_submissions** | **BOOLEAN** | | [optional]
32
+ **shared_field_data** | **Object** | | [optional]
33
+ **document_md5** | **String** | | [optional]
34
+ **first_template** | **BOOLEAN** | | [optional]
35
+ **defaults** | [**Template1Defaults**](Template1Defaults.md) | | [optional]
36
+ **editable_submissions** | **BOOLEAN** | | [optional]
37
+ **expire_submissions** | **BOOLEAN** | | [optional]
38
+ **name** | **String** | | [optional]
39
+ **footer_html** | **String** | | [optional]
40
+ **document_parse_error** | **BOOLEAN** | | [optional]
41
+ **fields** | **Object** | | [optional]
42
+ **document_filename** | **String** | | [optional]
43
+ **redirect_url** | **String** | | [optional]
44
+ **document_url** | **String** | | [optional]
45
+
46
+
@@ -0,0 +1,10 @@
1
+ # DocSpring::Template1Defaults
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **color** | **String** | | [optional]
7
+ **font_size** | **Float** | | [optional]
8
+ **typeface** | **String** | | [optional]
9
+
10
+
data/docspring.gemspec CHANGED
@@ -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 = ["Form Applications, Inc."]
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"
@@ -37,7 +37,6 @@ Gem::Specification.new do |s|
37
37
  s.add_development_dependency 'autotest', '~> 4.4', '>= 4.4.6'
38
38
  s.add_development_dependency 'autotest-rails-pure', '~> 4.1', '>= 4.1.2'
39
39
  s.add_development_dependency 'autotest-growl', '~> 0.2', '>= 0.2.16'
40
- s.add_development_dependency 'autotest-fsevent', '~> 0.2', '>= 0.2.15'
41
40
 
42
41
  # Use git ls-files to ignore anything in .gitignore
43
42
  s.files = `git ls-files`.split("\n").uniq.sort.select{|f| !f.empty? }