Class: FormAPI::PDFApi
- Inherits:
-
Object
- Object
- FormAPI::PDFApi
- Defined in:
- lib/form_api/api/pdf_api.rb
Direct Known Subclasses
Instance Attribute Summary collapse
-
#api_client ⇒ Object
Returns the value of attribute api_client.
Instance Method Summary collapse
-
#batch_generate_pdf_v1(template_id, request_body, opts = {}) ⇒ Array<CreateSubmissionResponse>
Generates multiple PDFs.
-
#batch_generate_pdf_v1_with_http_info(template_id, request_body, opts = {}) ⇒ Array<(Array<CreateSubmissionResponse>, Fixnum, Hash)>
Generates multiple PDFs.
-
#batch_generate_pdfs(submission_batch_data, opts = {}) ⇒ CreateSubmissionBatchResponse
Generates multiple PDFs.
-
#batch_generate_pdfs_with_http_info(submission_batch_data, opts = {}) ⇒ Array<(CreateSubmissionBatchResponse, Fixnum, Hash)>
Generates multiple PDFs.
-
#combine_pdfs(combine_pdfs_data, opts = {}) ⇒ CreateCombinedSubmissionResponse
Merge submission PDFs, template PDFs, or custom files.
-
#combine_pdfs_with_http_info(combine_pdfs_data, opts = {}) ⇒ Array<(CreateCombinedSubmissionResponse, Fixnum, Hash)>
Merge submission PDFs, template PDFs, or custom files.
-
#combine_submissions(combined_submission_data, opts = {}) ⇒ CreateCombinedSubmissionResponse
Merge generated PDFs together.
-
#combine_submissions_with_http_info(combined_submission_data, opts = {}) ⇒ Array<(CreateCombinedSubmissionResponse, Fixnum, Hash)>
Merge generated PDFs together.
-
#create_custom_file_from_upload(create_custom_file_data, opts = {}) ⇒ CreateCustomFileResponse
Create a new custom file from a cached presign upload.
-
#create_custom_file_from_upload_with_http_info(create_custom_file_data, opts = {}) ⇒ Array<(CreateCustomFileResponse, Fixnum, Hash)>
Create a new custom file from a cached presign upload.
-
#create_data_request_token(data_request_id, opts = {}) ⇒ CreateSubmissionDataRequestTokenResponse
Creates a new data request token for form authentication.
-
#create_data_request_token_with_http_info(data_request_id, opts = {}) ⇒ Array<(CreateSubmissionDataRequestTokenResponse, Fixnum, Hash)>
Creates a new data request token for form authentication.
-
#create_folder(create_folder_data, opts = {}) ⇒ Folder
Create a folder.
-
#create_folder_with_http_info(create_folder_data, opts = {}) ⇒ Array<(Folder, Fixnum, Hash)>
Create a folder.
-
#create_template(template_document, template_name, opts = {}) ⇒ PendingTemplate
Upload a new PDF template with a file upload.
-
#create_template_from_upload(create_template_data, opts = {}) ⇒ PendingTemplate
Create a new PDF template from a cached presign upload.
-
#create_template_from_upload_with_http_info(create_template_data, opts = {}) ⇒ Array<(PendingTemplate, Fixnum, Hash)>
Create a new PDF template from a cached presign upload.
-
#create_template_with_http_info(template_document, template_name, opts = {}) ⇒ Array<(PendingTemplate, Fixnum, Hash)>
Upload a new PDF template with a file upload.
-
#delete_folder(folder_id, opts = {}) ⇒ Folder
Delete a folder.
-
#delete_folder_with_http_info(folder_id, opts = {}) ⇒ Array<(Folder, Fixnum, Hash)>
Delete a folder.
-
#expire_combined_submission(combined_submission_id, opts = {}) ⇒ CombinedSubmission
Expire a combined submission.
-
#expire_combined_submission_with_http_info(combined_submission_id, opts = {}) ⇒ Array<(CombinedSubmission, Fixnum, Hash)>
Expire a combined submission.
-
#expire_submission(submission_id, opts = {}) ⇒ Submission
Expire a PDF submission.
-
#expire_submission_with_http_info(submission_id, opts = {}) ⇒ Array<(Submission, Fixnum, Hash)>
Expire a PDF submission.
-
#generate_pdf(template_id, submission_data, opts = {}) ⇒ CreateSubmissionResponse
Generates a new PDF.
-
#generate_pdf_with_http_info(template_id, submission_data, opts = {}) ⇒ Array<(CreateSubmissionResponse, Fixnum, Hash)>
Generates a new PDF.
-
#get_combined_submission(combined_submission_id, opts = {}) ⇒ CombinedSubmission
Check the status of a combined submission (merged PDFs).
-
#get_combined_submission_with_http_info(combined_submission_id, opts = {}) ⇒ Array<(CombinedSubmission, Fixnum, Hash)>
Check the status of a combined submission (merged PDFs).
-
#get_data_request(data_request_id, opts = {}) ⇒ SubmissionDataRequest
Look up a submission data request.
-
#get_data_request_with_http_info(data_request_id, opts = {}) ⇒ Array<(SubmissionDataRequest, Fixnum, Hash)>
Look up a submission data request.
-
#get_presign_url(opts = {}) ⇒ Hash<String, Object>
Get a presigned URL so that you can upload a file to our AWS S3 bucket.
-
#get_presign_url_with_http_info(opts = {}) ⇒ Array<(Hash<String, Object>, Fixnum, Hash)>
Get a presigned URL so that you can upload a file to our AWS S3 bucket.
-
#get_submission(submission_id, opts = {}) ⇒ Submission
Check the status of a PDF.
-
#get_submission_batch(submission_batch_id, opts = {}) ⇒ SubmissionBatch
Check the status of a submission batch job.
-
#get_submission_batch_with_http_info(submission_batch_id, opts = {}) ⇒ Array<(SubmissionBatch, Fixnum, Hash)>
Check the status of a submission batch job.
-
#get_submission_with_http_info(submission_id, opts = {}) ⇒ Array<(Submission, Fixnum, Hash)>
Check the status of a PDF.
-
#get_template(template_id, opts = {}) ⇒ Template
Get a single template.
-
#get_template_schema(template_id, opts = {}) ⇒ Hash<String, Object>
Fetch the JSON schema for a template.
-
#get_template_schema_with_http_info(template_id, opts = {}) ⇒ Array<(Hash<String, Object>, Fixnum, Hash)>
Fetch the JSON schema for a template.
-
#get_template_with_http_info(template_id, opts = {}) ⇒ Array<(Template, Fixnum, Hash)>
Get a single template.
-
#initialize(api_client = ApiClient.default) ⇒ PDFApi
constructor
A new instance of PDFApi.
-
#list_folders(opts = {}) ⇒ Array<Folder>
Get a list of all folders.
-
#list_folders_with_http_info(opts = {}) ⇒ Array<(Array<Folder>, Fixnum, Hash)>
Get a list of all folders.
-
#list_templates(opts = {}) ⇒ Array<Template>
Get a list of all templates.
-
#list_templates_with_http_info(opts = {}) ⇒ Array<(Array<Template>, Fixnum, Hash)>
Get a list of all templates.
-
#move_folder_to_folder(folder_id, move_folder_data, opts = {}) ⇒ Folder
Move a folder.
-
#move_folder_to_folder_with_http_info(folder_id, move_folder_data, opts = {}) ⇒ Array<(Folder, Fixnum, Hash)>
Move a folder.
-
#move_template_to_folder(template_id, move_template_data, opts = {}) ⇒ Template
Move Template to folder.
-
#move_template_to_folder_with_http_info(template_id, move_template_data, opts = {}) ⇒ Array<(Template, Fixnum, Hash)>
Move Template to folder.
-
#rename_folder(folder_id, rename_folder_data, opts = {}) ⇒ nil
Rename a folder.
-
#rename_folder_with_http_info(folder_id, rename_folder_data, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>
Rename a folder.
-
#test_authentication(opts = {}) ⇒ AuthenticationSuccessResponse
Test Authentication.
-
#test_authentication_with_http_info(opts = {}) ⇒ Array<(AuthenticationSuccessResponse, Fixnum, Hash)>
Test Authentication.
-
#update_data_request(data_request_id, update_submission_data_request_data, opts = {}) ⇒ UpdateDataRequestResponse
Update a submission data request.
-
#update_data_request_with_http_info(data_request_id, update_submission_data_request_data, opts = {}) ⇒ Array<(UpdateDataRequestResponse, Fixnum, Hash)>
Update a submission data request.
Constructor Details
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, request_body, opts = {}) ⇒ Array<CreateSubmissionResponse>
Generates multiple PDFs
27 28 29 30 |
# File 'lib/form_api/api/pdf_api.rb', line 27 def batch_generate_pdf_v1(template_id, request_body, opts = {}) data, _status_code, _headers = batch_generate_pdf_v1_with_http_info(template_id, request_body, opts) data end |
#batch_generate_pdf_v1_with_http_info(template_id, request_body, opts = {}) ⇒ Array<(Array<CreateSubmissionResponse>, Fixnum, Hash)>
Generates multiple PDFs
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, request_body, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: PDFApi.batch_generate_pdf_v1 ...' end # verify the required parameter 'template_id' is set if @api_client.config.client_side_validation && template_id.nil? fail ArgumentError, "Missing the required parameter 'template_id' when calling PDFApi.batch_generate_pdf_v1" end # verify the required parameter 'request_body' is set if @api_client.config.client_side_validation && request_body.nil? fail ArgumentError, "Missing the required parameter 'request_body' when calling PDFApi.batch_generate_pdf_v1" end # resource path local_var_path = '/templates/{template_id}/submissions/batch'.sub('{' + 'template_id' + '}', template_id.to_s) # query parameters query_params = {} # header parameters header_params = {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) # HTTP header 'Content-Type' header_params['Content-Type'] = @api_client.select_header_content_type(['application/json']) # form parameters form_params = {} # http body (model) post_body = @api_client.object_to_http_body(request_body) auth_names = ['api_token_basic'] data, status_code, headers = @api_client.call_api(:POST, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'Array<CreateSubmissionResponse>') if @api_client.config.debugging @api_client.config.logger.debug "API called: PDFApi#batch_generate_pdf_v1\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#batch_generate_pdfs(submission_batch_data, opts = {}) ⇒ CreateSubmissionBatchResponse
Generates multiple PDFs
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
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_pdfs(combine_pdfs_data, opts = {}) ⇒ CreateCombinedSubmissionResponse
Merge submission PDFs, template PDFs, or custom files
138 139 140 141 |
# File 'lib/form_api/api/pdf_api.rb', line 138 def combine_pdfs(combine_pdfs_data, opts = {}) data, _status_code, _headers = combine_pdfs_with_http_info(combine_pdfs_data, opts) data end |
#combine_pdfs_with_http_info(combine_pdfs_data, opts = {}) ⇒ Array<(CreateCombinedSubmissionResponse, Fixnum, Hash)>
Merge submission PDFs, template PDFs, or custom files
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_pdfs_with_http_info(combine_pdfs_data, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: PDFApi.combine_pdfs ...' end # verify the required parameter 'combine_pdfs_data' is set if @api_client.config.client_side_validation && combine_pdfs_data.nil? fail ArgumentError, "Missing the required parameter 'combine_pdfs_data' when calling PDFApi.combine_pdfs" end # resource path local_var_path = '/combined_submissions?v=2' # query parameters query_params = {} # header parameters header_params = {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) # HTTP header 'Content-Type' header_params['Content-Type'] = @api_client.select_header_content_type(['application/json']) # form parameters form_params = {} # http body (model) post_body = @api_client.object_to_http_body(combine_pdfs_data) auth_names = ['api_token_basic'] data, status_code, headers = @api_client.call_api(:POST, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'CreateCombinedSubmissionResponse') if @api_client.config.debugging @api_client.config.logger.debug "API called: PDFApi#combine_pdfs\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#combine_submissions(combined_submission_data, opts = {}) ⇒ CreateCombinedSubmissionResponse
Merge generated PDFs together
191 192 193 194 |
# File 'lib/form_api/api/pdf_api.rb', line 191 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
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 237 238 |
# File 'lib/form_api/api/pdf_api.rb', line 200 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 |
#create_custom_file_from_upload(create_custom_file_data, opts = {}) ⇒ CreateCustomFileResponse
Create a new custom file from a cached presign upload
244 245 246 247 |
# File 'lib/form_api/api/pdf_api.rb', line 244 def create_custom_file_from_upload(create_custom_file_data, opts = {}) data, _status_code, _headers = create_custom_file_from_upload_with_http_info(create_custom_file_data, opts) data end |
#create_custom_file_from_upload_with_http_info(create_custom_file_data, opts = {}) ⇒ Array<(CreateCustomFileResponse, Fixnum, Hash)>
Create a new custom file from a cached presign upload
253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 |
# File 'lib/form_api/api/pdf_api.rb', line 253 def create_custom_file_from_upload_with_http_info(create_custom_file_data, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: PDFApi.create_custom_file_from_upload ...' end # verify the required parameter 'create_custom_file_data' is set if @api_client.config.client_side_validation && create_custom_file_data.nil? fail ArgumentError, "Missing the required parameter 'create_custom_file_data' when calling PDFApi.create_custom_file_from_upload" end # resource path local_var_path = '/custom_files' # query parameters query_params = {} # header parameters header_params = {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) # HTTP header 'Content-Type' header_params['Content-Type'] = @api_client.select_header_content_type(['application/json']) # form parameters form_params = {} # http body (model) post_body = @api_client.object_to_http_body(create_custom_file_data) auth_names = ['api_token_basic'] data, status_code, headers = @api_client.call_api(:POST, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'CreateCustomFileResponse') if @api_client.config.debugging @api_client.config.logger.debug "API called: PDFApi#create_custom_file_from_upload\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#create_data_request_token(data_request_id, opts = {}) ⇒ CreateSubmissionDataRequestTokenResponse
Creates a new data request token for form authentication
297 298 299 300 |
# File 'lib/form_api/api/pdf_api.rb', line 297 def create_data_request_token(data_request_id, opts = {}) data, _status_code, _headers = create_data_request_token_with_http_info(data_request_id, opts) data end |
#create_data_request_token_with_http_info(data_request_id, opts = {}) ⇒ Array<(CreateSubmissionDataRequestTokenResponse, Fixnum, Hash)>
Creates a new data request token for form authentication
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 |
# File 'lib/form_api/api/pdf_api.rb', line 306 def create_data_request_token_with_http_info(data_request_id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: PDFApi.create_data_request_token ...' end # verify the required parameter 'data_request_id' is set if @api_client.config.client_side_validation && data_request_id.nil? fail ArgumentError, "Missing the required parameter 'data_request_id' when calling PDFApi.create_data_request_token" end # resource path local_var_path = '/data_requests/{data_request_id}/tokens'.sub('{' + 'data_request_id' + '}', data_request_id.to_s) # query parameters query_params = {} # header parameters header_params = {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) # form parameters form_params = {} # http body (model) post_body = nil auth_names = ['api_token_basic'] data, status_code, headers = @api_client.call_api(:POST, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'CreateSubmissionDataRequestTokenResponse') if @api_client.config.debugging @api_client.config.logger.debug "API called: PDFApi#create_data_request_token\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#create_folder(create_folder_data, opts = {}) ⇒ Folder
Create a folder
348 349 350 351 |
# File 'lib/form_api/api/pdf_api.rb', line 348 def create_folder(create_folder_data, opts = {}) data, _status_code, _headers = create_folder_with_http_info(create_folder_data, opts) data end |
#create_folder_with_http_info(create_folder_data, opts = {}) ⇒ Array<(Folder, Fixnum, Hash)>
Create a folder
357 358 359 360 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 |
# File 'lib/form_api/api/pdf_api.rb', line 357 def create_folder_with_http_info(create_folder_data, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: PDFApi.create_folder ...' end # verify the required parameter 'create_folder_data' is set if @api_client.config.client_side_validation && create_folder_data.nil? fail ArgumentError, "Missing the required parameter 'create_folder_data' when calling PDFApi.create_folder" end # resource path local_var_path = '/folders/' # query parameters query_params = {} # header parameters header_params = {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) # HTTP header 'Content-Type' header_params['Content-Type'] = @api_client.select_header_content_type(['application/json']) # form parameters form_params = {} # http body (model) post_body = @api_client.object_to_http_body(create_folder_data) auth_names = ['api_token_basic'] data, status_code, headers = @api_client.call_api(:POST, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'Folder') if @api_client.config.debugging @api_client.config.logger.debug "API called: PDFApi#create_folder\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#create_template(template_document, template_name, opts = {}) ⇒ PendingTemplate
Upload a new PDF template with a file upload
403 404 405 406 |
# File 'lib/form_api/api/pdf_api.rb', line 403 def create_template(template_document, template_name, opts = {}) data, _status_code, _headers = create_template_with_http_info(template_document, template_name, opts) data end |
#create_template_from_upload(create_template_data, opts = {}) ⇒ PendingTemplate
Create a new PDF template from a cached presign upload
465 466 467 468 |
# File 'lib/form_api/api/pdf_api.rb', line 465 def create_template_from_upload(create_template_data, opts = {}) data, _status_code, _headers = create_template_from_upload_with_http_info(create_template_data, opts) data end |
#create_template_from_upload_with_http_info(create_template_data, opts = {}) ⇒ Array<(PendingTemplate, Fixnum, Hash)>
Create a new PDF template from a cached presign upload
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 503 504 505 506 507 508 509 510 511 512 |
# File 'lib/form_api/api/pdf_api.rb', line 474 def create_template_from_upload_with_http_info(create_template_data, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: PDFApi.create_template_from_upload ...' end # verify the required parameter 'create_template_data' is set if @api_client.config.client_side_validation && create_template_data.nil? fail ArgumentError, "Missing the required parameter 'create_template_data' when calling PDFApi.create_template_from_upload" end # resource path local_var_path = '/templates?v=2' # query parameters query_params = {} # header parameters header_params = {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) # HTTP header 'Content-Type' header_params['Content-Type'] = @api_client.select_header_content_type(['application/json']) # form parameters form_params = {} # http body (model) post_body = @api_client.object_to_http_body(create_template_data) auth_names = ['api_token_basic'] data, status_code, headers = @api_client.call_api(:POST, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'PendingTemplate') if @api_client.config.debugging @api_client.config.logger.debug "API called: PDFApi#create_template_from_upload\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#create_template_with_http_info(template_document, template_name, opts = {}) ⇒ Array<(PendingTemplate, Fixnum, Hash)>
Upload a new PDF template with a file upload
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 449 450 451 452 453 454 455 456 457 458 459 |
# File 'lib/form_api/api/pdf_api.rb', line 414 def create_template_with_http_info(template_document, template_name, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: PDFApi.create_template ...' end # verify the required parameter 'template_document' is set if @api_client.config.client_side_validation && template_document.nil? fail ArgumentError, "Missing the required parameter 'template_document' when calling PDFApi.create_template" end # verify the required parameter 'template_name' is set if @api_client.config.client_side_validation && template_name.nil? fail ArgumentError, "Missing the required parameter 'template_name' when calling PDFApi.create_template" end # resource path local_var_path = '/templates' # query parameters query_params = {} # header parameters header_params = {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) # HTTP header 'Content-Type' header_params['Content-Type'] = @api_client.select_header_content_type(['multipart/form-data']) # form parameters form_params = {} form_params['template[document]'] = template_document form_params['template[name]'] = template_name form_params['template[parent_folder_id]'] = opts[:'template_parent_folder_id'] if !opts[:'template_parent_folder_id'].nil? # http body (model) post_body = nil auth_names = ['api_token_basic'] data, status_code, headers = @api_client.call_api(:POST, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'PendingTemplate') if @api_client.config.debugging @api_client.config.logger.debug "API called: PDFApi#create_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
518 519 520 521 |
# File 'lib/form_api/api/pdf_api.rb', line 518 def delete_folder(folder_id, opts = {}) data, _status_code, _headers = delete_folder_with_http_info(folder_id, opts) data end |
#delete_folder_with_http_info(folder_id, opts = {}) ⇒ Array<(Folder, Fixnum, Hash)>
Delete a folder
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 |
# File 'lib/form_api/api/pdf_api.rb', line 527 def delete_folder_with_http_info(folder_id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: PDFApi.delete_folder ...' end # verify the required parameter 'folder_id' is set if @api_client.config.client_side_validation && folder_id.nil? fail ArgumentError, "Missing the required parameter 'folder_id' when calling PDFApi.delete_folder" end # resource path local_var_path = '/folders/{folder_id}'.sub('{' + 'folder_id' + '}', folder_id.to_s) # query parameters query_params = {} # header parameters header_params = {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) # form parameters form_params = {} # http body (model) post_body = nil auth_names = ['api_token_basic'] data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'Folder') if @api_client.config.debugging @api_client.config.logger.debug "API called: PDFApi#delete_folder\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#expire_combined_submission(combined_submission_id, opts = {}) ⇒ CombinedSubmission
Expire a combined submission
569 570 571 572 |
# File 'lib/form_api/api/pdf_api.rb', line 569 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
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 |
# File 'lib/form_api/api/pdf_api.rb', line 578 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
620 621 622 623 |
# File 'lib/form_api/api/pdf_api.rb', line 620 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
629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 |
# File 'lib/form_api/api/pdf_api.rb', line 629 def expire_submission_with_http_info(submission_id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: PDFApi.expire_submission ...' end # verify the required parameter 'submission_id' is set if @api_client.config.client_side_validation && submission_id.nil? fail ArgumentError, "Missing the required parameter 'submission_id' when calling PDFApi.expire_submission" end # resource path local_var_path = '/submissions/{submission_id}'.sub('{' + 'submission_id' + '}', submission_id.to_s) # query parameters query_params = {} # header parameters header_params = {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) # form parameters form_params = {} # http body (model) post_body = nil auth_names = ['api_token_basic'] data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'Submission') if @api_client.config.debugging @api_client.config.logger.debug "API called: PDFApi#expire_submission\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#generate_pdf(template_id, submission_data, opts = {}) ⇒ CreateSubmissionResponse
Generates a new PDF
672 673 674 675 |
# File 'lib/form_api/api/pdf_api.rb', line 672 def generate_pdf(template_id, submission_data, opts = {}) data, _status_code, _headers = generate_pdf_with_http_info(template_id, submission_data, opts) data end |
#generate_pdf_with_http_info(template_id, submission_data, opts = {}) ⇒ Array<(CreateSubmissionResponse, Fixnum, Hash)>
Generates a new PDF
682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 |
# File 'lib/form_api/api/pdf_api.rb', line 682 def generate_pdf_with_http_info(template_id, submission_data, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: PDFApi.generate_pdf ...' end # verify the required parameter 'template_id' is set if @api_client.config.client_side_validation && template_id.nil? fail ArgumentError, "Missing the required parameter 'template_id' when calling PDFApi.generate_pdf" end # verify the required parameter 'submission_data' is set if @api_client.config.client_side_validation && submission_data.nil? fail ArgumentError, "Missing the required parameter 'submission_data' when calling PDFApi.generate_pdf" end # resource path local_var_path = '/templates/{template_id}/submissions'.sub('{' + 'template_id' + '}', template_id.to_s) # query parameters query_params = {} # header parameters header_params = {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) # HTTP header 'Content-Type' header_params['Content-Type'] = @api_client.select_header_content_type(['application/json']) # form parameters form_params = {} # http body (model) post_body = @api_client.object_to_http_body(submission_data) auth_names = ['api_token_basic'] data, status_code, headers = @api_client.call_api(:POST, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'CreateSubmissionResponse') if @api_client.config.debugging @api_client.config.logger.debug "API called: PDFApi#generate_pdf\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#get_combined_submission(combined_submission_id, opts = {}) ⇒ CombinedSubmission
Check the status of a combined submission (merged PDFs)
730 731 732 733 |
# File 'lib/form_api/api/pdf_api.rb', line 730 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)
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 |
# File 'lib/form_api/api/pdf_api.rb', line 739 def get_combined_submission_with_http_info(combined_submission_id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: PDFApi.get_combined_submission ...' end # verify the required parameter 'combined_submission_id' is set if @api_client.config.client_side_validation && combined_submission_id.nil? fail ArgumentError, "Missing the required parameter 'combined_submission_id' when calling PDFApi.get_combined_submission" end # resource path local_var_path = '/combined_submissions/{combined_submission_id}'.sub('{' + 'combined_submission_id' + '}', combined_submission_id.to_s) # query parameters query_params = {} # header parameters header_params = {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) # form parameters form_params = {} # http body (model) post_body = nil auth_names = ['api_token_basic'] data, status_code, headers = @api_client.call_api(:GET, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'CombinedSubmission') if @api_client.config.debugging @api_client.config.logger.debug "API called: PDFApi#get_combined_submission\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#get_data_request(data_request_id, opts = {}) ⇒ SubmissionDataRequest
Look up a submission data request
781 782 783 784 |
# File 'lib/form_api/api/pdf_api.rb', line 781 def get_data_request(data_request_id, opts = {}) data, _status_code, _headers = get_data_request_with_http_info(data_request_id, opts) data end |
#get_data_request_with_http_info(data_request_id, opts = {}) ⇒ Array<(SubmissionDataRequest, Fixnum, Hash)>
Look up a submission data request
790 791 792 793 794 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 |
# File 'lib/form_api/api/pdf_api.rb', line 790 def get_data_request_with_http_info(data_request_id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: PDFApi.get_data_request ...' end # verify the required parameter 'data_request_id' is set if @api_client.config.client_side_validation && data_request_id.nil? fail ArgumentError, "Missing the required parameter 'data_request_id' when calling PDFApi.get_data_request" end # resource path local_var_path = '/data_requests/{data_request_id}'.sub('{' + 'data_request_id' + '}', data_request_id.to_s) # query parameters query_params = {} # header parameters header_params = {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) # form parameters form_params = {} # http body (model) post_body = nil auth_names = ['api_token_basic'] data, status_code, headers = @api_client.call_api(:GET, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'SubmissionDataRequest') if @api_client.config.debugging @api_client.config.logger.debug "API called: PDFApi#get_data_request\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#get_presign_url(opts = {}) ⇒ Hash<String, Object>
Get a presigned URL so that you can upload a file to our AWS S3 bucket
831 832 833 834 |
# File 'lib/form_api/api/pdf_api.rb', line 831 def get_presign_url(opts = {}) data, _status_code, _headers = get_presign_url_with_http_info(opts) data end |
#get_presign_url_with_http_info(opts = {}) ⇒ Array<(Hash<String, Object>, Fixnum, Hash)>
Get a presigned URL so that you can upload a file to our AWS S3 bucket
839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 |
# File 'lib/form_api/api/pdf_api.rb', line 839 def get_presign_url_with_http_info(opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: PDFApi.get_presign_url ...' end # resource path local_var_path = '/uploads/presign' # query parameters query_params = {} # header parameters header_params = {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) # form parameters form_params = {} # http body (model) post_body = nil auth_names = ['api_token_basic'] data, status_code, headers = @api_client.call_api(:GET, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'Hash<String, Object>') if @api_client.config.debugging @api_client.config.logger.debug "API called: PDFApi#get_presign_url\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#get_submission(submission_id, opts = {}) ⇒ Submission
Check the status of a PDF
878 879 880 881 |
# File 'lib/form_api/api/pdf_api.rb', line 878 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
932 933 934 935 |
# File 'lib/form_api/api/pdf_api.rb', line 932 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
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 976 977 978 979 |
# File 'lib/form_api/api/pdf_api.rb', line 942 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
888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 |
# File 'lib/form_api/api/pdf_api.rb', line 888 def get_submission_with_http_info(submission_id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: PDFApi.get_submission ...' end # verify the required parameter 'submission_id' is set if @api_client.config.client_side_validation && submission_id.nil? fail ArgumentError, "Missing the required parameter 'submission_id' when calling PDFApi.get_submission" end # resource path local_var_path = '/submissions/{submission_id}'.sub('{' + 'submission_id' + '}', submission_id.to_s) # query parameters query_params = {} query_params[:'include_data'] = opts[:'include_data'] if !opts[:'include_data'].nil? # header parameters header_params = {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) # form parameters form_params = {} # http body (model) post_body = nil auth_names = ['api_token_basic'] data, status_code, headers = @api_client.call_api(:GET, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'Submission') if @api_client.config.debugging @api_client.config.logger.debug "API called: PDFApi#get_submission\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#get_template(template_id, opts = {}) ⇒ Template
Get a single template
985 986 987 988 |
# File 'lib/form_api/api/pdf_api.rb', line 985 def get_template(template_id, opts = {}) data, _status_code, _headers = get_template_with_http_info(template_id, opts) data end |
#get_template_schema(template_id, opts = {}) ⇒ Hash<String, Object>
Fetch the JSON schema for a template
1036 1037 1038 1039 |
# File 'lib/form_api/api/pdf_api.rb', line 1036 def get_template_schema(template_id, opts = {}) data, _status_code, _headers = get_template_schema_with_http_info(template_id, opts) data end |
#get_template_schema_with_http_info(template_id, opts = {}) ⇒ Array<(Hash<String, Object>, Fixnum, Hash)>
Fetch the JSON schema for a template
1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 |
# File 'lib/form_api/api/pdf_api.rb', line 1045 def get_template_schema_with_http_info(template_id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: PDFApi.get_template_schema ...' end # verify the required parameter 'template_id' is set if @api_client.config.client_side_validation && template_id.nil? fail ArgumentError, "Missing the required parameter 'template_id' when calling PDFApi.get_template_schema" end # resource path local_var_path = '/templates/{template_id}/schema'.sub('{' + 'template_id' + '}', template_id.to_s) # query parameters query_params = {} # header parameters header_params = {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) # form parameters form_params = {} # http body (model) post_body = nil auth_names = ['api_token_basic'] data, status_code, headers = @api_client.call_api(:GET, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'Hash<String, Object>') if @api_client.config.debugging @api_client.config.logger.debug "API called: PDFApi#get_template_schema\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#get_template_with_http_info(template_id, opts = {}) ⇒ Array<(Template, Fixnum, Hash)>
Get a single template
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 |
# File 'lib/form_api/api/pdf_api.rb', line 994 def get_template_with_http_info(template_id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: PDFApi.get_template ...' end # verify the required parameter 'template_id' is set if @api_client.config.client_side_validation && template_id.nil? fail ArgumentError, "Missing the required parameter 'template_id' when calling PDFApi.get_template" end # resource path local_var_path = '/templates/{template_id}'.sub('{' + 'template_id' + '}', template_id.to_s) # query parameters query_params = {} # header parameters header_params = {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) # form parameters form_params = {} # http body (model) post_body = nil auth_names = ['api_token_basic'] data, status_code, headers = @api_client.call_api(:GET, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'Template') if @api_client.config.debugging @api_client.config.logger.debug "API called: PDFApi#get_template\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#list_folders(opts = {}) ⇒ Array<Folder>
Get a list of all folders
1087 1088 1089 1090 |
# File 'lib/form_api/api/pdf_api.rb', line 1087 def list_folders(opts = {}) data, _status_code, _headers = list_folders_with_http_info(opts) data end |
#list_folders_with_http_info(opts = {}) ⇒ Array<(Array<Folder>, Fixnum, Hash)>
Get a list of all folders
1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 |
# File 'lib/form_api/api/pdf_api.rb', line 1096 def list_folders_with_http_info(opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: PDFApi.list_folders ...' end # resource path local_var_path = '/folders/' # query parameters query_params = {} query_params[:'parent_folder_id'] = opts[:'parent_folder_id'] if !opts[:'parent_folder_id'].nil? # header parameters header_params = {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) # form parameters form_params = {} # http body (model) post_body = nil auth_names = ['api_token_basic'] data, status_code, headers = @api_client.call_api(:GET, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'Array<Folder>') if @api_client.config.debugging @api_client.config.logger.debug "API called: PDFApi#list_folders\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#list_templates(opts = {}) ⇒ Array<Template>
Get a list of all templates
1138 1139 1140 1141 |
# File 'lib/form_api/api/pdf_api.rb', line 1138 def list_templates(opts = {}) data, _status_code, _headers = list_templates_with_http_info(opts) data end |
#list_templates_with_http_info(opts = {}) ⇒ Array<(Array<Template>, Fixnum, Hash)>
Get a list of all templates
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 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 |
# File 'lib/form_api/api/pdf_api.rb', line 1150 def list_templates_with_http_info(opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: PDFApi.list_templates ...' end if @api_client.config.client_side_validation && !opts[:'page'].nil? && opts[:'page'] < 1 fail ArgumentError, 'invalid value for "opts[:"page"]" when calling PDFApi.list_templates, must be greater than or equal to 1.' end if @api_client.config.client_side_validation && !opts[:'per_page'].nil? && opts[:'per_page'] > 50 fail ArgumentError, 'invalid value for "opts[:"per_page"]" when calling PDFApi.list_templates, must be smaller than or equal to 50.' end if @api_client.config.client_side_validation && !opts[:'per_page'].nil? && opts[:'per_page'] < 1 fail ArgumentError, 'invalid value for "opts[:"per_page"]" when calling PDFApi.list_templates, must be greater than or equal to 1.' end # resource path local_var_path = '/templates' # query parameters query_params = {} query_params[:'query'] = opts[:'query'] if !opts[:'query'].nil? query_params[:'parent_folder_id'] = opts[:'parent_folder_id'] if !opts[:'parent_folder_id'].nil? query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil? query_params[:'per_page'] = opts[:'per_page'] if !opts[:'per_page'].nil? # header parameters header_params = {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) # form parameters form_params = {} # http body (model) post_body = nil auth_names = ['api_token_basic'] data, status_code, headers = @api_client.call_api(:GET, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'Array<Template>') if @api_client.config.debugging @api_client.config.logger.debug "API called: PDFApi#list_templates\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#move_folder_to_folder(folder_id, move_folder_data, opts = {}) ⇒ Folder
Move a folder
1205 1206 1207 1208 |
# File 'lib/form_api/api/pdf_api.rb', line 1205 def move_folder_to_folder(folder_id, move_folder_data, opts = {}) data, _status_code, _headers = move_folder_to_folder_with_http_info(folder_id, move_folder_data, opts) data end |
#move_folder_to_folder_with_http_info(folder_id, move_folder_data, opts = {}) ⇒ Array<(Folder, Fixnum, Hash)>
Move a folder
1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 |
# File 'lib/form_api/api/pdf_api.rb', line 1215 def move_folder_to_folder_with_http_info(folder_id, move_folder_data, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: PDFApi.move_folder_to_folder ...' end # verify the required parameter 'folder_id' is set if @api_client.config.client_side_validation && folder_id.nil? fail ArgumentError, "Missing the required parameter 'folder_id' when calling PDFApi.move_folder_to_folder" end # verify the required parameter 'move_folder_data' is set if @api_client.config.client_side_validation && move_folder_data.nil? fail ArgumentError, "Missing the required parameter 'move_folder_data' when calling PDFApi.move_folder_to_folder" end # resource path local_var_path = '/folders/{folder_id}/move'.sub('{' + 'folder_id' + '}', folder_id.to_s) # query parameters query_params = {} # header parameters header_params = {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) # HTTP header 'Content-Type' header_params['Content-Type'] = @api_client.select_header_content_type(['application/json']) # form parameters form_params = {} # http body (model) post_body = @api_client.object_to_http_body(move_folder_data) auth_names = ['api_token_basic'] data, status_code, headers = @api_client.call_api(:POST, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'Folder') if @api_client.config.debugging @api_client.config.logger.debug "API called: PDFApi#move_folder_to_folder\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#move_template_to_folder(template_id, move_template_data, opts = {}) ⇒ Template
Move Template to folder
1264 1265 1266 1267 |
# File 'lib/form_api/api/pdf_api.rb', line 1264 def move_template_to_folder(template_id, move_template_data, opts = {}) data, _status_code, _headers = move_template_to_folder_with_http_info(template_id, move_template_data, opts) data end |
#move_template_to_folder_with_http_info(template_id, move_template_data, opts = {}) ⇒ Array<(Template, Fixnum, Hash)>
Move Template to folder
1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 |
# File 'lib/form_api/api/pdf_api.rb', line 1274 def move_template_to_folder_with_http_info(template_id, move_template_data, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: PDFApi.move_template_to_folder ...' end # verify the required parameter 'template_id' is set if @api_client.config.client_side_validation && template_id.nil? fail ArgumentError, "Missing the required parameter 'template_id' when calling PDFApi.move_template_to_folder" end # verify the required parameter 'move_template_data' is set if @api_client.config.client_side_validation && move_template_data.nil? fail ArgumentError, "Missing the required parameter 'move_template_data' when calling PDFApi.move_template_to_folder" end # resource path local_var_path = '/templates/{template_id}/move'.sub('{' + 'template_id' + '}', template_id.to_s) # query parameters query_params = {} # header parameters header_params = {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) # HTTP header 'Content-Type' header_params['Content-Type'] = @api_client.select_header_content_type(['application/json']) # form parameters form_params = {} # http body (model) post_body = @api_client.object_to_http_body(move_template_data) auth_names = ['api_token_basic'] data, status_code, headers = @api_client.call_api(:POST, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'Template') if @api_client.config.debugging @api_client.config.logger.debug "API called: PDFApi#move_template_to_folder\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#rename_folder(folder_id, rename_folder_data, opts = {}) ⇒ nil
Rename a folder
1323 1324 1325 1326 |
# File 'lib/form_api/api/pdf_api.rb', line 1323 def rename_folder(folder_id, rename_folder_data, opts = {}) rename_folder_with_http_info(folder_id, rename_folder_data, opts) nil end |
#rename_folder_with_http_info(folder_id, rename_folder_data, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>
Rename a folder
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 1368 1369 1370 1371 1372 1373 1374 |
# File 'lib/form_api/api/pdf_api.rb', line 1333 def rename_folder_with_http_info(folder_id, rename_folder_data, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: PDFApi.rename_folder ...' end # verify the required parameter 'folder_id' is set if @api_client.config.client_side_validation && folder_id.nil? fail ArgumentError, "Missing the required parameter 'folder_id' when calling PDFApi.rename_folder" end # verify the required parameter 'rename_folder_data' is set if @api_client.config.client_side_validation && rename_folder_data.nil? fail ArgumentError, "Missing the required parameter 'rename_folder_data' when calling PDFApi.rename_folder" end # resource path local_var_path = '/folders/{folder_id}/rename'.sub('{' + 'folder_id' + '}', folder_id.to_s) # query parameters query_params = {} # header parameters header_params = {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) # HTTP header 'Content-Type' header_params['Content-Type'] = @api_client.select_header_content_type(['application/json']) # form parameters form_params = {} # http body (model) post_body = @api_client.object_to_http_body(rename_folder_data) auth_names = ['api_token_basic'] data, status_code, headers = @api_client.call_api(:POST, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names) if @api_client.config.debugging @api_client.config.logger.debug "API called: PDFApi#rename_folder\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#test_authentication(opts = {}) ⇒ AuthenticationSuccessResponse
Test Authentication
1379 1380 1381 1382 |
# File 'lib/form_api/api/pdf_api.rb', line 1379 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
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 |
# File 'lib/form_api/api/pdf_api.rb', line 1387 def test_authentication_with_http_info(opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: PDFApi.test_authentication ...' end # resource path local_var_path = '/authentication' # query parameters query_params = {} # header parameters header_params = {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) # form parameters form_params = {} # http body (model) post_body = nil auth_names = ['api_token_basic'] data, status_code, headers = @api_client.call_api(:GET, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'AuthenticationSuccessResponse') if @api_client.config.debugging @api_client.config.logger.debug "API called: PDFApi#test_authentication\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#update_data_request(data_request_id, update_submission_data_request_data, opts = {}) ⇒ UpdateDataRequestResponse
Update a submission data request
1426 1427 1428 1429 |
# File 'lib/form_api/api/pdf_api.rb', line 1426 def update_data_request(data_request_id, update_submission_data_request_data, opts = {}) data, _status_code, _headers = update_data_request_with_http_info(data_request_id, update_submission_data_request_data, opts) data end |
#update_data_request_with_http_info(data_request_id, update_submission_data_request_data, opts = {}) ⇒ Array<(UpdateDataRequestResponse, Fixnum, Hash)>
Update a submission data request
1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 |
# File 'lib/form_api/api/pdf_api.rb', line 1436 def update_data_request_with_http_info(data_request_id, update_submission_data_request_data, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: PDFApi.update_data_request ...' end # verify the required parameter 'data_request_id' is set if @api_client.config.client_side_validation && data_request_id.nil? fail ArgumentError, "Missing the required parameter 'data_request_id' when calling PDFApi.update_data_request" end # verify the required parameter 'update_submission_data_request_data' is set if @api_client.config.client_side_validation && update_submission_data_request_data.nil? fail ArgumentError, "Missing the required parameter 'update_submission_data_request_data' when calling PDFApi.update_data_request" end # resource path local_var_path = '/data_requests/{data_request_id}'.sub('{' + 'data_request_id' + '}', data_request_id.to_s) # query parameters query_params = {} # header parameters header_params = {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) # HTTP header 'Content-Type' header_params['Content-Type'] = @api_client.select_header_content_type(['application/json']) # form parameters form_params = {} # http body (model) post_body = @api_client.object_to_http_body(update_submission_data_request_data) auth_names = ['api_token_basic'] data, status_code, headers = @api_client.call_api(:PUT, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'UpdateDataRequestResponse') if @api_client.config.debugging @api_client.config.logger.debug "API called: PDFApi#update_data_request\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |