docspring 1.4.0 → 1.4.1

Sign up to get free protection for your applications and to get access to all the features.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: e5dcdc4a15cf4315e7948d50bd6c5000579a43ea43a8192fdf56d835d486877d
4
- data.tar.gz: ad497500fb8b69b49c62097727cf1bb24d7119deb4fa53660693184883a92115
3
+ metadata.gz: 2aa2757c50c27c3591eb99e17b2ecc5da96139752b6b835f7ce220901be4d0b9
4
+ data.tar.gz: 30eb05f3677c4fa80aca25216d33231347d94ef301c9a76b44d593a195089eac
5
5
  SHA512:
6
- metadata.gz: 847f09feed503bec49f36de06eb23dce71bd842b8947de8bbaf6c9456c80db55230a5aaa3f5bbc292fc142d8351d501abb8efa3d641fca5c6528d38c932d1323
7
- data.tar.gz: f9331fdfae0801c28f3b88b4d6c4947c8443b00da71ee0ec04c75ffaf8a1a26df03982a00521bd4559e1bab160d4369cbe79b118a1f53941f96eaa8be923ef64
6
+ metadata.gz: d0ed063dc65587713433df12884e85d7d3af152e1f5d4d61f8b11c02d1dccbe41ba78907251cbab86f41ccc812eb37829715680c116d6bd075cc78a385d1e5ab
7
+ data.tar.gz: 65632654aa83bdb60abab40c3be6330f4e4c520d900ae70e45c693b2cdd528fbef44e2406baab3854eb6b2a4bcab4f2fbe8a37b3ad1c11f259b8736b09a77397
data/CHANGELOG.md CHANGED
@@ -1,3 +1,7 @@
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
+
1
5
  ### 1.4.0 [May 21, 2021]
2
6
 
3
7
  - Fix URI.escape deprecation warning for Ruby 2.7.0
data/Gemfile.lock CHANGED
@@ -1,7 +1,7 @@
1
1
  PATH
2
2
  remote: .
3
3
  specs:
4
- docspring (1.4.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,7 +10,7 @@ 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)
@@ -77,4 +77,4 @@ DEPENDENCIES
77
77
  webmock (~> 1.24, >= 1.24.3)
78
78
 
79
79
  BUNDLED WITH
80
- 2.2.11
80
+ 2.2.29
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.4.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.4.0.gem
26
+ gem install ./docspring-1.4.1.gem
27
27
  ```
28
- (for development, run `gem install --dev ./docspring-1.4.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.4.0'
34
+ gem 'docspring', '~> 1.4.1'
35
35
 
36
36
  ### Install from Git
37
37
 
