Class: DocSpring::Client

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_token_id: nil, api_token_secret: nil, api_client: nil, host: nil, region: nil) ⇒ Client 



19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
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
 
# File 'lib/docspring/api/client.rb', line 19

def initialize(api_token_id: nil, api_token_secret: nil, api_client: nil, host: nil, region: nil)
  if api_client
    @api_client = api_client
  else
    @api_client = ApiClient.default

    # Use provided credentials or fall back to ENV variables
    token_id = api_token_id || ENV.fetch('DOCSPRING_TOKEN_ID', nil)
    token_secret = api_token_secret || ENV.fetch('DOCSPRING_TOKEN_SECRET', nil)

    if token_id && token_secret
      @api_client.config.username = token_id
      @api_client.config.password = token_secret
    end

    # Resolve host from argument, DOCSPRING_HOST, or DOCSPRING_REGION (US/EU)
    resolved_host = host || ENV.fetch('DOCSPRING_HOST', nil)
    unless resolved_host
      r = (region || ENV.fetch('DOCSPRING_REGION', nil)).to_s.strip.upcase
      unless r.empty?
        case r
        when 'US' then resolved_host = 'sync.api.docspring.com'
        when 'EU' then resolved_host = 'sync.api-eu.docspring.com'
        else
          raise ArgumentError, "#{region || ENV.fetch('DOCSPRING_REGION', nil)} is not a valid region. Valid regions: US, EU"
        end
      end
    end

    if resolved_host
      scheme = 'https'
      h = resolved_host
      if h.start_with?('http://')
        scheme = 'http'
        h = h.sub(/^http:\/\//, '')
      elsif h.start_with?('https://')
        h = h.sub(/^https:\/\//, '')
      end
      @api_client.config.scheme = scheme
      @api_client.config.host = h.sub(/\/api\/v1\/?\z/, '')
      # base_path remains '/api/v1'
    end
  end
end

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



17
18
19
 
# File 'lib/docspring/api/client.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 Adds fields to a PDF template. Configure field types, positions, defaults, and formatting options.



70
71
72
73
 
# File 'lib/docspring/api/client.rb', line 70

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 Adds fields to a PDF template. Configure field types, positions, defaults, and formatting options.



81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
 
# File 'lib/docspring/api/client.rb', line 81

def add_fields_to_template_with_http_info(template_id, data, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: Client.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 Client.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 Client.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 => :"Client.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: Client#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

Generate multiple PDFs Generates up to 50 PDFs in a single request. Each submission can use a different template and data. Supports both synchronous (wait for all PDFs) and asynchronous processing. More efficient than individual requests when creating multiple PDFs. See also: - [Batch and Combine PDFs](docspring.com/docs/api-guide/generate-pdfs/batch-generate-pdfs/) - Generate and merge PDFs in one request

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)



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

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)>

Generate multiple PDFs Generates up to 50 PDFs in a single request. Each submission can use a different template and data. Supports both synchronous (wait for all PDFs) and asynchronous processing. More efficient than individual requests when creating multiple PDFs. See also: - [Batch and Combine PDFs](docspring.com/docs/api-guide/generate-pdfs/batch-generate-pdfs/) - Generate and merge PDFs in one request

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)



155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
 
# File 'lib/docspring/api/client.rb', line 155

