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_v1(template_id, create_submission_data, opts = {}) ⇒ Array<CreateSubmissionResponse>

Generates multiple PDFs

Parameters:

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

    the optional parameters

Returns:



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

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

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

Generates multiple PDFs

Parameters:

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

    the optional parameters

Returns:

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

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



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

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

  # query parameters
  query_params = {}

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

  # form parameters
  form_params = {}

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

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

Generates multiple PDFs

Parameters:

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

    the optional parameters

Returns:



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

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

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

Generates multiple PDFs

Parameters:

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

    the optional parameters

Returns:



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

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

  # query parameters
  query_params = {}

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

  # form parameters
  form_params = {}

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

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

Merge generated PDFs together

Parameters:

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

    the optional parameters

Returns:



138
139
140
141
 
# File 'lib/form_api/api/pdf_api.rb', line 138

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

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

Merge generated PDFs together

Parameters:

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

    the optional parameters

Returns:



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

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

  # query parameters
  query_params = {}

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

  # form parameters
  form_params = {}

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

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

Expire a combined submission

Parameters:

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

    the optional parameters

Returns:



191
192
193
194
 
# File 'lib/form_api/api/pdf_api.rb', line 191

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

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

Expire a combined submission

Parameters:

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

    the optional parameters

Returns:

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

    CombinedSubmission data, response status code and response headers



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

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

  # query parameters
  query_params = {}

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

  # form parameters
  form_params = {}

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

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

Expire a PDF submission

Parameters:

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

    the optional parameters

Returns:



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

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

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

Expire a PDF submission

Parameters:

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

    the optional parameters

Returns:

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

    Submission data, response status code and response headers



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

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

  # query parameters
  query_params = {}

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

  # form parameters
  form_params = {}

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

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

Generates a new PDF

Parameters:

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

    the optional parameters

Returns:



294
295
296
297
 
# File 'lib/form_api/api/pdf_api.rb', line 294

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

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

Generates a new PDF

Parameters:

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

    the optional parameters

Returns:

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

    CreateSubmissionResponse data, response status code and response headers



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

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

  # query parameters
  query_params = {}

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

  # form parameters
  form_params = {}

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

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

Check the status of a combined submission (merged PDFs)

Parameters:

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

    the optional parameters

Returns:



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

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

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

Check the status of a combined submission (merged PDFs)

Parameters:

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

    the optional parameters

Returns:

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

    CombinedSubmission data, response status code and response headers



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

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

  # query parameters
  query_params = {}

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

  # form parameters
  form_params = {}

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

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

Check the status of a PDF

Parameters:

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

    the optional parameters

Returns:



403
404
405
406
 
# File 'lib/form_api/api/pdf_api.rb', line 403

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

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

Check the status of a submission batch job

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :include_submissions (BOOLEAN)

Returns:



455
456
457
458
 
# File 'lib/form_api/api/pdf_api.rb', line 455

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

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

Check the status of a submission batch job

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :include_submissions (BOOLEAN)

Returns:

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

    SubmissionBatch data, response status code and response headers



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

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

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

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

  # form parameters
  form_params = {}

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

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

Check the status of a PDF

Parameters:

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

    the optional parameters

Returns:

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

    Submission data, response status code and response headers



412
413
414
415
416
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
 
# File 'lib/form_api/api/pdf_api.rb', line 412

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 => 'Submission')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PDFApi#get_submission\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

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

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:



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

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

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

Get a list of all templates

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :page (Integer) —

    Default: 1

  • :per_page (Integer) —

    Default: 50

Returns:

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

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



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

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

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

  if @api_client.config.client_side_validation && !opts[:'per_page'].nil? && opts[:'per_page'] < 1
    fail ArgumentError, 'invalid value for "opts[:"per_page"]" when calling PDFApi.get_templates, must be greater than or equal to 1.'
  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<Template>')
  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 = {}) ⇒ AuthenticationSuccessResponse

Test Authentication

Parameters:

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

    the optional parameters

Returns:



570
571
572
573
 
# File 'lib/form_api/api/pdf_api.rb', line 570

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

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

Test Authentication

Parameters:

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

    the optional parameters

Returns:



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

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

  # query parameters
  query_params = {}

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

  # form parameters
  form_params = {}

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