Class: DocSpring::PDFApi

Inherits:
Object
  • Object
show all
Defined in:
lib/docspring/api/pdf_api.rb

Direct Known Subclasses

Client

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ PDFApi

Returns a new instance of PDFApi.



19
20
21
 
# File 'lib/docspring/api/pdf_api.rb', line 19

def initialize(api_client = ApiClient.default)
  @api_client = api_client
end

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



17
18
19
 
# File 'lib/docspring/api/pdf_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#add_fields_to_template(template_id, add_fields_data, opts = {}) ⇒ AddFieldsTemplateResponse

Add new fields to a Template

Parameters:

  • template_id
  • add_fields_data
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



27
28
29
30
 
# File 'lib/docspring/api/pdf_api.rb', line 27

def add_fields_to_template(template_id, add_fields_data, opts = {})
  data, _status_code, _headers = add_fields_to_template_with_http_info(template_id, add_fields_data, opts)
  data
end

#add_fields_to_template_with_http_info(template_id, add_fields_data, opts = {}) ⇒ Array<(AddFieldsTemplateResponse, Fixnum, Hash)>

Add new fields to a Template

Parameters:

  • template_id
  • add_fields_data
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(AddFieldsTemplateResponse, Fixnum, Hash)>) —

    AddFieldsTemplateResponse data, response status code and response headers



37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
 
# File 'lib/docspring/api/pdf_api.rb', line 37