@@ -99,12 +99,15 @@ Class | Method | HTTP request | Description
99
99
  *DocSpring::PDFApi* | [**generate_pdf**](docs/PDFApi.md#generate_pdf) | **POST** /templates/{template_id}/submissions | Generates a new PDF
100
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)
101
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
102
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
103
104
  *DocSpring::PDFApi* | [**get_submission**](docs/PDFApi.md#get_submission) | **GET** /submissions/{submission_id} | Check the status of a PDF
104
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
105
- *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
106
107
  *DocSpring::PDFApi* | [**get_template_schema**](docs/PDFApi.md#get_template_schema) | **GET** /templates/{template_id}/schema | Fetch the JSON schema for a template
107
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
108
111
  *DocSpring::PDFApi* | [**list_templates**](docs/PDFApi.md#list_templates) | **GET** /templates | Get a list of all templates
109
112
  *DocSpring::PDFApi* | [**move_folder_to_folder**](docs/PDFApi.md#move_folder_to_folder) | **POST** /folders/{folder_id}/move | Move a folder
110
113
  *DocSpring::PDFApi* | [**move_template_to_folder**](docs/PDFApi.md#move_template_to_folder) | **POST** /templates/{template_id}/move | Move Template to folder
@@ -143,6 +146,7 @@ Class | Method | HTTP request | Description
143
146
  - [DocSpring::FoldersFolder](docs/FoldersFolder.md)
144
147
  - [DocSpring::HtmlTemplateData](docs/HtmlTemplateData.md)
145
148
  - [DocSpring::InvalidRequest](docs/InvalidRequest.md)
149
+ - [DocSpring::ListSubmissionsResponse](docs/ListSubmissionsResponse.md)
146
150
  - [DocSpring::MoveFolderData](docs/MoveFolderData.md)
147
151
  - [DocSpring::MoveTemplateData](docs/MoveTemplateData.md)
148
152
  - [DocSpring::PendingTemplate](docs/PendingTemplate.md)
@@ -155,6 +159,8 @@ Class | Method | HTTP request | Description
155
159
  - [DocSpring::SubmissionDataBatchRequest](docs/SubmissionDataBatchRequest.md)
156
160
  - [DocSpring::SubmissionDataRequest](docs/SubmissionDataRequest.md)
157
161
  - [DocSpring::Template](docs/Template.md)
162
+ - [DocSpring::Template1](docs/Template1.md)
163
+ - [DocSpring::Template1Defaults](docs/Template1Defaults.md)
158
164
  - [DocSpring::TemplateData](docs/TemplateData.md)
159
165
  - [DocSpring::TemplatestemplateIdaddFieldsFields](docs/TemplatestemplateIdaddFieldsFields.md)
160
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,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
+
data/docs/PDFApi.md CHANGED
@@ -22,12 +22,15 @@ Method | HTTP request | Description
22
22
  [**generate_pdf**](PDFApi.md#generate_pdf) | **POST** /templates/{template_id}/submissions | Generates a new PDF
23
23
  [**get_combined_submission**](PDFApi.md#get_combined_submission) | **GET** /combined_submissions/{combined_submission_id} | Check the status of a combined submission (merged PDFs)
24
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
25
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
26
27
  [**get_submission**](PDFApi.md#get_submission) | **GET** /submissions/{submission_id} | Check the status of a PDF
27
28
  [**get_submission_batch**](PDFApi.md#get_submission_batch) | **GET** /submissions/batches/{submission_batch_id} | Check the status of a submission batch job
28
- [**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
29
30
  [**get_template_schema**](PDFApi.md#get_template_schema) | **GET** /templates/{template_id}/schema | Fetch the JSON schema for a template
30
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
31
34
  [**list_templates**](PDFApi.md#list_templates) | **GET** /templates | Get a list of all templates
32
35
  [**move_folder_to_folder**](PDFApi.md#move_folder_to_folder) | **POST** /folders/{folder_id}/move | Move a folder
33
36
  [**move_template_to_folder**](PDFApi.md#move_template_to_folder) | **POST** /templates/{template_id}/move | Move Template to folder
@@ -933,6 +936,55 @@ Name | Type | Description | Notes
933
936
 
934
937
 
935
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
+
936
988
  # **get_presign_url**
937
989
  > Hash&lt;String, Object&gt; get_presign_url
938
990
 
@@ -1087,7 +1139,7 @@ Name | Type | Description | Notes
1087
1139
  # **get_template**
1088
1140
  > Template get_template(template_id)
1089
1141
 
1090
- Get a single template
1142
+ Check the status of an uploaded template
1091
1143
 
1092
1144
  ### Example
1093
1145
  ```ruby
@@ -1101,10 +1153,10 @@ DocSpring.configure do |config|
1101
1153
  end
1102
1154
 
1103
1155
  api_instance = DocSpring::PDFApi.new
1104
- template_id = 'tpl_000000000000000011' # String |
1156
+ template_id = 'tpl_000000000000000001' # String |
1105
1157
 
1106
1158
  begin
1107
- #Get a single template
1159
+ #Check the status of an uploaded template
1108
1160
  result = api_instance.get_template(template_id)
1109
1161
  p result
1110
1162
  rescue DocSpring::ApiError => e
@@ -1233,6 +1285,130 @@ Name | Type | Description | Notes
1233
1285
 
1234
1286
 
1235
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
+
1236
1412
  # **list_templates**
1237
1413
  > Array&lt;Template&gt; list_templates(opts)
1238
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
 
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
+
@@ -996,6 +996,57 @@ module DocSpring
996
996
  return data, status_code, headers
997
997
  end
998
998
 
999
+ # Fetch the full template attributes
1000
+ # @param template_id
1001
+ # @param [Hash] opts the optional parameters
1002
+ # @return [Template1]
1003
+ def get_full_template(template_id, opts = {})
1004
+ data, _status_code, _headers = get_full_template_with_http_info(template_id, opts)
1005
+ data
1006
+ end
1007
+
1008
+ # Fetch the full template attributes
1009
+ # @param template_id
1010
+ # @param [Hash] opts the optional parameters
1011
+ # @return [Array<(Template1, Fixnum, Hash)>] Template1 data, response status code and response headers
1012
+ def get_full_template_with_http_info(template_id, opts = {})
1013
+ if @api_client.config.debugging
1014
+ @api_client.config.logger.debug 'Calling API: PDFApi.get_full_template ...'
1015
+ end
1016
+ # verify the required parameter 'template_id' is set
1017
+ if @api_client.config.client_side_validation && template_id.nil?
1018
+ fail ArgumentError, "Missing the required parameter 'template_id' when calling PDFApi.get_full_template"
1019
+ end
1020
+ # resource path
1021
+ local_var_path = '/templates/{template_id}?full=true'.sub('{' + 'template_id' + '}', template_id.to_s)
1022
+
1023
+ # query parameters
1024
+ query_params = {}
1025
+
1026
+ # header parameters
1027
+ header_params = {}
1028
+ # HTTP header 'Accept' (if needed)
1029
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
1030
+
1031
+ # form parameters
1032
+ form_params = {}
1033
+
1034
+ # http body (model)
1035
+ post_body = nil
1036
+ auth_names = ['api_token_basic']
1037
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path,
1038
+ :header_params => header_params,
1039
+ :query_params => query_params,
1040
+ :form_params => form_params,
1041
+ :body => post_body,
1042
+ :auth_names => auth_names,
1043
+ :return_type => 'Template1')
1044
+ if @api_client.config.debugging
1045
+ @api_client.config.logger.debug "API called: PDFApi#get_full_template\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1046
+ end
1047
+ return data, status_code, headers
1048
+ end
1049
+
999
1050
  # Get a presigned URL so that you can upload a file to our AWS S3 bucket
1000
1051
  # @param [Hash] opts the optional parameters
1001
1052
  # @return [Hash<String, Object>]
@@ -1149,7 +1200,7 @@ module DocSpring
1149
1200
  return data, status_code, headers
1150
1201
  end
1151
1202
 
1152
- # Get a single template
1203
+ # Check the status of an uploaded template
1153
1204
  # @param template_id
1154
1205
  # @param [Hash] opts the optional parameters
1155
1206
  # @return [Template]
@@ -1158,7 +1209,7 @@ module DocSpring
1158
1209
  data
1159
1210
  end
1160
1211
 
1161
- # Get a single template
1212
+ # Check the status of an uploaded template
1162
1213
  # @param template_id
1163
1214
  # @param [Hash] opts the optional parameters
1164
1215
  # @return [Array<(Template, Fixnum, Hash)>] Template data, response status code and response headers
@@ -1299,6 +1350,138 @@ module DocSpring
1299
1350
  return data, status_code, headers
1300
1351
  end
1301
1352
 
1353
+ # List all submissions
1354
+ # @param [Hash] opts the optional parameters
1355
+ # @option opts [String] :cursor
1356
+ # @option opts [Float] :limit
1357
+ # @option opts [String] :created_after
1358
+ # @option opts [String] :created_before
1359
+ # @option opts [String] :type
1360
+ # @option opts [BOOLEAN] :include_data
1361
+ # @return [ListSubmissionsResponse]
1362
+ def list_submissions(opts = {})
1363
+ data, _status_code, _headers = list_submissions_with_http_info(opts)
1364
+ data
1365
+ end
1366
+
1367
+ # List all submissions
1368
+ # @param [Hash] opts the optional parameters
1369
+ # @option opts [String] :cursor
1370
+ # @option opts [Float] :limit
1371
+ # @option opts [String] :created_after
1372
+ # @option opts [String] :created_before
1373
+ # @option opts [String] :type
1374
+ # @option opts [BOOLEAN] :include_data
1375
+ # @return [Array<(ListSubmissionsResponse, Fixnum, Hash)>] ListSubmissionsResponse data, response status code and response headers
1376
+ def list_submissions_with_http_info(opts = {})
1377
+ if @api_client.config.debugging
1378
+ @api_client.config.logger.debug 'Calling API: PDFApi.list_submissions ...'
1379
+ end
1380
+ # resource path
1381
+ local_var_path = '/submissions'
1382
+
1383
+ # query parameters
1384
+ query_params = {}
1385
+ query_params[:'cursor'] = opts[:'cursor'] if !opts[:'cursor'].nil?
1386
+ query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
1387
+ query_params[:'created_after'] = opts[:'created_after'] if !opts[:'created_after'].nil?
1388
+ query_params[:'created_before'] = opts[:'created_before'] if !opts[:'created_before'].nil?
1389
+ query_params[:'type'] = opts[:'type'] if !opts[:'type'].nil?
1390
+ query_params[:'include_data'] = opts[:'include_data'] if !opts[:'include_data'].nil?
1391
+
1392
+ # header parameters
1393
+ header_params = {}
1394
+ # HTTP header 'Accept' (if needed)
1395
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
1396
+
1397
+ # form parameters
1398
+ form_params = {}
1399
+
1400
+ # http body (model)
1401
+ post_body = nil
1402
+ auth_names = ['api_token_basic']
1403
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path,
1404
+ :header_params => header_params,
1405
+ :query_params => query_params,
1406
+ :form_params => form_params,
1407
+ :body => post_body,
1408
+ :auth_names => auth_names,
1409
+ :return_type => 'ListSubmissionsResponse')
1410
+ if @api_client.config.debugging
1411
+ @api_client.config.logger.debug "API called: PDFApi#list_submissions\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1412
+ end
1413
+ return data, status_code, headers
1414
+ end
1415
+
1416
+ # List all submissions for a given template
1417
+ # @param template_id
1418
+ # @param [Hash] opts the optional parameters
1419
+ # @option opts [String] :cursor
1420
+ # @option opts [Float] :limit
1421
+ # @option opts [String] :created_after
1422
+ # @option opts [String] :created_before
1423
+ # @option opts [String] :type
1424
+ # @option opts [BOOLEAN] :include_data
1425
+ # @return [ListSubmissionsResponse]
1426
+ def list_submissions_0(template_id, opts = {})
1427
+ data, _status_code, _headers = list_submissions_0_with_http_info(template_id, opts)
1428
+ data
1429
+ end
1430
+
1431
+ # List all submissions for a given template
1432
+ # @param template_id
1433
+ # @param [Hash] opts the optional parameters
1434
+ # @option opts [String] :cursor
1435
+ # @option opts [Float] :limit
1436
+ # @option opts [String] :created_after
1437
+ # @option opts [String] :created_before
1438
+ # @option opts [String] :type
1439
+ # @option opts [BOOLEAN] :include_data
1440
+ # @return [Array<(ListSubmissionsResponse, Fixnum, Hash)>] ListSubmissionsResponse data, response status code and response headers
1441
+ def list_submissions_0_with_http_info(template_id, opts = {})
1442
+ if @api_client.config.debugging
1443
+ @api_client.config.logger.debug 'Calling API: PDFApi.list_submissions_0 ...'
1444
+ end
1445
+ # verify the required parameter 'template_id' is set
1446
+ if @api_client.config.client_side_validation && template_id.nil?
1447
+ fail ArgumentError, "Missing the required parameter 'template_id' when calling PDFApi.list_submissions_0"
1448
+ end
1449
+ # resource path
1450
+ local_var_path = '/templates/{template_id}/submissions'.sub('{' + 'template_id' + '}', template_id.to_s)
1451
+
1452
+ # query parameters
1453
+ query_params = {}
1454
+ query_params[:'cursor'] = opts[:'cursor'] if !opts[:'cursor'].nil?
1455
+ query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
1456
+ query_params[:'created_after'] = opts[:'created_after'] if !opts[:'created_after'].nil?
1457
+ query_params[:'created_before'] = opts[:'created_before'] if !opts[:'created_before'].nil?
1458
+ query_params[:'type'] = opts[:'type'] if !opts[:'type'].nil?
1459
+ query_params[:'include_data'] = opts[:'include_data'] if !opts[:'include_data'].nil?
1460
+
1461
+ # header parameters
1462
+ header_params = {}
1463
+ # HTTP header 'Accept' (if needed)
1464
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
1465
+
1466
+ # form parameters
1467
+ form_params = {}
1468
+
1469
+ # http body (model)
1470
+ post_body = nil
1471
+ auth_names = ['api_token_basic']
1472
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path,
1473
+ :header_params => header_params,
1474
+ :query_params => query_params,
1475
+ :form_params => form_params,
1476
+ :body => post_body,
1477
+ :auth_names => auth_names,
1478
+ :return_type => 'ListSubmissionsResponse')
1479
+ if @api_client.config.debugging
1480
+ @api_client.config.logger.debug "API called: PDFApi#list_submissions_0\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1481
+ end
1482
+ return data, status_code, headers
1483
+ end
1484
+
1302
1485
  # Get a list of all templates
1303
1486
  # @param [Hash] opts the optional parameters
1304
1487
  # @option opts [String] :query Search By Name