Class: FormAPI::PDFApi

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

Direct Known Subclasses

Client

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ PDFApi

Returns a new instance of PDFApi.



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

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

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



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

def api_client
  @api_client
end

Instance Method Details

#batch_generate_pdf(template_id, opts = {}) ⇒ Array<InlineResponse2011>

Generates multiple PDFs

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:



29
30
31
32
 
# File 'lib/form_api/api/pdf_api.rb', line 29

def batch_generate_pdf(template_id, opts = {})
  data, _status_code, _headers = batch_generate_pdf_with_http_info(template_id, opts)
  return data
end

#batch_generate_pdf_with_http_info(template_id, opts = {}) ⇒ Array<(Array<InlineResponse2011>, Fixnum, Hash)>

Generates multiple PDFs

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:

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

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



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

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

  # query parameters
  query_params = {}

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

  # form parameters
  form_params = {}

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

#combine_submissions(opts = {}) ⇒ InlineResponse201

Merge generated PDFs together

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:



85
86
87
88
 
# File 'lib/form_api/api/pdf_api.rb', line 85

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

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

Merge generated PDFs together

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:

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

    InlineResponse201 data, response status code and response headers



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
 
# File 'lib/form_api/api/pdf_api.rb', line 95

def combine_submissions_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: PDFApi.combine_submissions ..."
  end
  # resource path
  local_var_path = "/combined_submissions"

  # query parameters
  query_params = {}

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

  # form parameters
  form_params = {}

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

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

Expire a combined submission

Parameters:

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

    the optional parameters

Returns:



136
137
138
139
 
# File 'lib/form_api/api/pdf_api.rb', line 136

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

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

Expire a combined submission

Parameters:

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

    the optional parameters

Returns:



146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
 
# File 'lib/form_api/api/pdf_api.rb', line 146

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

  # query parameters
  query_params = {}

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

  # form parameters
  form_params = {}

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

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

Expire a PDF submission

Parameters:

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

    the optional parameters

Returns:



189
190
191
192
 
# File 'lib/form_api/api/pdf_api.rb', line 189

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

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

Expire a PDF submission

Parameters:

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

    the optional parameters

Returns:



199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
 
# File 'lib/form_api/api/pdf_api.rb', line 199

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

  # query parameters
  query_params = {}

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

  # form parameters
  form_params = {}

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

#generate_pdf(template_id, opts = {}) ⇒ InlineResponse2011

Generates a new PDF

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:



243
244
245
246
 
# File 'lib/form_api/api/pdf_api.rb', line 243

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

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

Generates a new PDF

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:

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

    InlineResponse2011 data, response status code and response headers



254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
 
# File 'lib/form_api/api/pdf_api.rb', line 254

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

  # query parameters
  query_params = {}

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

  # form parameters
  form_params = {}

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

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

Check the status of a combined submission (merged PDFs)

Parameters:

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

    the optional parameters

Returns:



299
300
301
302
 
# File 'lib/form_api/api/pdf_api.rb', line 299

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

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

Check the status of a combined submission (merged PDFs)

Parameters:

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

    the optional parameters

Returns:



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/form_api/api/pdf_api.rb', line 309

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

  # query parameters
  query_params = {}

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

  # form parameters
  form_params = {}

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

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

Check the status of a PDF

Parameters:

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

    the optional parameters

Returns:



352
353
354
355
 
# File 'lib/form_api/api/pdf_api.rb', line 352

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

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

Check the status of a PDF

Parameters:

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

    the optional parameters

Returns:



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
 
# File 'lib/form_api/api/pdf_api.rb', line 362

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

  # query parameters
  query_params = {}

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

  # form parameters
  form_params = {}

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

#get_templates(opts = {}) ⇒ Array<InlineResponse2001>

Get a list of all templates

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :page (Integer) —

    Default: 1

  • :per_page (Integer) —

    Default: 50

Returns:



406
407
408
409
 
# File 'lib/form_api/api/pdf_api.rb', line 406

def get_templates(opts = {})
  data, _status_code, _headers = get_templates_with_http_info(opts)
  return data
end

#get_templates_with_http_info(opts = {}) ⇒ Array<(Array<InlineResponse2001>, Fixnum, Hash)>

Get a list of all templates

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :page (Integer) —

    Default: 1

  • :per_page (Integer) —

    Default: 50

Returns:

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

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



417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
 
# File 'lib/form_api/api/pdf_api.rb', line 417

def get_templates_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: PDFApi.get_templates ..."
  end
  # resource path
  local_var_path = "/templates"

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

  # form parameters
  form_params = {}

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

#test_authentication(opts = {}) ⇒ InlineResponse200

Test Authentication

Parameters:

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

    the optional parameters

Returns:



457
458
459
460
 
# File 'lib/form_api/api/pdf_api.rb', line 457

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

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

Test Authentication

Parameters:

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

    the optional parameters

Returns:

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

    InlineResponse200 data, response status code and response headers



466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
 
# File 'lib/form_api/api/pdf_api.rb', line 466

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

  # query parameters
  query_params = {}

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

  # form parameters
  form_params = {}

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