def add_fields_to_template_with_http_info(template_id, add_fields_data, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PDFApi.add_fields_to_template ...'
  end
  # verify the required parameter 'template_id' is set
  if @api_client.config.client_side_validation && template_id.nil?
    fail ArgumentError, "Missing the required parameter 'template_id' when calling PDFApi.add_fields_to_template"
  end
  # verify the required parameter 'add_fields_data' is set
  if @api_client.config.client_side_validation && add_fields_data.nil?
    fail ArgumentError, "Missing the required parameter 'add_fields_data' when calling PDFApi.add_fields_to_template"
  end
  # resource path
  local_var_path = '/templates/{template_id}/add_fields'.sub('{' + 'template_id' + '}', template_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(add_fields_data)
  auth_names = ['api_token_basic']
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'AddFieldsTemplateResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PDFApi#add_fields_to_template\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#batch_generate_pdf_v1(template_id, request_body, opts = {}) ⇒ Array<CreateSubmissionResponse>

Generates multiple PDFs

Parameters:

  • template_id
  • request_body
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



86
87
88
89
 
# File 'lib/docspring/api/pdf_api.rb', line 86

def batch_generate_pdf_v1(template_id, request_body, opts = {})
  data, _status_code, _headers = batch_generate_pdf_v1_with_http_info(template_id, request_body, opts)
  data
end

#batch_generate_pdf_v1_with_http_info(template_id, request_body, opts = {}) ⇒ Array<(Array<CreateSubmissionResponse>, Fixnum, Hash)>

Generates multiple PDFs

Parameters:

  • template_id
  • request_body
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(Array<CreateSubmissionResponse>, Fixnum, Hash)>) —

    Array<CreateSubmissionResponse> data, response status code and response headers



96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
 
# File 'lib/docspring/api/pdf_api.rb', line 96

def batch_generate_pdf_v1_with_http_info(template_id, request_body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PDFApi.batch_generate_pdf_v1 ...'
  end
  # verify the required parameter 'template_id' is set
  if @api_client.config.client_side_validation && template_id.nil?
    fail ArgumentError, "Missing the required parameter 'template_id' when calling PDFApi.batch_generate_pdf_v1"
  end
  # verify the required parameter 'request_body' is set
  if @api_client.config.client_side_validation && request_body.nil?
    fail ArgumentError, "Missing the required parameter 'request_body' when calling PDFApi.batch_generate_pdf_v1"
  end
  # resource path
  local_var_path = '/templates/{template_id}/submissions/batch'.sub('{' + 'template_id' + '}', template_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(request_body)
  auth_names = ['api_token_basic']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'Array<CreateSubmissionResponse>')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PDFApi#batch_generate_pdf_v1\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#batch_generate_pdfs(submission_batch_data, opts = {}) ⇒ CreateSubmissionBatchResponse

Generates multiple PDFs

Parameters:

  • submission_batch_data
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



144
145
146
147
 
# File 'lib/docspring/api/pdf_api.rb', line 144

def batch_generate_pdfs(submission_batch_data, opts = {})
  data, _status_code, _headers = batch_generate_pdfs_with_http_info(submission_batch_data, opts)
  data
end

#batch_generate_pdfs_with_http_info(submission_batch_data, opts = {}) ⇒ Array<(CreateSubmissionBatchResponse, Fixnum, Hash)>

Generates multiple PDFs

Parameters:

  • submission_batch_data
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
 
# File 'lib/docspring/api/pdf_api.rb', line 153

def batch_generate_pdfs_with_http_info(submission_batch_data, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PDFApi.batch_generate_pdfs ...'
  end
  # verify the required parameter 'submission_batch_data' is set
  if @api_client.config.client_side_validation && submission_batch_data.nil?
    fail ArgumentError, "Missing the required parameter 'submission_batch_data' when calling PDFApi.batch_generate_pdfs"
  end
  # resource path
  local_var_path = '/submissions/batches'

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(submission_batch_data)
  auth_names = ['api_token_basic']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'CreateSubmissionBatchResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PDFApi#batch_generate_pdfs\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#combine_pdfs(combine_pdfs_data, opts = {}) ⇒ CreateCombinedSubmissionResponse

Merge submission PDFs, template PDFs, or custom files

Parameters:

  • combine_pdfs_data
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



197
198
199
200
 
# File 'lib/docspring/api/pdf_api.rb', line 197

def combine_pdfs(combine_pdfs_data, opts = {})
  data, _status_code, _headers = combine_pdfs_with_http_info(combine_pdfs_data, opts)
  data
end

#combine_pdfs_with_http_info(combine_pdfs_data, opts = {}) ⇒ Array<(CreateCombinedSubmissionResponse, Fixnum, Hash)>

Merge submission PDFs, template PDFs, or custom files

Parameters:

  • combine_pdfs_data
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
 
# File 'lib/docspring/api/pdf_api.rb', line 206

def combine_pdfs_with_http_info(combine_pdfs_data, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PDFApi.combine_pdfs ...'
  end
  # verify the required parameter 'combine_pdfs_data' is set
  if @api_client.config.client_side_validation && combine_pdfs_data.nil?
    fail ArgumentError, "Missing the required parameter 'combine_pdfs_data' when calling PDFApi.combine_pdfs"
  end
  # resource path
  local_var_path = '/combined_submissions?v=2'

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(combine_pdfs_data)
  auth_names = ['api_token_basic']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'CreateCombinedSubmissionResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PDFApi#combine_pdfs\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#combine_submissions(combined_submission_data, opts = {}) ⇒ CreateCombinedSubmissionResponse

Merge generated PDFs together

Parameters:

  • combined_submission_data
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



250
251
252
253
 
# File 'lib/docspring/api/pdf_api.rb', line 250

def combine_submissions(combined_submission_data, opts = {})
  data, _status_code, _headers = combine_submissions_with_http_info(combined_submission_data, opts)
  data
end

#combine_submissions_with_http_info(combined_submission_data, opts = {}) ⇒ Array<(CreateCombinedSubmissionResponse, Fixnum, Hash)>

Merge generated PDFs together

Parameters:

  • combined_submission_data
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
 
# File 'lib/docspring/api/pdf_api.rb', line 259

def combine_submissions_with_http_info(combined_submission_data, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PDFApi.combine_submissions ...'
  end
  # verify the required parameter 'combined_submission_data' is set
  if @api_client.config.client_side_validation && combined_submission_data.nil?
    fail ArgumentError, "Missing the required parameter 'combined_submission_data' when calling PDFApi.combine_submissions"
  end
  # resource path
  local_var_path = '/combined_submissions'

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(combined_submission_data)
  auth_names = ['api_token_basic']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'CreateCombinedSubmissionResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PDFApi#combine_submissions\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#copy_template(template_id, copy_template_data, opts = {}) ⇒ Template

Copy a Template

Parameters:

  • template_id
  • copy_template_data
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



304
305
306
307
 
# File 'lib/docspring/api/pdf_api.rb', line 304

def copy_template(template_id, copy_template_data, opts = {})
  data, _status_code, _headers = copy_template_with_http_info(template_id, copy_template_data, opts)
  data
end

#copy_template_with_http_info(template_id, copy_template_data, opts = {}) ⇒ Array<(Template, Fixnum, Hash)>

Copy a Template

Parameters:

  • template_id
  • copy_template_data
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(Template, Fixnum, Hash)>) —

    Template data, response status code and response headers



314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
 
# File 'lib/docspring/api/pdf_api.rb', line 314

def copy_template_with_http_info(template_id, copy_template_data, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PDFApi.copy_template ...'
  end
  # verify the required parameter 'template_id' is set
  if @api_client.config.client_side_validation && template_id.nil?
    fail ArgumentError, "Missing the required parameter 'template_id' when calling PDFApi.copy_template"
  end
  # verify the required parameter 'copy_template_data' is set
  if @api_client.config.client_side_validation && copy_template_data.nil?
    fail ArgumentError, "Missing the required parameter 'copy_template_data' when calling PDFApi.copy_template"
  end
  # resource path
  local_var_path = '/templates/{template_id}/copy'.sub('{' + 'template_id' + '}', template_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(copy_template_data)
  auth_names = ['api_token_basic']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'Template')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PDFApi#copy_template\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#create_custom_file_from_upload(create_custom_file_data, opts = {}) ⇒ CreateCustomFileResponse

Create a new custom file from a cached presign upload

Parameters:

  • create_custom_file_data
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



362
363
364
365
 
# File 'lib/docspring/api/pdf_api.rb', line 362

def create_custom_file_from_upload(create_custom_file_data, opts = {})
  data, _status_code, _headers = create_custom_file_from_upload_with_http_info(create_custom_file_data, opts)
  data
end

#create_custom_file_from_upload_with_http_info(create_custom_file_data, opts = {}) ⇒ Array<(CreateCustomFileResponse, Fixnum, Hash)>

Create a new custom file from a cached presign upload

Parameters:

  • create_custom_file_data
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(CreateCustomFileResponse, Fixnum, Hash)>) —

    CreateCustomFileResponse data, response status code and response headers



371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
 
# File 'lib/docspring/api/pdf_api.rb', line 371

def create_custom_file_from_upload_with_http_info(create_custom_file_data, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PDFApi.create_custom_file_from_upload ...'
  end
  # verify the required parameter 'create_custom_file_data' is set
  if @api_client.config.client_side_validation && create_custom_file_data.nil?
    fail ArgumentError, "Missing the required parameter 'create_custom_file_data' when calling PDFApi.create_custom_file_from_upload"
  end
  # resource path
  local_var_path = '/custom_files'

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(create_custom_file_data)
  auth_names = ['api_token_basic']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'CreateCustomFileResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PDFApi#create_custom_file_from_upload\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#create_data_request_token(data_request_id, opts = {}) ⇒ CreateSubmissionDataRequestTokenResponse

Creates a new data request token for form authentication

Parameters:

  • data_request_id
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



415
416
417
418
 
# File 'lib/docspring/api/pdf_api.rb', line 415

def create_data_request_token(data_request_id, opts = {})
  data, _status_code, _headers = create_data_request_token_with_http_info(data_request_id, opts)
  data
end

#create_data_request_token_with_http_info(data_request_id, opts = {}) ⇒ Array<(CreateSubmissionDataRequestTokenResponse, Fixnum, Hash)>

Creates a new data request token for form authentication

Parameters:

  • data_request_id
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
 
# File 'lib/docspring/api/pdf_api.rb', line 424

def create_data_request_token_with_http_info(data_request_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PDFApi.create_data_request_token ...'
  end
  # verify the required parameter 'data_request_id' is set
  if @api_client.config.client_side_validation && data_request_id.nil?
    fail ArgumentError, "Missing the required parameter 'data_request_id' when calling PDFApi.create_data_request_token"
  end
  # resource path
  local_var_path = '/data_requests/{data_request_id}/tokens'.sub('{' + 'data_request_id' + '}', data_request_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['api_token_basic']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'CreateSubmissionDataRequestTokenResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PDFApi#create_data_request_token\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#create_folder(create_folder_data, opts = {}) ⇒ Folder

Create a folder

Parameters:

  • create_folder_data
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



466
467
468
469
 
# File 'lib/docspring/api/pdf_api.rb', line 466

def create_folder(create_folder_data, opts = {})
  data, _status_code, _headers = create_folder_with_http_info(create_folder_data, opts)
  data
end

#create_folder_with_http_info(create_folder_data, opts = {}) ⇒ Array<(Folder, Fixnum, Hash)>

Create a folder

Parameters:

  • create_folder_data
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(Folder, Fixnum, Hash)>) —

    Folder data, response status code and response headers



475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
 
# File 'lib/docspring/api/pdf_api.rb', line 475

def create_folder_with_http_info(create_folder_data, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PDFApi.create_folder ...'
  end
  # verify the required parameter 'create_folder_data' is set
  if @api_client.config.client_side_validation && create_folder_data.nil?
    fail ArgumentError, "Missing the required parameter 'create_folder_data' when calling PDFApi.create_folder"
  end
  # resource path
  local_var_path = '/folders/'

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(create_folder_data)
  auth_names = ['api_token_basic']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'Folder')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PDFApi#create_folder\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#create_html_template(create_html_template_data, opts = {}) ⇒ PendingTemplate

Create a new HTML template

Parameters:

  • create_html_template_data
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



519
520
521
522
 
# File 'lib/docspring/api/pdf_api.rb', line 519

def create_html_template(create_html_template_data, opts = {})
  data, _status_code, _headers = create_html_template_with_http_info(create_html_template_data, opts)
  data
end

#create_html_template_with_http_info(create_html_template_data, opts = {}) ⇒ Array<(PendingTemplate, Fixnum, Hash)>

Create a new HTML template

Parameters:

  • create_html_template_data
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(PendingTemplate, Fixnum, Hash)>) —

    PendingTemplate data, response status code and response headers



528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
 
# File 'lib/docspring/api/pdf_api.rb', line 528

def create_html_template_with_http_info(create_html_template_data, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PDFApi.create_html_template ...'
  end
  # verify the required parameter 'create_html_template_data' is set
  if @api_client.config.client_side_validation && create_html_template_data.nil?
    fail ArgumentError, "Missing the required parameter 'create_html_template_data' when calling PDFApi.create_html_template"
  end
  # resource path
  local_var_path = '/templates?desc=html'

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(create_html_template_data)
  auth_names = ['api_token_basic']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'PendingTemplate')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PDFApi#create_html_template\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#create_pdf_template(template_document, template_name, opts = {}) ⇒ PendingTemplate

Create a new PDF template with a form POST file upload

Parameters:

  • template_document
  • template_name
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :template_parent_folder_id (String)

Returns:



574
575
576
577
 
# File 'lib/docspring/api/pdf_api.rb', line 574

def create_pdf_template(template_document, template_name, opts = {})
  data, _status_code, _headers = create_pdf_template_with_http_info(template_document, template_name, opts)
  data
end

#create_pdf_template_from_upload(create_template_from_upload_data, opts = {}) ⇒ PendingTemplate

Create a new PDF template from a cached presign upload

Parameters:

  • create_template_from_upload_data
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



636
637
638
639
 
# File 'lib/docspring/api/pdf_api.rb', line 636

def create_pdf_template_from_upload(create_template_from_upload_data, opts = {})
  data, _status_code, _headers = create_pdf_template_from_upload_with_http_info(create_template_from_upload_data, opts)
  data
end

#create_pdf_template_from_upload_with_http_info(create_template_from_upload_data, opts = {}) ⇒ Array<(PendingTemplate, Fixnum, Hash)>

Create a new PDF template from a cached presign upload

Parameters:

  • create_template_from_upload_data
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(PendingTemplate, Fixnum, Hash)>) —

    PendingTemplate data, response status code and response headers



645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
 
# File 'lib/docspring/api/pdf_api.rb', line 645

def create_pdf_template_from_upload_with_http_info(create_template_from_upload_data, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PDFApi.create_pdf_template_from_upload ...'
  end
  # verify the required parameter 'create_template_from_upload_data' is set
  if @api_client.config.client_side_validation && create_template_from_upload_data.nil?
    fail ArgumentError, "Missing the required parameter 'create_template_from_upload_data' when calling PDFApi.create_pdf_template_from_upload"
  end
  # resource path
  local_var_path = '/templates?desc=cached_upload'

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(create_template_from_upload_data)
  auth_names = ['api_token_basic']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'PendingTemplate')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PDFApi#create_pdf_template_from_upload\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#create_pdf_template_with_http_info(template_document, template_name, opts = {}) ⇒ Array<(PendingTemplate, Fixnum, Hash)>

Create a new PDF template with a form POST file upload

Parameters:

  • template_document
  • template_name
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :template_parent_folder_id (String)

Returns:

  • (Array<(PendingTemplate, Fixnum, Hash)>) —

    PendingTemplate data, response status code and response headers



585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
 
# File 'lib/docspring/api/pdf_api.rb', line 585

def create_pdf_template_with_http_info(template_document, template_name, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PDFApi.create_pdf_template ...'
  end
  # verify the required parameter 'template_document' is set
  if @api_client.config.client_side_validation && template_document.nil?
    fail ArgumentError, "Missing the required parameter 'template_document' when calling PDFApi.create_pdf_template"
  end
  # verify the required parameter 'template_name' is set
  if @api_client.config.client_side_validation && template_name.nil?
    fail ArgumentError, "Missing the required parameter 'template_name' when calling PDFApi.create_pdf_template"
  end
  # resource path
  local_var_path = '/templates'

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['multipart/form-data'])

  # form parameters
  form_params = {}
  form_params['template[document]'] = template_document
  form_params['template[name]'] = template_name
  form_params['template[parent_folder_id]'] = opts[:'template_parent_folder_id'] if !opts[:'template_parent_folder_id'].nil?

  # http body (model)
  post_body = nil
  auth_names = ['api_token_basic']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'PendingTemplate')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PDFApi#create_pdf_template\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete_folder(folder_id, opts = {}) ⇒ Folder

Delete a folder

Parameters:

  • folder_id
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



689
690
691
692
 
# File 'lib/docspring/api/pdf_api.rb', line 689

def delete_folder(folder_id, opts = {})
  data, _status_code, _headers = delete_folder_with_http_info(folder_id, opts)
  data
end

#delete_folder_with_http_info(folder_id, opts = {}) ⇒ Array<(Folder, Fixnum, Hash)>

Delete a folder

Parameters:

  • folder_id
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(Folder, Fixnum, Hash)>) —

    Folder data, response status code and response headers



698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
 
# File 'lib/docspring/api/pdf_api.rb', line 698

def delete_folder_with_http_info(folder_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PDFApi.delete_folder ...'
  end
  # verify the required parameter 'folder_id' is set
  if @api_client.config.client_side_validation && folder_id.nil?
    fail ArgumentError, "Missing the required parameter 'folder_id' when calling PDFApi.delete_folder"
  end
  # resource path
  local_var_path = '/folders/{folder_id}'.sub('{' + 'folder_id' + '}', folder_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['api_token_basic']
  data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'Folder')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PDFApi#delete_folder\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#expire_combined_submission(combined_submission_id, opts = {}) ⇒ CombinedSubmission

Expire a combined submission

Parameters:

  • combined_submission_id
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



740
741
742
743
 
# File 'lib/docspring/api/pdf_api.rb', line 740

def expire_combined_submission(combined_submission_id, opts = {})
  data, _status_code, _headers = expire_combined_submission_with_http_info(combined_submission_id, opts)
  data
end

#expire_combined_submission_with_http_info(combined_submission_id, opts = {}) ⇒ Array<(CombinedSubmission, Fixnum, Hash)>

Expire a combined submission

Parameters:

  • combined_submission_id
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(CombinedSubmission, Fixnum, Hash)>) —

    CombinedSubmission data, response status code and response headers



749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
 
# File 'lib/docspring/api/pdf_api.rb', line 749

def expire_combined_submission_with_http_info(combined_submission_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PDFApi.expire_combined_submission ...'
  end
  # verify the required parameter 'combined_submission_id' is set
  if @api_client.config.client_side_validation && combined_submission_id.nil?
    fail ArgumentError, "Missing the required parameter 'combined_submission_id' when calling PDFApi.expire_combined_submission"
  end
  # resource path
  local_var_path = '/combined_submissions/{combined_submission_id}'.sub('{' + 'combined_submission_id' + '}', combined_submission_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['api_token_basic']
  data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'CombinedSubmission')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PDFApi#expire_combined_submission\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#expire_submission(submission_id, opts = {}) ⇒ Submission

Expire a PDF submission

Parameters:

  • submission_id
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



791
792
793
794
 
# File 'lib/docspring/api/pdf_api.rb', line 791

def expire_submission(submission_id, opts = {})
  data, _status_code, _headers = expire_submission_with_http_info(submission_id, opts)
  data
end

#expire_submission_with_http_info(submission_id, opts = {}) ⇒ Array<(Submission, Fixnum, Hash)>

Expire a PDF submission

Parameters:

  • submission_id
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(Submission, Fixnum, Hash)>) —

    Submission data, response status code and response headers



800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
 
# File 'lib/docspring/api/pdf_api.rb', line 800

def expire_submission_with_http_info(submission_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PDFApi.expire_submission ...'
  end
  # verify the required parameter 'submission_id' is set
  if @api_client.config.client_side_validation && submission_id.nil?
    fail ArgumentError, "Missing the required parameter 'submission_id' when calling PDFApi.expire_submission"
  end
  # resource path
  local_var_path = '/submissions/{submission_id}'.sub('{' + 'submission_id' + '}', submission_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['api_token_basic']
  data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'Submission')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PDFApi#expire_submission\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#generate_pdf(template_id, submission_data, opts = {}) ⇒ CreateSubmissionResponse

Generates a new PDF

Parameters:

  • template_id
  • submission_data
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



843
844
845
846
 
# File 'lib/docspring/api/pdf_api.rb', line 843

def generate_pdf(template_id, submission_data, opts = {})
  data, _status_code, _headers = generate_pdf_with_http_info(template_id, submission_data, opts)
  data
end

#generate_pdf_with_http_info(template_id, submission_data, opts = {}) ⇒ Array<(CreateSubmissionResponse, Fixnum, Hash)>

Generates a new PDF

Parameters:

  • template_id
  • submission_data
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(CreateSubmissionResponse, Fixnum, Hash)>) —

    CreateSubmissionResponse data, response status code and response headers



853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
 
# File 'lib/docspring/api/pdf_api.rb', line 853

def generate_pdf_with_http_info(template_id, submission_data, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PDFApi.generate_pdf ...'
  end
  # verify the required parameter 'template_id' is set
  if @api_client.config.client_side_validation && template_id.nil?
    fail ArgumentError, "Missing the required parameter 'template_id' when calling PDFApi.generate_pdf"
  end
  # verify the required parameter 'submission_data' is set
  if @api_client.config.client_side_validation && submission_data.nil?
    fail ArgumentError, "Missing the required parameter 'submission_data' when calling PDFApi.generate_pdf"
  end
  # resource path
  local_var_path = '/templates/{template_id}/submissions'.sub('{' + 'template_id' + '}', template_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(submission_data)
  auth_names = ['api_token_basic']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'CreateSubmissionResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PDFApi#generate_pdf\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_combined_submission(combined_submission_id, opts = {}) ⇒ CombinedSubmission

Check the status of a combined submission (merged PDFs)

Parameters:

  • combined_submission_id
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



901
902
903
904
 
# File 'lib/docspring/api/pdf_api.rb', line 901

def get_combined_submission(combined_submission_id, opts = {})
  data, _status_code, _headers = get_combined_submission_with_http_info(combined_submission_id, opts)
  data
end

#get_combined_submission_with_http_info(combined_submission_id, opts = {}) ⇒ Array<(CombinedSubmission, Fixnum, Hash)>

Check the status of a combined submission (merged PDFs)

Parameters:

  • combined_submission_id
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(CombinedSubmission, Fixnum, Hash)>) —

    CombinedSubmission data, response status code and response headers



910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
 
# File 'lib/docspring/api/pdf_api.rb', line 910

def get_combined_submission_with_http_info(combined_submission_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PDFApi.get_combined_submission ...'
  end
  # verify the required parameter 'combined_submission_id' is set
  if @api_client.config.client_side_validation && combined_submission_id.nil?
    fail ArgumentError, "Missing the required parameter 'combined_submission_id' when calling PDFApi.get_combined_submission"
  end
  # resource path
  local_var_path = '/combined_submissions/{combined_submission_id}'.sub('{' + 'combined_submission_id' + '}', combined_submission_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['api_token_basic']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'CombinedSubmission')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PDFApi#get_combined_submission\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_data_request(data_request_id, opts = {}) ⇒ SubmissionDataRequest

Look up a submission data request

Parameters:

  • data_request_id
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



952
953
954
955
 
# File 'lib/docspring/api/pdf_api.rb', line 952

def get_data_request(data_request_id, opts = {})
  data, _status_code, _headers = get_data_request_with_http_info(data_request_id, opts)
  data
end

#get_data_request_with_http_info(data_request_id, opts = {}) ⇒ Array<(SubmissionDataRequest, Fixnum, Hash)>

Look up a submission data request

Parameters:

  • data_request_id
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(SubmissionDataRequest, Fixnum, Hash)>) —

    SubmissionDataRequest data, response status code and response headers



961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
 
# File 'lib/docspring/api/pdf_api.rb', line 961

def get_data_request_with_http_info(data_request_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PDFApi.get_data_request ...'
  end
  # verify the required parameter 'data_request_id' is set
  if @api_client.config.client_side_validation && data_request_id.nil?
    fail ArgumentError, "Missing the required parameter 'data_request_id' when calling PDFApi.get_data_request"
  end
  # resource path
  local_var_path = '/data_requests/{data_request_id}'.sub('{' + 'data_request_id' + '}', data_request_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['api_token_basic']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'SubmissionDataRequest')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PDFApi#get_data_request\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_full_template(template_id, opts = {}) ⇒ Template1

Fetch the full template attributes

Parameters:

  • template_id
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



1003
1004
1005
1006
 
# File 'lib/docspring/api/pdf_api.rb', line 1003

def get_full_template(template_id, opts = {})
  data, _status_code, _headers = get_full_template_with_http_info(template_id, opts)
  data
end

#get_full_template_with_http_info(template_id, opts = {}) ⇒ Array<(Template1, Fixnum, Hash)>

Fetch the full template attributes

Parameters:

  • template_id
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(Template1, Fixnum, Hash)>) —

    Template1 data, response status code and response headers



1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
 
# File 'lib/docspring/api/pdf_api.rb', line 1012

def get_full_template_with_http_info(template_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PDFApi.get_full_template ...'
  end
  # verify the required parameter 'template_id' is set
  if @api_client.config.client_side_validation && template_id.nil?
    fail ArgumentError, "Missing the required parameter 'template_id' when calling PDFApi.get_full_template"
  end
  # resource path
  local_var_path = '/templates/{template_id}?full=true'.sub('{' + 'template_id' + '}', template_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['api_token_basic']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'Template1')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PDFApi#get_full_template\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_presign_url(opts = {}) ⇒ Hash<String, Object>

Get a presigned URL so that you can upload a file to our AWS S3 bucket

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Hash<String, Object>) 


1053
1054
1055
1056
 
# File 'lib/docspring/api/pdf_api.rb', line 1053

def get_presign_url(opts = {})
  data, _status_code, _headers = get_presign_url_with_http_info(opts)
  data
end

#get_presign_url_with_http_info(opts = {}) ⇒ Array<(Hash<String, Object>, Fixnum, Hash)>

Get a presigned URL so that you can upload a file to our AWS S3 bucket

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(Hash<String, Object>, Fixnum, Hash)>) —

    Hash<String, Object> data, response status code and response headers



1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
 
# File 'lib/docspring/api/pdf_api.rb', line 1061

def get_presign_url_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PDFApi.get_presign_url ...'
  end
  # resource path
  local_var_path = '/uploads/presign'

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['api_token_basic']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'Hash<String, Object>')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PDFApi#get_presign_url\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_submission(submission_id, opts = {}) ⇒ Submission

Check the status of a PDF

Parameters:

  • submission_id
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :include_data (BOOLEAN)

Returns:



1100
1101
1102
1103
 
# File 'lib/docspring/api/pdf_api.rb', line 1100

def get_submission(submission_id, opts = {})
  data, _status_code, _headers = get_submission_with_http_info(submission_id, opts)
  data
end

#get_submission_batch(submission_batch_id, opts = {}) ⇒ SubmissionBatch

Check the status of a submission batch job

Parameters:

  • submission_batch_id
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :include_submissions (BOOLEAN)

Returns:



1154
1155
1156
1157
 
# File 'lib/docspring/api/pdf_api.rb', line 1154

def get_submission_batch(submission_batch_id, opts = {})
  data, _status_code, _headers = get_submission_batch_with_http_info(submission_batch_id, opts)
  data
end

#get_submission_batch_with_http_info(submission_batch_id, opts = {}) ⇒ Array<(SubmissionBatch, Fixnum, Hash)>

Check the status of a submission batch job

Parameters:

  • submission_batch_id
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :include_submissions (BOOLEAN)

Returns:

  • (Array<(SubmissionBatch, Fixnum, Hash)>) —

    SubmissionBatch data, response status code and response headers



1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
 
# File 'lib/docspring/api/pdf_api.rb', line 1164

def get_submission_batch_with_http_info(submission_batch_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PDFApi.get_submission_batch ...'
  end
  # verify the required parameter 'submission_batch_id' is set
  if @api_client.config.client_side_validation && submission_batch_id.nil?
    fail ArgumentError, "Missing the required parameter 'submission_batch_id' when calling PDFApi.get_submission_batch"
  end
  # resource path
  local_var_path = '/submissions/batches/{submission_batch_id}'.sub('{' + 'submission_batch_id' + '}', submission_batch_id.to_s)

  # query parameters
  query_params = {}
  query_params[:'include_submissions'] = opts[:'include_submissions'] if !opts[:'include_submissions'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['api_token_basic']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'SubmissionBatch')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PDFApi#get_submission_batch\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_submission_with_http_info(submission_id, opts = {}) ⇒ Array<(Submission, Fixnum, Hash)>

Check the status of a PDF

Parameters:

  • submission_id
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :include_data (BOOLEAN)

Returns:

  • (Array<(Submission, Fixnum, Hash)>) —

    Submission data, response status code and response headers



1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
 
# File 'lib/docspring/api/pdf_api.rb', line 1110

def get_submission_with_http_info(submission_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PDFApi.get_submission ...'
  end
  # verify the required parameter 'submission_id' is set
  if @api_client.config.client_side_validation && submission_id.nil?
    fail ArgumentError, "Missing the required parameter 'submission_id' when calling PDFApi.get_submission"
  end
  # resource path
  local_var_path = '/submissions/{submission_id}'.sub('{' + 'submission_id' + '}', submission_id.to_s)

  # query parameters
  query_params = {}
  query_params[:'include_data'] = opts[:'include_data'] if !opts[:'include_data'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['api_token_basic']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'Submission')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PDFApi#get_submission\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_template(template_id, opts = {}) ⇒ Template

Check the status of an uploaded template

Parameters:

  • template_id
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



1207
1208
1209
1210
 
# File 'lib/docspring/api/pdf_api.rb', line 1207

def get_template(template_id, opts = {})
  data, _status_code, _headers = get_template_with_http_info(template_id, opts)
  data
end

#get_template_schema(template_id, opts = {}) ⇒ Hash<String, Object>

Fetch the JSON schema for a template

Parameters:

  • template_id
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Hash<String, Object>) 


1258
1259
1260
1261
 
# File 'lib/docspring/api/pdf_api.rb', line 1258

def get_template_schema(template_id, opts = {})
  data, _status_code, _headers = get_template_schema_with_http_info(template_id, opts)
  data
end

#get_template_schema_with_http_info(template_id, opts = {}) ⇒ Array<(Hash<String, Object>, Fixnum, Hash)>

Fetch the JSON schema for a template

Parameters:

  • template_id
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(Hash<String, Object>, Fixnum, Hash)>) —

    Hash<String, Object> data, response status code and response headers



1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
 
# File 'lib/docspring/api/pdf_api.rb', line 1267

def get_template_schema_with_http_info(template_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PDFApi.get_template_schema ...'
  end
  # verify the required parameter 'template_id' is set
  if @api_client.config.client_side_validation && template_id.nil?
    fail ArgumentError, "Missing the required parameter 'template_id' when calling PDFApi.get_template_schema"
  end
  # resource path
  local_var_path = '/templates/{template_id}/schema'.sub('{' + 'template_id' + '}', template_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['api_token_basic']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'Hash<String, Object>')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PDFApi#get_template_schema\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_template_with_http_info(template_id, opts = {}) ⇒ Array<(Template, Fixnum, Hash)>

Check the status of an uploaded template

Parameters:

  • template_id
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(Template, Fixnum, Hash)>) —

    Template data, response status code and response headers



1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
 
# File 'lib/docspring/api/pdf_api.rb', line 1216

def get_template_with_http_info(template_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PDFApi.get_template ...'
  end
  # verify the required parameter 'template_id' is set
  if @api_client.config.client_side_validation && template_id.nil?
    fail ArgumentError, "Missing the required parameter 'template_id' when calling PDFApi.get_template"
  end
  # resource path
  local_var_path = '/templates/{template_id}'.sub('{' + 'template_id' + '}', template_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['api_token_basic']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'Template')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PDFApi#get_template\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#list_folders(opts = {}) ⇒ Array<Folder>

Get a list of all folders

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :parent_folder_id (String) —

    Filter By Folder Id

Returns:



1309
1310
1311
1312
 
# File 'lib/docspring/api/pdf_api.rb', line 1309

def list_folders(opts = {})
  data, _status_code, _headers = list_folders_with_http_info(opts)
  data
end

#list_folders_with_http_info(opts = {}) ⇒ Array<(Array<Folder>, Fixnum, Hash)>

Get a list of all folders

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :parent_folder_id (String) —

    Filter By Folder Id

Returns:

  • (Array<(Array<Folder>, Fixnum, Hash)>) —

    Array<Folder> data, response status code and response headers



1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
 
# File 'lib/docspring/api/pdf_api.rb', line 1318

def list_folders_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PDFApi.list_folders ...'
  end
  # resource path
  local_var_path = '/folders/'

  # query parameters
  query_params = {}
  query_params[:'parent_folder_id'] = opts[:'parent_folder_id'] if !opts[:'parent_folder_id'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['api_token_basic']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'Array<Folder>')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PDFApi#list_folders\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#list_submissions(opts = {}) ⇒ ListSubmissionsResponse

List all submissions

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :cursor (String)
  • :limit (Float)
  • :created_after (String)
  • :created_before (String)
  • :type (String)
  • :include_data (BOOLEAN)

Returns:



1362
1363
1364
1365
 
# File 'lib/docspring/api/pdf_api.rb', line 1362

def list_submissions(opts = {})
  data, _status_code, _headers = list_submissions_with_http_info(opts)
  data
end

#list_submissions_0(template_id, opts = {}) ⇒ ListSubmissionsResponse

List all submissions for a given template

Parameters:

  • template_id
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :cursor (String)
  • :limit (Float)
  • :created_after (String)
  • :created_before (String)
  • :type (String)
  • :include_data (BOOLEAN)

Returns:



1426
1427
1428
1429
 
# File 'lib/docspring/api/pdf_api.rb', line 1426

def list_submissions_0(template_id, opts = {})
  data, _status_code, _headers = list_submissions_0_with_http_info(template_id, opts)
  data
end

#list_submissions_0_with_http_info(template_id, opts = {}) ⇒ Array<(ListSubmissionsResponse, Fixnum, Hash)>

List all submissions for a given template

Parameters:

  • template_id
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :cursor (String)
  • :limit (Float)
  • :created_after (String)
  • :created_before (String)
  • :type (String)
  • :include_data (BOOLEAN)

Returns:

  • (Array<(ListSubmissionsResponse, Fixnum, Hash)>) —

    ListSubmissionsResponse data, response status code and response headers



1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
 
# File 'lib/docspring/api/pdf_api.rb', line 1441

def list_submissions_0_with_http_info(template_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PDFApi.list_submissions_0 ...'
  end
  # verify the required parameter 'template_id' is set
  if @api_client.config.client_side_validation && template_id.nil?
    fail ArgumentError, "Missing the required parameter 'template_id' when calling PDFApi.list_submissions_0"
  end
  # resource path
  local_var_path = '/templates/{template_id}/submissions'.sub('{' + 'template_id' + '}', template_id.to_s)

  # query parameters
  query_params = {}
  query_params[:'cursor'] = opts[:'cursor'] if !opts[:'cursor'].nil?
  query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
  query_params[:'created_after'] = opts[:'created_after'] if !opts[:'created_after'].nil?
  query_params[:'created_before'] = opts[:'created_before'] if !opts[:'created_before'].nil?
  query_params[:'type'] = opts[:'type'] if !opts[:'type'].nil?
  query_params[:'include_data'] = opts[:'include_data'] if !opts[:'include_data'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['api_token_basic']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'ListSubmissionsResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PDFApi#list_submissions_0\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#list_submissions_with_http_info(opts = {}) ⇒ Array<(ListSubmissionsResponse, Fixnum, Hash)>

List all submissions

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :cursor (String)
  • :limit (Float)
  • :created_after (String)
  • :created_before (String)
  • :type (String)
  • :include_data (BOOLEAN)

Returns:

  • (Array<(ListSubmissionsResponse, Fixnum, Hash)>) —

    ListSubmissionsResponse data, response status code and response headers



1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
 
# File 'lib/docspring/api/pdf_api.rb', line 1376

def list_submissions_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PDFApi.list_submissions ...'
  end
  # resource path
  local_var_path = '/submissions'

  # query parameters
  query_params = {}
  query_params[:'cursor'] = opts[:'cursor'] if !opts[:'cursor'].nil?
  query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
  query_params[:'created_after'] = opts[:'created_after'] if !opts[:'created_after'].nil?
  query_params[:'created_before'] = opts[:'created_before'] if !opts[:'created_before'].nil?
  query_params[:'type'] = opts[:'type'] if !opts[:'type'].nil?
  query_params[:'include_data'] = opts[:'include_data'] if !opts[:'include_data'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['api_token_basic']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'ListSubmissionsResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PDFApi#list_submissions\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#list_templates(opts = {}) ⇒ Array<Template>

Get a list of all templates

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :query (String) —

    Search By Name

  • :parent_folder_id (String) —

    Filter By Folder Id

  • :page (Integer) —

    Default: 1

  • :per_page (Integer) —

    Default: 50

Returns:



1492
1493
1494
1495
 
# File 'lib/docspring/api/pdf_api.rb', line 1492

def list_templates(opts = {})
  data, _status_code, _headers = list_templates_with_http_info(opts)
  data
end

#list_templates_with_http_info(opts = {}) ⇒ Array<(Array<Template>, Fixnum, Hash)>

Get a list of all templates

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :query (String) —

    Search By Name

  • :parent_folder_id (String) —

    Filter By Folder Id

  • :page (Integer) —

    Default: 1

  • :per_page (Integer) —

    Default: 50

Returns:

  • (Array<(Array<Template>, Fixnum, Hash)>) —

    Array<Template> data, response status code and response headers



1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
 
# File 'lib/docspring/api/pdf_api.rb', line 1504

def list_templates_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PDFApi.list_templates ...'
  end
  if @api_client.config.client_side_validation && !opts[:'page'].nil? && opts[:'page'] < 1
    fail ArgumentError, 'invalid value for "opts[:"page"]" when calling PDFApi.list_templates, must be greater than or equal to 1.'
  end

  if @api_client.config.client_side_validation && !opts[:'per_page'].nil? && opts[:'per_page'] > 50
    fail ArgumentError, 'invalid value for "opts[:"per_page"]" when calling PDFApi.list_templates, must be smaller than or equal to 50.'
  end

  if @api_client.config.client_side_validation && !opts[:'per_page'].nil? && opts[:'per_page'] < 1
    fail ArgumentError, 'invalid value for "opts[:"per_page"]" when calling PDFApi.list_templates, must be greater than or equal to 1.'
  end

  # resource path
  local_var_path = '/templates'

  # query parameters
  query_params = {}
  query_params[:'query'] = opts[:'query'] if !opts[:'query'].nil?
  query_params[:'parent_folder_id'] = opts[:'parent_folder_id'] if !opts[:'parent_folder_id'].nil?
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
  query_params[:'per_page'] = opts[:'per_page'] if !opts[:'per_page'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['api_token_basic']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'Array<Template>')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PDFApi#list_templates\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#move_folder_to_folder(folder_id, move_folder_data, opts = {}) ⇒ Folder

Move a folder

Parameters:

  • folder_id
  • move_folder_data
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



1559
1560
1561
1562
 
# File 'lib/docspring/api/pdf_api.rb', line 1559

def move_folder_to_folder(folder_id, move_folder_data, opts = {})
  data, _status_code, _headers = move_folder_to_folder_with_http_info(folder_id, move_folder_data, opts)
  data
end

#move_folder_to_folder_with_http_info(folder_id, move_folder_data, opts = {}) ⇒ Array<(Folder, Fixnum, Hash)>

Move a folder

Parameters:

  • folder_id
  • move_folder_data
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(Folder, Fixnum, Hash)>) —

    Folder data, response status code and response headers



1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
 
# File 'lib/docspring/api/pdf_api.rb', line 1569

def move_folder_to_folder_with_http_info(folder_id, move_folder_data, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PDFApi.move_folder_to_folder ...'
  end
  # verify the required parameter 'folder_id' is set
  if @api_client.config.client_side_validation && folder_id.nil?
    fail ArgumentError, "Missing the required parameter 'folder_id' when calling PDFApi.move_folder_to_folder"
  end
  # verify the required parameter 'move_folder_data' is set
  if @api_client.config.client_side_validation && move_folder_data.nil?
    fail ArgumentError, "Missing the required parameter 'move_folder_data' when calling PDFApi.move_folder_to_folder"
  end
  # resource path
  local_var_path = '/folders/{folder_id}/move'.sub('{' + 'folder_id' + '}', folder_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(move_folder_data)
  auth_names = ['api_token_basic']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'Folder')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PDFApi#move_folder_to_folder\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#move_template_to_folder(template_id, move_template_data, opts = {}) ⇒ Template

Move Template to folder

Parameters:

  • template_id
  • move_template_data
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



1618
1619
1620
1621
 
# File 'lib/docspring/api/pdf_api.rb', line 1618

def move_template_to_folder(template_id, move_template_data, opts = {})
  data, _status_code, _headers = move_template_to_folder_with_http_info(template_id, move_template_data, opts)
  data
end

#move_template_to_folder_with_http_info(template_id, move_template_data, opts = {}) ⇒ Array<(Template, Fixnum, Hash)>

Move Template to folder

Parameters:

  • template_id
  • move_template_data
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(Template, Fixnum, Hash)>) —

    Template data, response status code and response headers



1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
 
# File 'lib/docspring/api/pdf_api.rb', line 1628

def move_template_to_folder_with_http_info(template_id, move_template_data, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PDFApi.move_template_to_folder ...'
  end
  # verify the required parameter 'template_id' is set
  if @api_client.config.client_side_validation && template_id.nil?
    fail ArgumentError, "Missing the required parameter 'template_id' when calling PDFApi.move_template_to_folder"
  end
  # verify the required parameter 'move_template_data' is set
  if @api_client.config.client_side_validation && move_template_data.nil?
    fail ArgumentError, "Missing the required parameter 'move_template_data' when calling PDFApi.move_template_to_folder"
  end
  # resource path
  local_var_path = '/templates/{template_id}/move'.sub('{' + 'template_id' + '}', template_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(move_template_data)
  auth_names = ['api_token_basic']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'Template')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PDFApi#move_template_to_folder\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#rename_folder(folder_id, rename_folder_data, opts = {}) ⇒ nil

Rename a folder

Parameters:

  • folder_id
  • rename_folder_data
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (nil) 


1677
1678
1679
1680
 
# File 'lib/docspring/api/pdf_api.rb', line 1677

def rename_folder(folder_id, rename_folder_data, opts = {})
  rename_folder_with_http_info(folder_id, rename_folder_data, opts)
  nil
end

#rename_folder_with_http_info(folder_id, rename_folder_data, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Rename a folder

Parameters:

  • folder_id
  • rename_folder_data
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(nil, Fixnum, Hash)>) —

    nil, response status code and response headers



1687
1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
1699
1700
1701
1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
 
# File 'lib/docspring/api/pdf_api.rb', line 1687

def rename_folder_with_http_info(folder_id, rename_folder_data, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PDFApi.rename_folder ...'
  end
  # verify the required parameter 'folder_id' is set
  if @api_client.config.client_side_validation && folder_id.nil?
    fail ArgumentError, "Missing the required parameter 'folder_id' when calling PDFApi.rename_folder"
  end
  # verify the required parameter 'rename_folder_data' is set
  if @api_client.config.client_side_validation && rename_folder_data.nil?
    fail ArgumentError, "Missing the required parameter 'rename_folder_data' when calling PDFApi.rename_folder"
  end
  # resource path
  local_var_path = '/folders/{folder_id}/rename'.sub('{' + 'folder_id' + '}', folder_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(rename_folder_data)
  auth_names = ['api_token_basic']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PDFApi#rename_folder\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#test_authentication(opts = {}) ⇒ AuthenticationSuccessResponse

Test Authentication

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



1733
1734
1735
1736
 
# File 'lib/docspring/api/pdf_api.rb', line 1733

def test_authentication(opts = {})
  data, _status_code, _headers = test_authentication_with_http_info(opts)
  data
end

#test_authentication_with_http_info(opts = {}) ⇒ Array<(AuthenticationSuccessResponse, Fixnum, Hash)>

Test Authentication

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



1741
1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
 
# File 'lib/docspring/api/pdf_api.rb', line 1741

def test_authentication_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PDFApi.test_authentication ...'
  end
  # resource path
  local_var_path = '/authentication'

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['api_token_basic']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'AuthenticationSuccessResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PDFApi#test_authentication\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#update_data_request(data_request_id, update_submission_data_request_data, opts = {}) ⇒ UpdateDataRequestResponse

Update a submission data request

Parameters:

  • data_request_id
  • update_submission_data_request_data
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



1780
1781
1782
1783
 
# File 'lib/docspring/api/pdf_api.rb', line 1780

def update_data_request(data_request_id, update_submission_data_request_data, opts = {})
  data, _status_code, _headers = update_data_request_with_http_info(data_request_id, update_submission_data_request_data, opts)
  data
end

#update_data_request_with_http_info(data_request_id, update_submission_data_request_data, opts = {}) ⇒ Array<(UpdateDataRequestResponse, Fixnum, Hash)>

Update a submission data request

Parameters:

  • data_request_id
  • update_submission_data_request_data
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(UpdateDataRequestResponse, Fixnum, Hash)>) —

    UpdateDataRequestResponse data, response status code and response headers



1790
1791
1792
1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
1807
1808
1809
1810
1811
1812
1813
1814
1815
1816
1817
1818
1819
1820
1821
1822
1823
1824
1825
1826
1827
1828
1829
1830
1831
1832
 
# File 'lib/docspring/api/pdf_api.rb', line 1790

def update_data_request_with_http_info(data_request_id, update_submission_data_request_data, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PDFApi.update_data_request ...'
  end
  # verify the required parameter 'data_request_id' is set
  if @api_client.config.client_side_validation && data_request_id.nil?
    fail ArgumentError, "Missing the required parameter 'data_request_id' when calling PDFApi.update_data_request"
  end
  # verify the required parameter 'update_submission_data_request_data' is set
  if @api_client.config.client_side_validation && update_submission_data_request_data.nil?
    fail ArgumentError, "Missing the required parameter 'update_submission_data_request_data' when calling PDFApi.update_data_request"
  end
  # resource path
  local_var_path = '/data_requests/{data_request_id}'.sub('{' + 'data_request_id' + '}', data_request_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(update_submission_data_request_data)
  auth_names = ['api_token_basic']
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'UpdateDataRequestResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PDFApi#update_data_request\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#update_template(template_id, update_template_data, opts = {}) ⇒ UpdateTemplateResponse

Update a Template

Parameters:

  • template_id
  • update_template_data
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



1839
1840
1841
1842
 
# File 'lib/docspring/api/pdf_api.rb', line 1839

def update_template(template_id, update_template_data, opts = {})
  data, _status_code, _headers = update_template_with_http_info(template_id, update_template_data, opts)
  data
end

#update_template_with_http_info(template_id, update_template_data, opts = {}) ⇒ Array<(UpdateTemplateResponse, Fixnum, Hash)>

Update a Template

Parameters:

  • template_id
  • update_template_data
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(UpdateTemplateResponse, Fixnum, Hash)>) —

    UpdateTemplateResponse data, response status code and response headers



1849
1850
1851
1852
1853
1854
1855
1856
1857
1858
1859
1860
1861
1862
1863
1864
1865
1866
1867
1868
1869
1870
1871
1872
1873
1874
1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
1885
1886
1887
1888
1889
1890
1891
 
# File 'lib/docspring/api/pdf_api.rb', line 1849

def update_template_with_http_info(template_id, update_template_data, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PDFApi.update_template ...'
  end
  # verify the required parameter 'template_id' is set
  if @api_client.config.client_side_validation && template_id.nil?
    fail ArgumentError, "Missing the required parameter 'template_id' when calling PDFApi.update_template"
  end
  # verify the required parameter 'update_template_data' is set
  if @api_client.config.client_side_validation && update_template_data.nil?
    fail ArgumentError, "Missing the required parameter 'update_template_data' when calling PDFApi.update_template"
  end
  # resource path
  local_var_path = '/templates/{template_id}'.sub('{' + 'template_id' + '}', template_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(update_template_data)
  auth_names = ['api_token_basic']
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'UpdateTemplateResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PDFApi#update_template\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end