def batch_generate_pdfs_with_http_info(data, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: Client.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 Client.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 => :"Client.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: Client#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 Combines multiple PDFs from various sources into a single PDF file. Supports merging submission PDFs, template PDFs, custom files, other merged PDFs, and PDFs from URLs. Merges the PDFs in the order provided.



214
215
216
217
 
# File 'lib/docspring/api/client.rb', line 214

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 Combines multiple PDFs from various sources into a single PDF file. Supports merging submission PDFs, template PDFs, custom files, other merged PDFs, and PDFs from URLs. Merges the PDFs in the order provided.



224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
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
 
# File 'lib/docspring/api/client.rb', line 224

def combine_pdfs_with_http_info(data, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: Client.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 Client.combine_pdfs"
  end
  # resource path
  local_var_path = '/combined_submissions'

  # 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 => :"Client.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: Client#combine_pdfs\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 Creates a copy of an existing template with all its fields and configuration. Optionally specify a new name and target folder. The copied template starts as a new draft that can be modified independently of the original.

Options Hash (opts):



283
284
285
286
 
# File 'lib/docspring/api/client.rb', line 283

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 Creates a copy of an existing template with all its fields and configuration. Optionally specify a new name and target folder. The copied template starts as a new draft that can be modified independently of the original.

Options Hash (opts):



294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
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
 
# File 'lib/docspring/api/client.rb', line 294

def copy_template_with_http_info(template_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: Client.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 Client.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 => :"Client.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: Client#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 S3 upload The Custom Files API endpoint allows you to upload PDFs to DocSpring and then merge them with other PDFs. First upload your file using the presigned URL endpoint, then use the returned cache_id to create the custom file.



352
353
354
355
 
# File 'lib/docspring/api/client.rb', line 352

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 S3 upload The Custom Files API endpoint allows you to upload PDFs to DocSpring and then merge them with other PDFs. First upload your file using the presigned URL endpoint, then use the returned cache_id to create the custom file.



362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
 
# File 'lib/docspring/api/client.rb', line 362

def create_custom_file_from_upload_with_http_info(data, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: Client.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 Client.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 => :"Client.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: Client#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

Create a new event for emailing a signee a request for signature Records user notification events for data requests. Use this to create an audit trail showing when and how users were notified about data request forms. Supports email, SMS, and other notification types. Records the notification time for compliance tracking. See also: - [Embedded Data Requests Guide](docspring.com/docs/guides/embedded-forms/embedded-data-requests/) - User notification workflow



421
422
423
424
 
# File 'lib/docspring/api/client.rb', line 421

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)>

Create a new event for emailing a signee a request for signature Records user notification events for data requests. Use this to create an audit trail showing when and how users were notified about data request forms. Supports email, SMS, and other notification types. Records the notification time for compliance tracking. See also: - [Embedded Data Requests Guide](docspring.com/docs/guides/embedded-forms/embedded-data-requests/) - User notification workflow



432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
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
 
# File 'lib/docspring/api/client.rb', line 432

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: Client.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 Client.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 Client.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 => :"Client.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: Client#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

Create a new data request token for form authentication Creates an authentication token for accessing a data request form. Tokens can be created for API access (1 hour expiration) or email links (30 day expiration). Returns a token and a pre-authenticated URL for the data request form. See also: - [Embedded Data Requests Guide](docspring.com/docs/guides/embedded-forms/embedded-data-requests/)

Options Hash (opts):

  • :type (String) 


495
496
497
498
 
# File 'lib/docspring/api/client.rb', line 495

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)>

Create a new data request token for form authentication Creates an authentication token for accessing a data request form. Tokens can be created for API access (1 hour expiration) or email links (30 day expiration). Returns a token and a pre-authenticated URL for the data request form. See also: - [Embedded Data Requests Guide](docspring.com/docs/guides/embedded-forms/embedded-data-requests/)

Options Hash (opts):

  • :type (String) 


506
507
508
509
510
511
512
513
514
515
516
517
518
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
 
# File 'lib/docspring/api/client.rb', line 506

def create_data_request_token_with_http_info(data_request_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: Client.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 Client.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 => :"Client.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: Client#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 Creates a new folder for organizing templates. Folders can be nested within other folders by providing a parent_folder_id. Folder names must be unique within the same parent.



564
565
566
567
 
# File 'lib/docspring/api/client.rb', line 564

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 Creates a new folder for organizing templates. Folders can be nested within other folders by providing a &#x60;parent_folder_id&#x60;. Folder names must be unique within the same parent.



574
575
576
577
578
579
580
581
582
583
584
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
 
# File 'lib/docspring/api/client.rb', line 574

def create_folder_with_http_info(data, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: Client.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 Client.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 => :"Client.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: Client#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 Creates a new HTML template using HTML, CSS/SCSS, and Liquid templating. Allows complete control over PDF layout and styling. Supports headers, footers, and dynamic content using Liquid syntax for field values, conditions, loops, and filters.



632
633
634
635
 
# File 'lib/docspring/api/client.rb', line 632

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 Creates a new HTML template using HTML, CSS/SCSS, and Liquid templating. Allows complete control over PDF layout and styling. Supports headers, footers, and dynamic content using Liquid syntax for field values, conditions, loops, and filters.



642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
 
# File 'lib/docspring/api/client.rb', line 642

def create_html_template_with_http_info(data, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: Client.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 Client.create_html_template"
  end
  # resource path
  local_var_path = '/templates?endpoint_variant=create_html_template'

  # 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 => :"Client.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: Client#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 Creates a new PDF template by uploading a PDF file. The uploaded PDF becomes the foundation for your template, and you can then add fillable fields using the template editor. Use the wait parameter to control whether the request waits for document processing to complete.

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) 


704
705
706
707
 
# File 'lib/docspring/api/client.rb', line 704

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 S3 file upload Creates a new PDF template from a file previously uploaded to S3 using a presigned URL. This two-step process allows for more reliable large file uploads by first uploading the file to S3, then creating the template using the cached upload ID.



785
786
787
788
 
# File 'lib/docspring/api/client.rb', line 785

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 S3 file upload Creates a new PDF template from a file previously uploaded to S3 using a presigned URL. This two-step process allows for more reliable large file uploads by first uploading the file to S3, then creating the template using the cached upload ID.



795
796
797
798
799
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
 
# File 'lib/docspring/api/client.rb', line 795

def create_pdf_template_from_upload_with_http_info(data, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: Client.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 Client.create_pdf_template_from_upload"
  end
  # resource path
  local_var_path = '/templates?endpoint_variant=create_template_from_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 => :"Client.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: Client#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 Creates a new PDF template by uploading a PDF file. The uploaded PDF becomes the foundation for your template, and you can then add fillable fields using the template editor. Use the wait parameter to control whether the request waits for document processing to complete.

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) 


718
719
720
721
722
723
724
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
 
# File 'lib/docspring/api/client.rb', line 718

def create_pdf_template_with_http_info(template_document, template_name, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: Client.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 Client.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 Client.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 => :"Client.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: Client#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 Deletes an empty folder. The folder must not contain any templates or subfolders. Move or delete all contents before attempting to delete the folder.



853
854
855
856
 
# File 'lib/docspring/api/client.rb', line 853

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 Deletes an empty folder. The folder must not contain any templates or subfolders. Move or delete all contents before attempting to delete the folder.



863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
 
# File 'lib/docspring/api/client.rb', line 863

def delete_folder_with_http_info(folder_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: Client.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 Client.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 => :"Client.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: Client#delete_folder\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

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

Delete a template Deletes a template or a specific template version. When no version is specified, deletes the entire template including all versions. When a version is specified, deletes only that version while preserving others. Returns remaining version information.

Options Hash (opts):

  • :version (String) 


917
918
919
920
 
# File 'lib/docspring/api/client.rb', line 917

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

Delete a template Deletes a template or a specific template version. When no version is specified, deletes the entire template including all versions. When a version is specified, deletes only that version while preserving others. Returns remaining version information.

Options Hash (opts):

  • :version (String) 


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
974
975
 
# File 'lib/docspring/api/client.rb', line 928

def delete_template_with_http_info(template_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: Client.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 Client.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] || {}
  query_params[:'version'] = opts[:'version'] if !opts[:'version'].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] || 'TemplateDeleteResponse'

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

  new_options = opts.merge(
    :operation => :"Client.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: Client#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 Expiring a combined submission deletes the PDF from our system. This is useful for invalidating sensitive documents.



982
983
984
985
 
# File 'lib/docspring/api/client.rb', line 982

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 Expiring a combined submission deletes the PDF from our system. This is useful for invalidating sensitive documents.



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
1035
1036
1037
1038
 
# File 'lib/docspring/api/client.rb', line 992

def expire_combined_submission_with_http_info(combined_submission_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: Client.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 Client.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 => :"Client.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: Client#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 Expiring a PDF submission deletes the PDF and removes the data from our database. This is useful for invalidating sensitive documents after they’ve been downloaded. You can also [configure a data retention policy for your submissions](docspring.com/docs/template-editor/settings/#expire-submissions) so that they automatically expire.



1045
1046
1047
1048
 
# File 'lib/docspring/api/client.rb', line 1045

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 Expiring a PDF submission deletes the PDF and removes the data from our database. This is useful for invalidating sensitive documents after they&#39;ve been downloaded. You can also [configure a data retention policy for your submissions](docspring.com/docs/template-editor/settings/#expire-submissions) so that they automatically expire.



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
1096
1097
1098
1099
1100
1101
 
# File 'lib/docspring/api/client.rb', line 1055

def expire_submission_with_http_info(submission_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: Client.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 Client.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 => :"Client.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: Client#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

Generate a PDF Creates a PDF submission by filling in a template with data. Supports both synchronous (default) and asynchronous processing. Set ‘wait: false` to return immediately. See also: - [Customize the PDF Title and Filename](docspring.com/docs/api-guide/generate-pdfs/customize-pdf-title-and-filename/) - Set custom metadata - [Handling Truncated Text](docspring.com/docs/api-guide/generate-pdfs/handle-truncated-text/) - Handle text that doesn’t fit in fields

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)



1110
1111
1112
1113
 
# File 'lib/docspring/api/client.rb', line 1110

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

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

Generate a PDF Creates a PDF submission by filling in a template with data. Supports both synchronous (default) and asynchronous processing. Set &#x60;wait: false&#x60; to return immediately. See also: - [Customize the PDF Title and Filename](docspring.com/docs/api-guide/generate-pdfs/customize-pdf-title-and-filename/) - Set custom metadata - [Handling Truncated Text](docspring.com/docs/api-guide/generate-pdfs/handle-truncated-text/) - Handle text that doesn&#39;t fit in fields

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)



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
1171
1172
1173
1174
1175
1176
1177
1178
 
# File 'lib/docspring/api/client.rb', line 1122

def generate_pdf_with_http_info(template_id, submission, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: Client.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 Client.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 Client.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 => :"Client.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: Client#generate_pdf\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

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

Generate a preview PDF for partially completed data requests Generates a preview PDF for a submission with partially completed data requests. Useful for showing users what the final document will look like before all signatures or data have been collected. The preview includes any data collected so far.



1185
1186
1187
1188
 
# File 'lib/docspring/api/client.rb', line 1185

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)>

Generate a preview PDF for partially completed data requests Generates a preview PDF for a submission with partially completed data requests. Useful for showing users what the final document will look like before all signatures or data have been collected. The preview includes any data collected so far.



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
 
# File 'lib/docspring/api/client.rb', line 1195

def generate_preview_with_http_info(submission_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: Client.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 Client.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 => :"Client.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: Client#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) Retrieves the details and status of a combined submission. Returns processing state, download URL (if processed), metadata, and information about any integrated actions (e.g., S3 uploads).



1248
1249
1250
1251
 
# File 'lib/docspring/api/client.rb', line 1248

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) Retrieves the details and status of a combined submission. Returns processing state, download URL (if processed), metadata, and information about any integrated actions (e.g., S3 uploads).



1258
1259
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
 
# File 'lib/docspring/api/client.rb', line 1258

def get_combined_submission_with_http_info(combined_submission_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: Client.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 Client.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 => :"Client.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: Client#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 Retrieves the details and status of a data request. Returns information about the request state (pending, viewed, completed), authentication details, and metadata. Includes audit information like IP address, browseruser agent, and timestamps. See also: - [Embedded Data Requests Guide](docspring.com/docs/guides/embedded-forms/embedded-data-requests/) - Complete guide to data request workflow



1311
1312
1313
1314
 
# File 'lib/docspring/api/client.rb', line 1311

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 Retrieves the details and status of a data request. Returns information about the request state (pending, viewed, completed), authentication details, and metadata. Includes audit information like IP address, browseruser agent, and timestamps. See also: - [Embedded Data Requests Guide](docspring.com/docs/guides/embedded-forms/embedded-data-requests/) - Complete guide to data request workflow



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/client.rb', line 1321

def get_data_request_with_http_info(data_request_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: Client.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 Client.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 => :"Client.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: Client#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 attributes for a PDF template Retrieves complete template information including fields, defaults, settings, and HTML/SCSS content. Use this to get all template data needed for automated updates or analysis. Returns more detailed information than the basic getTemplate endpoint.



1374
1375
1376
1377
 
# File 'lib/docspring/api/client.rb', line 1374

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 attributes for a PDF template Retrieves complete template information including fields, defaults, settings, and HTML/SCSS content. Use this to get all template data needed for automated updates or analysis. Returns more detailed information than the basic &#x60;getTemplate&#x60; endpoint.



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
1429
1430
 
# File 'lib/docspring/api/client.rb', line 1384

def get_full_template_with_http_info(template_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: Client.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 Client.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 => :"Client.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: Client#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 S3 URL for direct file upload Returns a presigned S3 URL for uploading files directly to our S3 bucket. Use this endpoint to upload large files before creating templates or custom files. S3 will respond with a JSON object that you can include in your DocSpring API request. Uploaded files can be used to: - [Create templates](docspring.com/docs/api/#tag/templates/post/templates?endpoint_variant=create_template_from_cached_upload) - [Update templates](docspring.com/docs/api/#tag/templates/put/templates/template_id?endpoint_variant=update_template_pdf_with_cached_upload) - [Create custom files](docspring.com/docs/api/#tag/custom-files/post/custom_files) and then [merge them with other PDFs](docspring.com/docs/api/#tag/combine-pdfs/post/combined_submissions)



1436
1437
1438
1439
 
# File 'lib/docspring/api/client.rb', line 1436

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 S3 URL for direct file upload Returns a presigned S3 URL for uploading files directly to our S3 bucket. Use this endpoint to upload large files before creating templates or custom files. S3 will respond with a JSON object that you can include in your DocSpring API request. Uploaded files can be used to: - [Create templates](docspring.com/docs/api/#tag/templates/post/templates?endpoint_variant&#x3D;create_template_from_cached_upload) - [Update templates](docspring.com/docs/api/#tag/templates/put/templates/template_id?endpoint_variant&#x3D;update_template_pdf_with_cached_upload) - [Create custom files](docspring.com/docs/api/#tag/custom-files/post/custom_files) and then [merge them with other PDFs](docspring.com/docs/api/#tag/combine-pdfs/post/combined_submissions)



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
 
# File 'lib/docspring/api/client.rb', line 1445

def get_presign_url_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: Client.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 => :"Client.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: Client#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 Retrieves the details and status of a PDF submission. Returns processing state, download URL (if processed), metadata, submission data (optional), and information about any integrated actions. Use this to poll for completion when using asynchronous processing.

Options Hash (opts):

  • :include_data (Boolean) 


1495
1496
1497
1498
 
# File 'lib/docspring/api/client.rb', line 1495

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 Retrieves the status and results of a batch PDF generation job. Returns processing state, completion statistics, and optionally includes all individual submission details. Use this to poll for completion when using asynchronous batch processing.

Options Hash (opts):

  • :include_submissions (Boolean) 


1561
1562
1563
1564
 
# File 'lib/docspring/api/client.rb', line 1561

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 Retrieves the status and results of a batch PDF generation job. Returns processing state, completion statistics, and optionally includes all individual submission details. Use this to poll for completion when using asynchronous batch processing.

Options Hash (opts):

  • :include_submissions (Boolean) 


1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
 
# File 'lib/docspring/api/client.rb', line 1572

def get_submission_batch_with_http_info(submission_batch_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: Client.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 Client.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 => :"Client.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: Client#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 Retrieves the details and status of a PDF submission. Returns processing state, download URL (if processed), metadata, submission data (optional), and information about any integrated actions. Use this to poll for completion when using asynchronous processing.

Options Hash (opts):

  • :include_data (Boolean) 


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

def get_submission_with_http_info(submission_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: Client.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 Client.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 => :"Client.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: Client#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 Retrieves information about a template including processing status and document URL. Use this to check if template is ready to view in the template editor or generate PDFs.



1626
1627
1628
1629
 
# File 'lib/docspring/api/client.rb', line 1626

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 Retrieves the JSON Schema definition for a template’s fields. Use this to validate data before submitting it for PDF generation, or to build dynamic forms that match the template’s field structure and validation requirements. See also: - [Generate PDFs Guide](docspring.com/docs/api-guide/generate-pdfs/generate-pdfs-via-api/) - Use schema to validate submission data



1689
1690
1691
1692
 
# File 'lib/docspring/api/client.rb', line 1689

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 Retrieves the JSON Schema definition for a template&#39;s fields. Use this to validate data before submitting it for PDF generation, or to build dynamic forms that match the template&#39;s field structure and validation requirements. See also: - [Generate PDFs Guide](docspring.com/docs/api-guide/generate-pdfs/generate-pdfs-via-api/) - Use schema to validate submission data



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
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
 
# File 'lib/docspring/api/client.rb', line 1699

def get_template_schema_with_http_info(template_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: Client.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 Client.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 => :"Client.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: Client#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 Retrieves information about a template including processing status and document URL. Use this to check if template is ready to view in the template editor or generate PDFs.



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
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
 
# File 'lib/docspring/api/client.rb', line 1636

def get_template_with_http_info(template_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: Client.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 Client.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 => :"Client.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: Client#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 Returns a paginated list of combined submissions (merged PDFs) for your account. Includes processing status, expiration details, and download URLs for processed PDFs.

Options Hash (opts):

  • :page (Integer) —

    Default: 1

  • :per_page (Integer) —

    Default: 50



1753
1754
1755
1756
 
# File 'lib/docspring/api/client.rb', line 1753

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 Returns a paginated list of combined submissions (merged PDFs) for your account. Includes processing status, expiration details, and download URLs for processed PDFs.

Options Hash (opts):

  • :page (Integer) —

    Default: 1

  • :per_page (Integer) —

    Default: 50



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
1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
1807
1808
1809
1810
1811
1812
1813
1814
1815
1816
1817
1818
1819
1820
 
# File 'lib/docspring/api/client.rb', line 1764

def list_combined_submissions_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: Client.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 Client.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 Client.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 Client.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 => :"Client.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: Client#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 Returns a list of folders in your account. Can be filtered by parent folder ID to retrieve subfolders. Folders help organize templates and maintain a hierarchical structure.

Options Hash (opts):

  • :parent_folder_id (String) —

    Filter By Folder Id



1827
1828
1829
1830
 
# File 'lib/docspring/api/client.rb', line 1827

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 Returns a list of folders in your account. Can be filtered by parent folder ID to retrieve subfolders. Folders help organize templates and maintain a hierarchical structure.

Options Hash (opts):

  • :parent_folder_id (String) —

    Filter By Folder Id



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
1868
1869
1870
1871
1872
1873
1874
1875
1876
1877
1878
1879
1880
 
# File 'lib/docspring/api/client.rb', line 1837

def list_folders_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: Client.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 => :"Client.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: Client#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 Returns a paginated list of all PDF submissions across all templates in your account. Can be filtered by date range and submission type (test/live). Supports cursor-based pagination and optionally includes submission data for each result.

Options Hash (opts):

  • :cursor (String)
  • :limit (Integer)
  • :created_after (String)
  • :created_before (String)
  • :type (String)
  • :include_data (Boolean) 


1892
1893
1894
1895
 
# File 'lib/docspring/api/client.rb', line 1892

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 Returns a paginated list of all PDF submissions across all templates in your account. Can be filtered by date range and submission type (test/live). Supports cursor-based pagination and optionally includes submission data for each result.

Options Hash (opts):

  • :cursor (String)
  • :limit (Integer)
  • :created_after (String)
  • :created_before (String)
  • :type (String)
  • :include_data (Boolean) 


1907
1908
1909
1910
1911
1912
1913
1914
1915
1916
1917
1918
1919
1920
1921
1922
1923
1924
1925
1926
1927
1928
1929
1930
1931
1932
1933
1934
1935
1936
1937
1938
1939
1940
1941
1942
1943
1944
1945
1946
1947
1948
1949
1950
1951
1952
1953
1954
1955
 
# File 'lib/docspring/api/client.rb', line 1907

def list_submissions_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: Client.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 => :"Client.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: Client#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 Returns a paginated list of all submissions for a specific template. Can be filtered by date range, submission type (test/live), and optionally include submission data. Supports cursor-based pagination for efficient retrieval of large result sets.

Options Hash (opts):

  • :cursor (String)
  • :limit (Integer)
  • :created_after (String)
  • :created_before (String)
  • :type (String)
  • :include_data (Boolean) 


1968
1969
1970
1971
 
# File 'lib/docspring/api/client.rb', line 1968

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 Returns a paginated list of all submissions for a specific template. Can be filtered by date range, submission type (test/live), and optionally include submission data. Supports cursor-based pagination for efficient retrieval of large result sets.

Options Hash (opts):

  • :cursor (String)
  • :limit (Integer)
  • :created_after (String)
  • :created_before (String)
  • :type (String)
  • :include_data (Boolean) 


1984
1985
1986
1987
1988
1989
1990
1991
1992
1993
1994
1995
1996
1997
1998
1999
2000
2001
2002
2003
2004
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
2025
2026
2027
2028
2029
2030
2031
2032
2033
2034
2035
2036
 
# File 'lib/docspring/api/client.rb', line 1984

def list_template_submissions_with_http_info(template_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: Client.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 Client.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 => :"Client.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: Client#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 Retrieves a list of your templates with search, filtering, and pagination options. Returns basic template information including ID, name, type (PDF or HTML), and folder location. Supports text search by name and filtering by parent folder.

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



2046
2047
2048
2049
 
# File 'lib/docspring/api/client.rb', line 2046

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 Retrieves a list of your templates with search, filtering, and pagination options. Returns basic template information including ID, name, type (PDF or HTML), and folder location. Supports text search by name and filtering by parent folder.

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



2059
2060
2061
2062
2063
2064
2065
2066
2067
2068
2069
2070
2071
2072
2073
2074
2075
2076
2077
2078
2079
2080
2081
2082
2083
2084
2085
2086
2087
2088
2089
2090
2091
2092
2093
2094
2095
2096
2097
2098
2099
2100
2101
2102
2103
2104
2105
2106
2107
2108
2109
2110
2111
2112
2113
2114
2115
2116
2117
 
# File 'lib/docspring/api/client.rb', line 2059

def list_templates_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: Client.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 Client.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 Client.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 Client.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 => :"Client.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: Client#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 Moves a folder to a new parent folder or to the root level. All templates and subfolders within the folder are moved together. Cannot move a folder into one of its own subfolders.



2125
2126
2127
2128
 
# File 'lib/docspring/api/client.rb', line 2125

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 Moves a folder to a new parent folder or to the root level. All templates and subfolders within the folder are moved together. Cannot move a folder into one of its own subfolders.



2136
2137
2138
2139
2140
2141
2142
2143
2144
2145
2146
2147
2148
2149
2150
2151
2152
2153
2154
2155
2156
2157
2158
2159
2160
2161
2162
2163
2164
2165
2166
2167
2168
2169
2170
2171
2172
2173
2174
2175
2176
2177
2178
2179
2180
2181
2182
2183
2184
2185
2186
2187
2188
2189
2190
2191
 
# File 'lib/docspring/api/client.rb', line 2136

def move_folder_to_folder_with_http_info(folder_id, data, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: Client.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 Client.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 Client.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 => :"Client.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: Client#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 Moves a template to a different folder or to the root level. Use this to organize templates within your folders. Provide a folder ID to move to a specific folder, or null to move to the root level.



2199
2200
2201
2202
 
# File 'lib/docspring/api/client.rb', line 2199

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 Moves a template to a different folder or to the root level. Use this to organize templates within your folders. Provide a folder ID to move to a specific folder, or &#x60;null&#x60; to move to the root level.



2210
2211
2212
2213
2214
2215
2216
2217
2218
2219
2220
2221
2222
2223
2224
2225
2226
2227
2228
2229
2230
2231
2232
2233
2234
2235
2236
2237
2238
2239
2240
2241
2242
2243
2244
2245
2246
2247
2248
2249
2250
2251
2252
2253
2254
2255
2256
2257
2258
2259
2260
2261
2262
2263
2264
2265
 
# File 'lib/docspring/api/client.rb', line 2210

def move_template_to_folder_with_http_info(template_id, data, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: Client.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 Client.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 Client.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 => :"Client.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: Client#move_template_to_folder\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#publish_template_version(template_id, data, opts = {}) ⇒ TemplatePublishVersionResponse

Publish a template version Publishes the current draft version of a template and creates a new immutable version with semantic versioning (major.minor.patch).



2273
2274
2275
2276
 
# File 'lib/docspring/api/client.rb', line 2273

def publish_template_version(template_id, data, opts = {})
  data, _status_code, _headers = publish_template_version_with_http_info(template_id, data, opts)
  data
end

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

Publish a template version Publishes the current draft version of a template and creates a new immutable version with semantic versioning (major.minor.patch).



2284
2285
2286
2287
2288
2289
2290
2291
2292
2293
2294
2295
2296
2297
2298
2299
2300
2301
2302
2303
2304
2305
2306
2307
2308
2309
2310
2311
2312
2313
2314
2315
2316
2317
2318
2319
2320
2321
2322
2323
2324
2325
2326
2327
2328
2329
2330
2331
2332
2333
2334
2335
2336
2337
2338
2339
 
# File 'lib/docspring/api/client.rb', line 2284

def publish_template_version_with_http_info(template_id, data, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: Client.publish_template_version ...'
  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 Client.publish_template_version"
  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 Client.publish_template_version"
  end
  # resource path
  local_var_path = '/templates/{template_id}/publish_version'.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] || 'TemplatePublishVersionResponse'

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

  new_options = opts.merge(
    :operation => :"Client.publish_template_version",
    :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: Client#publish_template_version\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 Renames an existing folder. The new name must be unique within the same parent folder. This operation only changes the folder name, not its location or contents.



2347
2348
2349
2350
 
# File 'lib/docspring/api/client.rb', line 2347

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 Renames an existing folder. The new name must be unique within the same parent folder. This operation only changes the folder name, not its location or contents.



2358
2359
2360
2361
2362
2363
2364
2365
2366
2367
2368
2369
2370
2371
2372
2373
2374
2375
2376
2377
2378
2379
2380
2381
2382
2383
2384
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
 
# File 'lib/docspring/api/client.rb', line 2358

def rename_folder_with_http_info(folder_id, data, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: Client.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 Client.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 Client.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 => :"Client.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: Client#rename_folder\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#restore_template_version(template_id, data, opts = {}) ⇒ SuccessErrorResponse

Restore a template version Restores your template to a previously published version, copying that version’s content and configuration to the current draft. Use this to revert changes or recover from an unwanted modification.



2421
2422
2423
2424
 
# File 'lib/docspring/api/client.rb', line 2421

def restore_template_version(template_id, data, opts = {})
  data, _status_code, _headers = restore_template_version_with_http_info(template_id, data, opts)
  data
end

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

Restore a template version Restores your template to a previously published version, copying that version&#39;s content and configuration to the current draft. Use this to revert changes or recover from an unwanted modification.



2432
2433
2434
2435
2436
2437
2438
2439
2440
2441
2442
2443
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
 
# File 'lib/docspring/api/client.rb', line 2432

def restore_template_version_with_http_info(template_id, data, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: Client.restore_template_version ...'
  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 Client.restore_template_version"
  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 Client.restore_template_version"
  end
  # resource path
  local_var_path = '/templates/{template_id}/restore_version'.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] || 'SuccessErrorResponse'

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

  new_options = opts.merge(
    :operation => :"Client.restore_template_version",
    :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: Client#restore_template_version\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#test_authentication(opts = {}) ⇒ SuccessErrorResponse

Test authentication Checks whether your API token is valid by making an authenticated request. Returns a success response if authentication passes. This endpoint is useful for verifying credentials during setup or troubleshooting issues.



2493
2494
2495
2496
 
# File 'lib/docspring/api/client.rb', line 2493

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 Checks whether your API token is valid by making an authenticated request. Returns a success response if authentication passes. This endpoint is useful for verifying credentials during setup or troubleshooting issues.



2502
2503
2504
2505
2506
2507
2508
2509
2510
2511
2512
2513
2514
2515
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
 
# File 'lib/docspring/api/client.rb', line 2502

def test_authentication_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: Client.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 => :"Client.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: Client#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 Updates authentication details for a data request. Use this when a user logs in to record their authentication method, provider, session information, and hashed identifiers. Updates metadata and tracks authentication state changes for auditing and compliance.



2552
2553
2554
2555
 
# File 'lib/docspring/api/client.rb', line 2552

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 Updates authentication details for a data request. Use this when a user logs in to record their authentication method, provider, session information, and hashed identifiers. Updates metadata and tracks authentication state changes for auditing and compliance.



2563
2564
2565
2566
2567
2568
2569
2570
2571
2572
2573
2574
2575
2576
2577
2578
2579
2580
2581
2582
2583
2584
2585
2586
2587
2588
2589
2590
2591
2592
2593
2594
2595
2596
2597
2598
2599
2600
2601
2602
2603
2604
2605
2606
2607
2608
2609
2610
2611
2612
2613
2614
2615
2616
2617
2618
 
# File 'lib/docspring/api/client.rb', line 2563

def update_data_request_with_http_info(data_request_id, data, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: Client.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 Client.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 Client.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 => :"Client.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: Client#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 Updates template content and properties. For HTML templates, you can modify the HTML, SCSS, headers, footers, name, and description. Changes are applied to your draft template and do not affect published template versions.



2626
2627
2628
2629
 
# File 'lib/docspring/api/client.rb', line 2626

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

#update_template_document(template_id, template_document, opts = {}) ⇒ SuccessMultipleErrorsResponse

Update a template’s document with a form POST file upload Upload a new PDF file to update a PDF template’s document. This replaces the template’s PDF while preserving all of the existing fields. If you upload a PDF with fewer pages than the current document, any fields on the removed pages will be deleted.

Options Hash (opts):

  • :template_name (String) 


2701
2702
2703
2704
 
# File 'lib/docspring/api/client.rb', line 2701

def update_template_document(template_id, template_document, opts = {})
  data, _status_code, _headers = update_template_document_with_http_info(template_id, template_document, opts)
  data
end

#update_template_document_from_upload(template_id, data, opts = {}) ⇒ SuccessMultipleErrorsResponse

Update a template’s document with a cached S3 file upload Updates a PDF template’s document using a cached file upload. This is a three-step process: First, request a presigned URL to upload your PDF file to our S3 bucket. Then, use that URL to upload your PDF file. Finally, submit the ID of the uploaded file to replace the template’s document.



2778
2779
2780
2781
 
# File 'lib/docspring/api/client.rb', line 2778

def update_template_document_from_upload(template_id, data, opts = {})
  data, _status_code, _headers = update_template_document_from_upload_with_http_info(template_id, data, opts)
  data
end

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

Update a template&#39;s document with a cached S3 file upload Updates a PDF template&#39;s document using a cached file upload. This is a three-step process: First, request a presigned URL to upload your PDF file to our S3 bucket. Then, use that URL to upload your PDF file. Finally, submit the ID of the uploaded file to replace the template&#39;s document.



2789
2790
2791
2792
2793
2794
2795
2796
2797
2798
2799
2800
2801
2802
2803
2804
2805
2806
2807
2808
2809
2810
2811
2812
2813
2814
2815
2816
2817
2818
2819
2820
2821
2822
2823
2824
2825
2826
2827
2828
2829
2830
2831
2832
2833
2834
2835
2836
2837
2838
2839
2840
2841
2842
2843
2844
 
# File 'lib/docspring/api/client.rb', line 2789

def update_template_document_from_upload_with_http_info(template_id, data, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: Client.update_template_document_from_upload ...'
  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 Client.update_template_document_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 Client.update_template_document_from_upload"
  end
  # resource path
  local_var_path = '/templates/{template_id}?endpoint_variant=update_template_pdf_with_cached_upload'.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 => :"Client.update_template_document_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(:PUT, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: Client#update_template_document_from_upload\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

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

Update a template&#39;s document with a form POST file upload Upload a new PDF file to update a PDF template&#39;s document. This replaces the template&#39;s PDF while preserving all of the existing fields. If you upload a PDF with fewer pages than the current document, any fields on the removed pages will be deleted.

Options Hash (opts):

  • :template_name (String) 


2713
2714
2715
2716
2717
2718
2719
2720
2721
2722
2723
2724
2725
2726
2727
2728
2729
2730
2731
2732
2733
2734
2735
2736
2737
2738
2739
2740
2741
2742
2743
2744
2745
2746
2747
2748
2749
2750
2751
2752
2753
2754
2755
2756
2757
2758
2759
2760
2761
2762
2763
2764
2765
2766
2767
2768
2769
2770
 
# File 'lib/docspring/api/client.rb', line 2713

def update_template_document_with_http_info(template_id, template_document, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: Client.update_template_document ...'
  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 Client.update_template_document"
  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 Client.update_template_document"
  end
  # resource path
  local_var_path = '/templates/{template_id}?endpoint_variant=update_template_pdf_with_form_post'.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(['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]'] = opts[:'template_name'] if !opts[:'template_name'].nil?

  # 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 => :"Client.update_template_document",
    :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: Client#update_template_document\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

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

Update a Template Updates template content and properties. For HTML templates, you can modify the HTML, SCSS, headers, footers, name, and description. Changes are applied to your draft template and do not affect published template versions.



2637
2638
2639
2640
2641
2642
2643
2644
2645
2646
2647
2648
2649
2650
2651
2652
2653
2654
2655
2656
2657
2658
2659
2660
2661
2662
2663
2664
2665
2666
2667
2668
2669
2670
2671
2672
2673
2674
2675
2676
2677
2678
2679
2680
2681
2682
2683
2684
2685
2686
2687
2688
2689
2690
2691
2692
 
# File 'lib/docspring/api/client.rb', line 2637

def update_template_with_http_info(template_id, data, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: Client.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 Client.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 Client.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 => :"Client.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: Client#update_template\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end