Class: DocSpring::PDFApi

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

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, data, opts = {}) ⇒ TemplateAddFieldsResponse

Add new fields to a Template

Parameters:

  • template_id (String)
  • data (AddFieldsData)
  • 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, data, opts = {})
  data, _status_code, _headers = add_fields_to_template_with_http_info(template_id, data, opts)
  data
end

#add_fields_to_template_with_http_info(template_id, data, opts = {}) ⇒ Array<(TemplateAddFieldsResponse, Integer, Hash)>

Add new fields to a Template

Parameters:

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

    the optional parameters

Returns:

  • (Array<(TemplateAddFieldsResponse, Integer, Hash)>) —

    TemplateAddFieldsResponse 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
80
81
82
83
84
85
86
87
88
89
90
91
92
 
# File 'lib/docspring/api/pdf_api.rb', line 37

def add_fields_to_template_with_http_info(template_id, 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 'data' is set
  if @api_client.config.client_side_validation && data.nil?
    fail ArgumentError, "Missing the required parameter 'data' when calling PDFApi.add_fields_to_template"
  end
  # resource path
  local_var_path = '/templates/{template_id}/add_fields'.sub('{' + 'template_id' + '}', CGI.escape(template_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(data)

  # return_type
  return_type = opts[:debug_return_type] || 'TemplateAddFieldsResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['api_token_basic']

  new_options = opts.merge(
    :operation => :"PDFApi.add_fields_to_template",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:PUT, local_var_path, new_options)
  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_pdfs(data, opts = {}) ⇒ BatchGeneratePdfs201Response

Generates multiple PDFs

Parameters:

Options Hash (opts):

  • :wait (Boolean) —

    Wait for submission batch to be processed before returning. Set to false to return immediately. Default: true (on sync.* subdomain) (default to true)

Returns:



99
100
101
102
 
# File 'lib/docspring/api/pdf_api.rb', line 99

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

#batch_generate_pdfs_with_http_info(data, opts = {}) ⇒ Array<(BatchGeneratePdfs201Response, Integer, Hash)>

Generates multiple PDFs

Parameters:

Options Hash (opts):

  • :wait (Boolean) —

    Wait for submission batch to be processed before returning. Set to false to return immediately. Default: true (on sync.* subdomain) (default to true)

Returns:



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
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
 
# File 'lib/docspring/api/pdf_api.rb', line 109

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

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

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(data)

  # return_type
  return_type = opts[:debug_return_type] || 'BatchGeneratePdfs201Response'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['api_token_basic']

  new_options = opts.merge(
    :operation => :"PDFApi.batch_generate_pdfs",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  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(data, opts = {}) ⇒ CreateCombinedSubmissionResponse

Merge submission PDFs, template PDFs, or custom files

Parameters:

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

    the optional parameters

Returns:



167
168
169
170
 
# File 'lib/docspring/api/pdf_api.rb', line 167

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

#combine_pdfs_with_http_info(data, opts = {}) ⇒ Array<(CreateCombinedSubmissionResponse, Integer, Hash)>

Merge submission PDFs, template PDFs, or custom files

Parameters:

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

    the optional parameters

Returns:



176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
 
# File 'lib/docspring/api/pdf_api.rb', line 176

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

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(data)

  # return_type
  return_type = opts[:debug_return_type] || 'CreateCombinedSubmissionResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['api_token_basic']

  new_options = opts.merge(
    :operation => :"PDFApi.combine_pdfs",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  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(data, opts = {}) ⇒ CreateCombinedSubmissionResponse

Merge generated PDFs together

Parameters:

Options Hash (opts):

  • :wait (Boolean) —

    Wait for combined submission to be processed before returning. Set to false to return immediately. Default: true (on sync.* subdomain) (default to true)

Returns:



234
235
236
237
 
# File 'lib/docspring/api/pdf_api.rb', line 234

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

#combine_submissions_with_http_info(data, opts = {}) ⇒ Array<(CreateCombinedSubmissionResponse, Integer, Hash)>

Merge generated PDFs together

Parameters:

Options Hash (opts):

  • :wait (Boolean) —

    Wait for combined submission to be processed before returning. Set to false to return immediately. Default: true (on sync.* subdomain) (default to true)

Returns:



244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
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
 
# File 'lib/docspring/api/pdf_api.rb', line 244

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

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

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(data)

  # return_type
  return_type = opts[:debug_return_type] || 'CreateCombinedSubmissionResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['api_token_basic']

  new_options = opts.merge(
    :operation => :"PDFApi.combine_submissions",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  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, opts = {}) ⇒ TemplatePreview

Copy a Template

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:



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

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

#copy_template_with_http_info(template_id, opts = {}) ⇒ Array<(TemplatePreview, Integer, Hash)>

Copy a Template

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:

  • (Array<(TemplatePreview, Integer, Hash)>) —

    TemplatePreview data, response status code and response headers



313
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
357
358
359
360
361
362
363
364
 
# File 'lib/docspring/api/pdf_api.rb', line 313

def copy_template_with_http_info(template_id, 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
  # resource path
  local_var_path = '/templates/{template_id}/copy'.sub('{' + 'template_id' + '}', CGI.escape(template_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(opts[:'options'])

  # return_type
  return_type = opts[:debug_return_type] || 'TemplatePreview'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['api_token_basic']

  new_options = opts.merge(
    :operation => :"PDFApi.copy_template",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  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(data, opts = {}) ⇒ CreateCustomFileResponse

Create a new custom file from a cached presign upload

Parameters:

Returns:



370
371
372
373
 
# File 'lib/docspring/api/pdf_api.rb', line 370

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

#create_custom_file_from_upload_with_http_info(data, opts = {}) ⇒ Array<(CreateCustomFileResponse, Integer, Hash)>

Create a new custom file from a cached presign upload

Parameters:

Returns:

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

    CreateCustomFileResponse data, response status code and response headers



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
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
 
# File 'lib/docspring/api/pdf_api.rb', line 379

def create_custom_file_from_upload_with_http_info(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 'data' is set
  if @api_client.config.client_side_validation && data.nil?
    fail ArgumentError, "Missing the required parameter 'data' when calling PDFApi.create_custom_file_from_upload"
  end
  # resource path
  local_var_path = '/custom_files'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(data)

  # return_type
  return_type = opts[:debug_return_type] || 'CreateCustomFileResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['api_token_basic']

  new_options = opts.merge(
    :operation => :"PDFApi.create_custom_file_from_upload",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  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_event(data_request_id, event, opts = {}) ⇒ CreateSubmissionDataRequestEventResponse

Creates a new event for emailing a signee a request for signature

Parameters:

Returns:



437
438
439
440
 
# File 'lib/docspring/api/pdf_api.rb', line 437

def create_data_request_event(data_request_id, event, opts = {})
  data, _status_code, _headers = create_data_request_event_with_http_info(data_request_id, event, opts)
  data
end

#create_data_request_event_with_http_info(data_request_id, event, opts = {}) ⇒ Array<(CreateSubmissionDataRequestEventResponse, Integer, Hash)>

Creates a new event for emailing a signee a request for signature

Parameters:

Returns:



447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
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
 
# File 'lib/docspring/api/pdf_api.rb', line 447

def create_data_request_event_with_http_info(data_request_id, event, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PDFApi.create_data_request_event ...'
  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_event"
  end
  # verify the required parameter 'event' is set
  if @api_client.config.client_side_validation && event.nil?
    fail ArgumentError, "Missing the required parameter 'event' when calling PDFApi.create_data_request_event"
  end
  # resource path
  local_var_path = '/data_requests/{data_request_id}/events'.sub('{' + 'data_request_id' + '}', CGI.escape(data_request_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(event)

  # return_type
  return_type = opts[:debug_return_type] || 'CreateSubmissionDataRequestEventResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['api_token_basic']

  new_options = opts.merge(
    :operation => :"PDFApi.create_data_request_event",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PDFApi#create_data_request_event\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 (String)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :type (String)

Returns:



509
510
511
512
 
# File 'lib/docspring/api/pdf_api.rb', line 509

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, Integer, Hash)>

Creates a new data request token for form authentication

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :type (String)

Returns:



519
520
521
522
523
524
525
526
527
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
567
568
569
570
 
# File 'lib/docspring/api/pdf_api.rb', line 519

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
  allowable_values = ["api", "email"]
  if @api_client.config.client_side_validation && opts[:'type'] && !allowable_values.include?(opts[:'type'])
    fail ArgumentError, "invalid value for \"type\", must be one of #{allowable_values}"
  end
  # resource path
  local_var_path = '/data_requests/{data_request_id}/tokens'.sub('{' + 'data_request_id' + '}', CGI.escape(data_request_id.to_s))

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

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

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'CreateSubmissionDataRequestTokenResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['api_token_basic']

  new_options = opts.merge(
    :operation => :"PDFApi.create_data_request_token",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  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(data, opts = {}) ⇒ Folder

Create a folder

Parameters:

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

    the optional parameters

Returns:



576
577
578
579
 
# File 'lib/docspring/api/pdf_api.rb', line 576

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

#create_folder_with_http_info(data, opts = {}) ⇒ Array<(Folder, Integer, Hash)>

Create a folder

Parameters:

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

    the optional parameters

Returns:

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

    Folder 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
631
632
633
634
635
636
 
# File 'lib/docspring/api/pdf_api.rb', line 585

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

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(data)

  # return_type
  return_type = opts[:debug_return_type] || 'Folder'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['api_token_basic']

  new_options = opts.merge(
    :operation => :"PDFApi.create_folder",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  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(data, opts = {}) ⇒ TemplatePreview

Create a new HTML template

Parameters:

Returns:



642
643
644
645
 
# File 'lib/docspring/api/pdf_api.rb', line 642

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

#create_html_template_with_http_info(data, opts = {}) ⇒ Array<(TemplatePreview, Integer, Hash)>

Create a new HTML template

Parameters:

Returns:

  • (Array<(TemplatePreview, Integer, Hash)>) —

    TemplatePreview data, response status code and response headers



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
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
 
# File 'lib/docspring/api/pdf_api.rb', line 651

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

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(data)

  # return_type
  return_type = opts[:debug_return_type] || 'TemplatePreview'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['api_token_basic']

  new_options = opts.merge(
    :operation => :"PDFApi.create_html_template",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  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 = {}) ⇒ TemplatePreview

Create a new PDF template with a form POST file upload

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :wait (Boolean) —

    Wait for template document to be processed before returning. Set to false to return immediately. Default: true (on sync.* subdomain) (default to true)

  • :template_description (String)
  • :template_parent_folder_id (String)

Returns:



712
713
714
715
 
# File 'lib/docspring/api/pdf_api.rb', line 712

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(data, opts = {}) ⇒ TemplatePreview

Create a new PDF template from a cached presign upload

Parameters:

Returns:



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

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

#create_pdf_template_from_upload_with_http_info(data, opts = {}) ⇒ Array<(TemplatePreview, Integer, Hash)>

Create a new PDF template from a cached presign upload

Parameters:

Returns:

  • (Array<(TemplatePreview, Integer, Hash)>) —

    TemplatePreview 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
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
 
# File 'lib/docspring/api/pdf_api.rb', line 800

def create_pdf_template_from_upload_with_http_info(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 'data' is set
  if @api_client.config.client_side_validation && data.nil?
    fail ArgumentError, "Missing the required parameter 'data' when calling PDFApi.create_pdf_template_from_upload"
  end
  # resource path
  local_var_path = '/templates?endpoint_description=cached_upload'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(data)

  # return_type
  return_type = opts[:debug_return_type] || 'TemplatePreview'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['api_token_basic']

  new_options = opts.merge(
    :operation => :"PDFApi.create_pdf_template_from_upload",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  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<(TemplatePreview, Integer, Hash)>

Create a new PDF template with a form POST file upload

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :wait (Boolean) —

    Wait for template document to be processed before returning. Set to false to return immediately. Default: true (on sync.* subdomain) (default to true)

  • :template_description (String)
  • :template_parent_folder_id (String)

Returns:

  • (Array<(TemplatePreview, Integer, Hash)>) —

    TemplatePreview data, response status code and response headers



725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
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 725

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 = opts[:query_params] || {}
  query_params[:'wait'] = opts[:'wait'] if !opts[:'wait'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['multipart/form-data'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

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

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'TemplatePreview'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['api_token_basic']

  new_options = opts.merge(
    :operation => :"PDFApi.create_pdf_template",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  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 (String)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



857
858
859
860
 
# File 'lib/docspring/api/pdf_api.rb', line 857

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, Integer, Hash)>

Delete a folder

Parameters:

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

    the optional parameters

Returns:

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

    Folder data, response status code and response headers



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
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
 
# File 'lib/docspring/api/pdf_api.rb', line 866

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' + '}', CGI.escape(folder_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

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

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'Folder'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['api_token_basic']

  new_options = opts.merge(
    :operation => :"PDFApi.delete_folder",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options)
  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

#delete_template(template_id, opts = {}) ⇒ SuccessMultipleErrorsResponse

Delete a template

Parameters:

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

    the optional parameters

Returns:



918
919
920
921
 
# File 'lib/docspring/api/pdf_api.rb', line 918

def delete_template(template_id, opts = {})
  data, _status_code, _headers = delete_template_with_http_info(template_id, opts)
  data
end

#delete_template_with_http_info(template_id, opts = {}) ⇒ Array<(SuccessMultipleErrorsResponse, Integer, Hash)>

Delete a template

Parameters:

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

    the optional parameters

Returns:



927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
 
# File 'lib/docspring/api/pdf_api.rb', line 927

def delete_template_with_http_info(template_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PDFApi.delete_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.delete_template"
  end
  # resource path
  local_var_path = '/templates/{template_id}'.sub('{' + 'template_id' + '}', CGI.escape(template_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

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

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'SuccessMultipleErrorsResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['api_token_basic']

  new_options = opts.merge(
    :operation => :"PDFApi.delete_template",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PDFApi#delete_template\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 (String)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



979
980
981
982
 
# File 'lib/docspring/api/pdf_api.rb', line 979

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, Integer, Hash)>

Expire a combined submission

Parameters:

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

    the optional parameters

Returns:

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

    CombinedSubmission data, response status code and response headers



988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
 
# File 'lib/docspring/api/pdf_api.rb', line 988

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' + '}', CGI.escape(combined_submission_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

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

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'CombinedSubmission'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['api_token_basic']

  new_options = opts.merge(
    :operation => :"PDFApi.expire_combined_submission",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options)
  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 = {}) ⇒ SubmissionPreview

Expire a PDF submission

Parameters:

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

    the optional parameters

Returns:



1040
1041
1042
1043
 
# File 'lib/docspring/api/pdf_api.rb', line 1040

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<(SubmissionPreview, Integer, Hash)>

Expire a PDF submission

Parameters:

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

    the optional parameters

Returns:

  • (Array<(SubmissionPreview, Integer, Hash)>) —

    SubmissionPreview data, response status code and response headers



1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
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
1094
1095
 
# File 'lib/docspring/api/pdf_api.rb', line 1049

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' + '}', CGI.escape(submission_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

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

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'SubmissionPreview'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['api_token_basic']

  new_options = opts.merge(
    :operation => :"PDFApi.expire_submission",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options)
  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, opts = {}) ⇒ CreateSubmissionResponse

Generates a new PDF

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :wait (Boolean) —

    Wait for submission to be processed before returning. Set to false to return immediately. Default: true (on sync.* subdomain) (default to true)

Returns:



1103
1104
1105
1106
 
# File 'lib/docspring/api/pdf_api.rb', line 1103

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

#generate_pdf_for_html_template(template_id, submission, opts = {}) ⇒ CreateSubmissionResponse

Generates a new PDF for an HTML template

Parameters:

Options Hash (opts):

  • :wait (Boolean) —

    Wait for submission to be processed before returning. Set to false to return immediately. Default: true (on sync.* subdomain) (default to true)

Returns:



1178
1179
1180
1181
 
# File 'lib/docspring/api/pdf_api.rb', line 1178

def generate_pdf_for_html_template(template_id, submission, opts = {})
  data, _status_code, _headers = generate_pdf_for_html_template_with_http_info(template_id, submission, opts)
  data
end

#generate_pdf_for_html_template_with_http_info(template_id, submission, opts = {}) ⇒ Array<(CreateSubmissionResponse, Integer, Hash)>

Generates a new PDF for an HTML template

Parameters:

Options Hash (opts):

  • :wait (Boolean) —

    Wait for submission to be processed before returning. Set to false to return immediately. Default: true (on sync.* subdomain) (default to true)

Returns:

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

    CreateSubmissionResponse data, response status code and response headers



1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
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
 
# File 'lib/docspring/api/pdf_api.rb', line 1189

def generate_pdf_for_html_template_with_http_info(template_id, submission, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PDFApi.generate_pdf_for_html_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.generate_pdf_for_html_template"
  end
  # verify the required parameter 'submission' is set
  if @api_client.config.client_side_validation && submission.nil?
    fail ArgumentError, "Missing the required parameter 'submission' when calling PDFApi.generate_pdf_for_html_template"
  end
  # resource path
  local_var_path = '/templates/{template_id}/submissions?endpoint_description=html_templates'.sub('{' + 'template_id' + '}', CGI.escape(template_id.to_s))

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

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(submission)

  # return_type
  return_type = opts[:debug_return_type] || 'CreateSubmissionResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['api_token_basic']

  new_options = opts.merge(
    :operation => :"PDFApi.generate_pdf_for_html_template",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PDFApi#generate_pdf_for_html_template\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

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

Generates a new PDF

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :wait (Boolean) —

    Wait for submission to be processed before returning. Set to false to return immediately. Default: true (on sync.* subdomain) (default to true)

Returns:

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

    CreateSubmissionResponse data, response status code and response headers



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
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
 
# File 'lib/docspring/api/pdf_api.rb', line 1114

def generate_pdf_with_http_info(template_id, submission, 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' is set
  if @api_client.config.client_side_validation && submission.nil?
    fail ArgumentError, "Missing the required parameter 'submission' when calling PDFApi.generate_pdf"
  end
  # resource path
  local_var_path = '/templates/{template_id}/submissions'.sub('{' + 'template_id' + '}', CGI.escape(template_id.to_s))

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

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(submission)

  # return_type
  return_type = opts[:debug_return_type] || 'CreateSubmissionResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['api_token_basic']

  new_options = opts.merge(
    :operation => :"PDFApi.generate_pdf",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  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

#generate_preview(submission_id, opts = {}) ⇒ SuccessErrorResponse

Generated a preview PDF for partially completed data requests

Parameters:

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

    the optional parameters

Returns:



1251
1252
1253
1254
 
# File 'lib/docspring/api/pdf_api.rb', line 1251

def generate_preview(submission_id, opts = {})
  data, _status_code, _headers = generate_preview_with_http_info(submission_id, opts)
  data
end

#generate_preview_with_http_info(submission_id, opts = {}) ⇒ Array<(SuccessErrorResponse, Integer, Hash)>

Generated a preview PDF for partially completed data requests

Parameters:

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

    the optional parameters

Returns:

  • (Array<(SuccessErrorResponse, Integer, Hash)>) —

    SuccessErrorResponse data, response status code and response headers



1260
1261
1262
1263
1264
1265
1266
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
1304
1305
1306
 
# File 'lib/docspring/api/pdf_api.rb', line 1260

def generate_preview_with_http_info(submission_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PDFApi.generate_preview ...'
  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.generate_preview"
  end
  # resource path
  local_var_path = '/submissions/{submission_id}/generate_preview'.sub('{' + 'submission_id' + '}', CGI.escape(submission_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

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

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'SuccessErrorResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['api_token_basic']

  new_options = opts.merge(
    :operation => :"PDFApi.generate_preview",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PDFApi#generate_preview\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 (String)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



1312
1313
1314
1315
 
# File 'lib/docspring/api/pdf_api.rb', line 1312

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, Integer, Hash)>

Check the status of a combined submission (merged PDFs)

Parameters:

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

    the optional parameters

Returns:

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

    CombinedSubmission data, response status code and response headers



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
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
 
# File 'lib/docspring/api/pdf_api.rb', line 1321

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' + '}', CGI.escape(combined_submission_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

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

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'CombinedSubmission'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['api_token_basic']

  new_options = opts.merge(
    :operation => :"PDFApi.get_combined_submission",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  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 = {}) ⇒ SubmissionDataRequestShow

Look up a submission data request

Parameters:

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

    the optional parameters

Returns:



1373
1374
1375
1376
 
# File 'lib/docspring/api/pdf_api.rb', line 1373

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<(SubmissionDataRequestShow, Integer, Hash)>

Look up a submission data request

Parameters:

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

    the optional parameters

Returns:

  • (Array<(SubmissionDataRequestShow, Integer, Hash)>) —

    SubmissionDataRequestShow data, response status code and response headers



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
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
 
# File 'lib/docspring/api/pdf_api.rb', line 1382

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' + '}', CGI.escape(data_request_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

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

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'SubmissionDataRequestShow'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['api_token_basic']

  new_options = opts.merge(
    :operation => :"PDFApi.get_data_request",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  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 = {}) ⇒ Template

Fetch the full template attributes

Parameters:

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

    the optional parameters

Returns:



1434
1435
1436
1437
 
# File 'lib/docspring/api/pdf_api.rb', line 1434

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<(Template, Integer, Hash)>

Fetch the full template attributes

Parameters:

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

    the optional parameters

Returns:

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

    Template data, response status code and response headers



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
1484
1485
1486
1487
1488
1489
 
# File 'lib/docspring/api/pdf_api.rb', line 1443

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' + '}', CGI.escape(template_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

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

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'Template'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['api_token_basic']

  new_options = opts.merge(
    :operation => :"PDFApi.get_full_template",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  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 = {}) ⇒ UploadPresignResponse

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:



1494
1495
1496
1497
 
# File 'lib/docspring/api/pdf_api.rb', line 1494

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<(UploadPresignResponse, Integer, 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<(UploadPresignResponse, Integer, Hash)>) —

    UploadPresignResponse data, response status code and response headers



1502
1503
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
 
# File 'lib/docspring/api/pdf_api.rb', line 1502

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 = opts[:query_params] || {}

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

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'UploadPresignResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['api_token_basic']

  new_options = opts.merge(
    :operation => :"PDFApi.get_presign_url",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  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 (String)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :include_data (Boolean)

Returns:



1551
1552
1553
1554
 
# File 'lib/docspring/api/pdf_api.rb', line 1551

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 = {}) ⇒ SubmissionBatchWithSubmissions

Check the status of a submission batch job

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :include_submissions (Boolean)

Returns:



1615
1616
1617
1618
 
# File 'lib/docspring/api/pdf_api.rb', line 1615

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<(SubmissionBatchWithSubmissions, Integer, Hash)>

Check the status of a submission batch job

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :include_submissions (Boolean)

Returns:



1625
1626
1627
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
1671
1672
 
# File 'lib/docspring/api/pdf_api.rb', line 1625

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' + '}', CGI.escape(submission_batch_id.to_s))

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

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

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'SubmissionBatchWithSubmissions'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['api_token_basic']

  new_options = opts.merge(
    :operation => :"PDFApi.get_submission_batch",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  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, Integer, Hash)>

Check the status of a PDF

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :include_data (Boolean)

Returns:

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

    Submission data, response status code and response headers



1561
1562
1563
1564
1565
1566
1567
1568
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
 
# File 'lib/docspring/api/pdf_api.rb', line 1561

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' + '}', CGI.escape(submission_id.to_s))

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

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

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'Submission'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['api_token_basic']

  new_options = opts.merge(
    :operation => :"PDFApi.get_submission",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  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 = {}) ⇒ TemplatePreview

Check the status of an uploaded template

Parameters:

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

    the optional parameters

Returns:



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

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 = {}) ⇒ JsonSchema

Fetch the JSON schema for a template

Parameters:

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

    the optional parameters

Returns:



1739
1740
1741
1742
 
# File 'lib/docspring/api/pdf_api.rb', line 1739

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<(JsonSchema, Integer, Hash)>

Fetch the JSON schema for a template

Parameters:

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

    the optional parameters

Returns:

  • (Array<(JsonSchema, Integer, Hash)>) —

    JsonSchema data, response status code and response headers



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
1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
1790
1791
1792
1793
1794
 
# File 'lib/docspring/api/pdf_api.rb', line 1748

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' + '}', CGI.escape(template_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

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

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'JsonSchema'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['api_token_basic']

  new_options = opts.merge(
    :operation => :"PDFApi.get_template_schema",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  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<(TemplatePreview, Integer, Hash)>

Check the status of an uploaded template

Parameters:

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

    the optional parameters

Returns:

  • (Array<(TemplatePreview, Integer, Hash)>) —

    TemplatePreview data, 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
1729
1730
1731
1732
1733
 
# File 'lib/docspring/api/pdf_api.rb', line 1687

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' + '}', CGI.escape(template_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

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

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'TemplatePreview'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['api_token_basic']

  new_options = opts.merge(
    :operation => :"PDFApi.get_template",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  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_combined_submissions(opts = {}) ⇒ Array<CombinedSubmission>

Get a list of all combined submissions

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :page (Integer) —

    Default: 1

  • :per_page (Integer) —

    Default: 50

Returns:



1801
1802
1803
1804
 
# File 'lib/docspring/api/pdf_api.rb', line 1801

def list_combined_submissions(opts = {})
  data, _status_code, _headers = list_combined_submissions_with_http_info(opts)
  data
end

#list_combined_submissions_with_http_info(opts = {}) ⇒ Array<(Array<CombinedSubmission>, Integer, Hash)>

Get a list of all combined submissions

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :page (Integer) —

    Default: 1

  • :per_page (Integer) —

    Default: 50

Returns:

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

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



1811
1812
1813
1814
1815
1816
1817
1818
1819
1820
1821
1822
1823
1824
1825
1826
1827
1828
1829
1830
1831
1832
1833
1834
1835
1836
1837
1838
1839
1840
1841
1842
1843
1844
1845
1846
1847
1848
1849
1850
1851
1852
1853
1854
1855
1856
1857
1858
1859
1860
1861
1862
1863
1864
1865
1866
1867
 
# File 'lib/docspring/api/pdf_api.rb', line 1811

def list_combined_submissions_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PDFApi.list_combined_submissions ...'
  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_combined_submissions, 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_combined_submissions, 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_combined_submissions, must be greater than or equal to 1.'
  end

  # resource path
  local_var_path = '/combined_submissions'

  # query parameters
  query_params = opts[:query_params] || {}
  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 = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'Array<CombinedSubmission>'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['api_token_basic']

  new_options = opts.merge(
    :operation => :"PDFApi.list_combined_submissions",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PDFApi#list_combined_submissions\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:



1873
1874
1875
1876
 
# File 'lib/docspring/api/pdf_api.rb', line 1873

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>, Integer, 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>, Integer, Hash)>) —

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



1882
1883
1884
1885
1886
1887
1888
1889
1890
1891
1892
1893
1894
1895
1896
1897
1898
1899
1900
1901
1902
1903
1904
1905
1906
1907
1908
1909
1910
1911
1912
1913
1914
1915
1916
1917
1918
1919
1920
1921
1922
1923
1924
1925
 
# File 'lib/docspring/api/pdf_api.rb', line 1882

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 = opts[:query_params] || {}
  query_params[:'parent_folder_id'] = opts[:'parent_folder_id'] if !opts[:'parent_folder_id'].nil?

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

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'Array<Folder>'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['api_token_basic']

  new_options = opts.merge(
    :operation => :"PDFApi.list_folders",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  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:



1936
1937
1938
1939
 
# File 'lib/docspring/api/pdf_api.rb', line 1936

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

#list_submissions_with_http_info(opts = {}) ⇒ Array<(ListSubmissionsResponse, Integer, 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, Integer, Hash)>) —

    ListSubmissionsResponse data, response status code and response headers



1950
1951
1952
1953
1954
1955
1956
1957
1958
1959
1960
1961
1962
1963
1964
1965
1966
1967
1968
1969
1970
1971
1972
1973
1974
1975
1976
1977
1978
1979
1980
1981
1982
1983
1984
1985
1986
1987
1988
1989
1990
1991
1992
1993
1994
1995
1996
1997
1998
 
# File 'lib/docspring/api/pdf_api.rb', line 1950

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 = opts[: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 = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'ListSubmissionsResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['api_token_basic']

  new_options = opts.merge(
    :operation => :"PDFApi.list_submissions",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  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_template_submissions(template_id, opts = {}) ⇒ ListSubmissionsResponse

List all submissions for a given template

Parameters:

  • template_id (String)
  • 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:



2010
2011
2012
2013
 
# File 'lib/docspring/api/pdf_api.rb', line 2010

def list_template_submissions(template_id, opts = {})
  data, _status_code, _headers = list_template_submissions_with_http_info(template_id, opts)
  data
end

#list_template_submissions_with_http_info(template_id, opts = {}) ⇒ Array<(ListSubmissionsResponse, Integer, Hash)>

List all submissions for a given template

Parameters:

  • template_id (String)
  • 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, Integer, Hash)>) —

    ListSubmissionsResponse data, response status code and response headers



2025
2026
2027
2028
2029
2030
2031
2032
2033
2034
2035
2036
2037
2038
2039
2040
2041
2042
2043
2044
2045
2046
2047
2048
2049
2050
2051
2052
2053
2054
2055
2056
2057
2058
2059
2060
2061
2062
2063
2064
2065
2066
2067
2068
2069
2070
2071
2072
2073
2074
2075
2076
2077
 
# File 'lib/docspring/api/pdf_api.rb', line 2025

def list_template_submissions_with_http_info(template_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PDFApi.list_template_submissions ...'
  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_template_submissions"
  end
  # resource path
  local_var_path = '/templates/{template_id}/submissions'.sub('{' + 'template_id' + '}', CGI.escape(template_id.to_s))

  # query parameters
  query_params = opts[: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 = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'ListSubmissionsResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['api_token_basic']

  new_options = opts.merge(
    :operation => :"PDFApi.list_template_submissions",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PDFApi#list_template_submissions\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

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

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:



2086
2087
2088
2089
 
# File 'lib/docspring/api/pdf_api.rb', line 2086

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

#list_templates_with_http_info(opts = {}) ⇒ Array<(Array<TemplatePreview>, Integer, 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<TemplatePreview>, Integer, Hash)>) —

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



2098
2099
2100
2101
2102
2103
2104
2105
2106
2107
2108
2109
2110
2111
2112
2113
2114
2115
2116
2117
2118
2119
2120
2121
2122
2123
2124
2125
2126
2127
2128
2129
2130
2131
2132
2133
2134
2135
2136
2137
2138
2139
2140
2141
2142
2143
2144
2145
2146
2147
2148
2149
2150
2151
2152
2153
2154
2155
2156
 
# File 'lib/docspring/api/pdf_api.rb', line 2098

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 = opts[: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 = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'Array<TemplatePreview>'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['api_token_basic']

  new_options = opts.merge(
    :operation => :"PDFApi.list_templates",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  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, data, opts = {}) ⇒ Folder

Move a folder

Parameters:

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

    the optional parameters

Returns:



2163
2164
2165
2166
 
# File 'lib/docspring/api/pdf_api.rb', line 2163

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

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

Move a folder

Parameters:

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

    the optional parameters

Returns:

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

    Folder data, response status code and response headers



2173
2174
2175
2176
2177
2178
2179
2180
2181
2182
2183
2184
2185
2186
2187
2188
2189
2190
2191
2192
2193
2194
2195
2196
2197
2198
2199
2200
2201
2202
2203
2204
2205
2206
2207
2208
2209
2210
2211
2212
2213
2214
2215
2216
2217
2218
2219
2220
2221
2222
2223
2224
2225
2226
2227
2228
 
# File 'lib/docspring/api/pdf_api.rb', line 2173

def move_folder_to_folder_with_http_info(folder_id, 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 'data' is set
  if @api_client.config.client_side_validation && data.nil?
    fail ArgumentError, "Missing the required parameter 'data' when calling PDFApi.move_folder_to_folder"
  end
  # resource path
  local_var_path = '/folders/{folder_id}/move'.sub('{' + 'folder_id' + '}', CGI.escape(folder_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(data)

  # return_type
  return_type = opts[:debug_return_type] || 'Folder'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['api_token_basic']

  new_options = opts.merge(
    :operation => :"PDFApi.move_folder_to_folder",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  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, data, opts = {}) ⇒ TemplatePreview

Move Template to folder

Parameters:

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

    the optional parameters

Returns:



2235
2236
2237
2238
 
# File 'lib/docspring/api/pdf_api.rb', line 2235

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

#move_template_to_folder_with_http_info(template_id, data, opts = {}) ⇒ Array<(TemplatePreview, Integer, Hash)>

Move Template to folder

Parameters:

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

    the optional parameters

Returns:

  • (Array<(TemplatePreview, Integer, Hash)>) —

    TemplatePreview data, response status code and response headers



2245
2246
2247
2248
2249
2250
2251
2252
2253
2254
2255
2256
2257
2258
2259
2260
2261
2262
2263
2264
2265
2266
2267
2268
2269
2270
2271
2272
2273
2274
2275
2276
2277
2278
2279
2280
2281
2282
2283
2284
2285
2286
2287
2288
2289
2290
2291
2292
2293
2294
2295
2296
2297
2298
2299
2300
 
# File 'lib/docspring/api/pdf_api.rb', line 2245

def move_template_to_folder_with_http_info(template_id, 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 'data' is set
  if @api_client.config.client_side_validation && data.nil?
    fail ArgumentError, "Missing the required parameter 'data' when calling PDFApi.move_template_to_folder"
  end
  # resource path
  local_var_path = '/templates/{template_id}/move'.sub('{' + 'template_id' + '}', CGI.escape(template_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(data)

  # return_type
  return_type = opts[:debug_return_type] || 'TemplatePreview'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['api_token_basic']

  new_options = opts.merge(
    :operation => :"PDFApi.move_template_to_folder",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  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, data, opts = {}) ⇒ Folder

Rename a folder

Parameters:

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

    the optional parameters

Returns:



2307
2308
2309
2310
 
# File 'lib/docspring/api/pdf_api.rb', line 2307

def rename_folder(folder_id, data, opts = {})
  data, _status_code, _headers = rename_folder_with_http_info(folder_id, data, opts)
  data
end

#rename_folder_with_http_info(folder_id, data, opts = {}) ⇒ Array<(Folder, Integer, Hash)>

Rename a folder

Parameters:

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

    the optional parameters

Returns:

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

    Folder data, response status code and response headers



2317
2318
2319
2320
2321
2322
2323
2324
2325
2326
2327
2328
2329
2330
2331
2332
2333
2334
2335
2336
2337
2338
2339
2340
2341
2342
2343
2344
2345
2346
2347
2348
2349
2350
2351
2352
2353
2354
2355
2356
2357
2358
2359
2360
2361
2362
2363
2364
2365
2366
2367
2368
2369
2370
2371
2372
 
# File 'lib/docspring/api/pdf_api.rb', line 2317

def rename_folder_with_http_info(folder_id, 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 'data' is set
  if @api_client.config.client_side_validation && data.nil?
    fail ArgumentError, "Missing the required parameter 'data' when calling PDFApi.rename_folder"
  end
  # resource path
  local_var_path = '/folders/{folder_id}/rename'.sub('{' + 'folder_id' + '}', CGI.escape(folder_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(data)

  # return_type
  return_type = opts[:debug_return_type] || 'Folder'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['api_token_basic']

  new_options = opts.merge(
    :operation => :"PDFApi.rename_folder",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  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 = {}) ⇒ SuccessErrorResponse

Test Authentication

Parameters:

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

    the optional parameters

Returns:



2377
2378
2379
2380
 
# File 'lib/docspring/api/pdf_api.rb', line 2377

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

#test_authentication_with_http_info(opts = {}) ⇒ Array<(SuccessErrorResponse, Integer, Hash)>

Test Authentication

Parameters:

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

    the optional parameters

Returns:

  • (Array<(SuccessErrorResponse, Integer, Hash)>) —

    SuccessErrorResponse data, response status code and response headers



2385
2386
2387
2388
2389
2390
2391
2392
2393
2394
2395
2396
2397
2398
2399
2400
2401
2402
2403
2404
2405
2406
2407
2408
2409
2410
2411
2412
2413
2414
2415
2416
2417
2418
2419
2420
2421
2422
2423
2424
2425
2426
2427
 
# File 'lib/docspring/api/pdf_api.rb', line 2385

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 = opts[:query_params] || {}

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

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'SuccessErrorResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['api_token_basic']

  new_options = opts.merge(
    :operation => :"PDFApi.test_authentication",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  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, data, opts = {}) ⇒ CreateSubmissionDataRequestResponse

Update a submission data request

Parameters:

Returns:



2434
2435
2436
2437
 
# File 'lib/docspring/api/pdf_api.rb', line 2434

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

#update_data_request_with_http_info(data_request_id, data, opts = {}) ⇒ Array<(CreateSubmissionDataRequestResponse, Integer, Hash)>

Update a submission data request

Parameters:

Returns:



2444
2445
2446
2447
2448
2449
2450
2451
2452
2453
2454
2455
2456
2457
2458
2459
2460
2461
2462
2463
2464
2465
2466
2467
2468
2469
2470
2471
2472
2473
2474
2475
2476
2477
2478
2479
2480
2481
2482
2483
2484
2485
2486
2487
2488
2489
2490
2491
2492
2493
2494
2495
2496
2497
2498
2499
 
# File 'lib/docspring/api/pdf_api.rb', line 2444

def update_data_request_with_http_info(data_request_id, 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 'data' is set
  if @api_client.config.client_side_validation && data.nil?
    fail ArgumentError, "Missing the required parameter 'data' when calling PDFApi.update_data_request"
  end
  # resource path
  local_var_path = '/data_requests/{data_request_id}'.sub('{' + 'data_request_id' + '}', CGI.escape(data_request_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(data)

  # return_type
  return_type = opts[:debug_return_type] || 'CreateSubmissionDataRequestResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['api_token_basic']

  new_options = opts.merge(
    :operation => :"PDFApi.update_data_request",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:PUT, local_var_path, new_options)
  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, data, opts = {}) ⇒ SuccessMultipleErrorsResponse

Update a Template

Parameters:

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

    the optional parameters

Returns:



2506
2507
2508
2509
 
# File 'lib/docspring/api/pdf_api.rb', line 2506

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

#update_template_with_http_info(template_id, data, opts = {}) ⇒ Array<(SuccessMultipleErrorsResponse, Integer, Hash)>

Update a Template

Parameters:

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

    the optional parameters

Returns:



2516
2517
2518
2519
2520
2521
2522
2523
2524
2525
2526
2527
2528
2529
2530
2531
2532
2533
2534
2535
2536
2537
2538
2539
2540
2541
2542
2543
2544
2545
2546
2547
2548
2549
2550
2551
2552
2553
2554
2555
2556
2557
2558
2559
2560
2561
2562
2563
2564
2565
2566
2567
2568
2569
2570
2571
 
# File 'lib/docspring/api/pdf_api.rb', line 2516

def update_template_with_http_info(template_id, 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 'data' is set
  if @api_client.config.client_side_validation && data.nil?
    fail ArgumentError, "Missing the required parameter 'data' when calling PDFApi.update_template"
  end
  # resource path
  local_var_path = '/templates/{template_id}'.sub('{' + 'template_id' + '}', CGI.escape(template_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(data)

  # return_type
  return_type = opts[:debug_return_type] || 'SuccessMultipleErrorsResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['api_token_basic']

  new_options = opts.merge(
    :operation => :"PDFApi.update_template",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:PUT, local_var_path, new_options)
  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