pdf_generator_api_client 8.0.28 → 8.0.29
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/README.md +12 -7
- data/docs/DocumentSignature.md +42 -0
- data/docs/DocumentSignatures.md +28 -0
- data/docs/DocumentsApi.md +85 -11
- data/docs/FormsApi.md +28 -28
- data/docs/InlineObject17.md +1 -1
- data/docs/InlineObject18.md +2 -4
- data/docs/InlineObject19.md +4 -2
- data/docs/InlineObject20.md +2 -4
- data/docs/InlineObject21.md +4 -2
- data/docs/{InlineObject20Meta.md → InlineObject21Meta.md} +2 -2
- data/docs/InlineObject22.md +2 -2
- data/docs/InlineObject23.md +2 -2
- data/docs/{InlineObject22Response.md → InlineObject23Response.md} +2 -2
- data/docs/InlineObject24.md +1 -1
- data/docs/InlineObject25.md +1 -1
- data/docs/InlineObject26.md +1 -1
- data/docs/InlineObject27.md +1 -3
- data/docs/InlineObject28.md +1 -1
- data/docs/InlineObject29.md +3 -1
- data/docs/InlineObject30.md +18 -0
- data/docs/InlineObject31.md +18 -0
- data/docs/TemplateLibraryApi.md +4 -4
- data/docs/TemplateVersionsApi.md +4 -4
- data/docs/TemplatesApi.md +20 -20
- data/lib/pdf_generator_api_client/api/assets_api.rb +1 -1
- data/lib/pdf_generator_api_client/api/conversion_api.rb +1 -1
- data/lib/pdf_generator_api_client/api/documents_api.rb +76 -10
- data/lib/pdf_generator_api_client/api/e_invoices_api.rb +1 -1
- data/lib/pdf_generator_api_client/api/forms_api.rb +22 -22
- data/lib/pdf_generator_api_client/api/misc_api.rb +1 -1
- data/lib/pdf_generator_api_client/api/services_api.rb +1 -1
- data/lib/pdf_generator_api_client/api/template_library_api.rb +4 -4
- data/lib/pdf_generator_api_client/api/template_versions_api.rb +4 -4
- data/lib/pdf_generator_api_client/api/templates_api.rb +16 -16
- data/lib/pdf_generator_api_client/api/workspaces_api.rb +1 -1
- data/lib/pdf_generator_api_client/api_client.rb +1 -1
- data/lib/pdf_generator_api_client/api_error.rb +1 -1
- data/lib/pdf_generator_api_client/configuration.rb +1 -1
- data/lib/pdf_generator_api_client/models/accessibility_option.rb +1 -1
- data/lib/pdf_generator_api_client/models/add_watermark_request.rb +1 -1
- data/lib/pdf_generator_api_client/models/async_output_param.rb +1 -1
- data/lib/pdf_generator_api_client/models/callback_param.rb +1 -1
- data/lib/pdf_generator_api_client/models/component.rb +1 -1
- data/lib/pdf_generator_api_client/models/convert_html2_pdf_request.rb +1 -1
- data/lib/pdf_generator_api_client/models/convert_pdf2_image_request.rb +1 -1
- data/lib/pdf_generator_api_client/models/convert_url2_pdf_request.rb +1 -1
- data/lib/pdf_generator_api_client/models/copy_template_request.rb +1 -1
- data/lib/pdf_generator_api_client/models/create_e_invoice_request.rb +1 -1
- data/lib/pdf_generator_api_client/models/create_factur_xe_invoice_request.rb +1 -1
- data/lib/pdf_generator_api_client/models/create_factur_xe_invoice_request_template.rb +1 -1
- data/lib/pdf_generator_api_client/models/create_workspace_request.rb +1 -1
- data/lib/pdf_generator_api_client/models/data_batch_inner.rb +1 -1
- data/lib/pdf_generator_api_client/models/document.rb +1 -1
- data/lib/pdf_generator_api_client/models/document_action.rb +1 -1
- data/lib/pdf_generator_api_client/models/document_signature.rb +399 -0
- data/lib/pdf_generator_api_client/models/document_signatures.rb +307 -0
- data/lib/pdf_generator_api_client/models/document_user.rb +1 -1
- data/lib/pdf_generator_api_client/models/document_version.rb +1 -1
- data/lib/pdf_generator_api_client/models/encrypt_and_decrypt_base64.rb +1 -1
- data/lib/pdf_generator_api_client/models/encrypt_and_decrypt_url.rb +1 -1
- data/lib/pdf_generator_api_client/models/encrypt_document_request.rb +1 -1
- data/lib/pdf_generator_api_client/models/extract_form_fields_request.rb +1 -1
- data/lib/pdf_generator_api_client/models/fill_form_fields_request.rb +1 -1
- data/lib/pdf_generator_api_client/models/form_action_download.rb +1 -1
- data/lib/pdf_generator_api_client/models/form_action_send.rb +1 -1
- data/lib/pdf_generator_api_client/models/form_action_send_send_document.rb +1 -1
- data/lib/pdf_generator_api_client/models/form_action_send_send_document_headers_inner.rb +1 -1
- data/lib/pdf_generator_api_client/models/form_action_store.rb +1 -1
- data/lib/pdf_generator_api_client/models/form_configuration.rb +1 -1
- data/lib/pdf_generator_api_client/models/form_configuration_new.rb +1 -1
- data/lib/pdf_generator_api_client/models/form_configuration_new_actions_inner.rb +1 -1
- data/lib/pdf_generator_api_client/models/form_fields_base64.rb +1 -1
- data/lib/pdf_generator_api_client/models/form_fields_inner.rb +1 -1
- data/lib/pdf_generator_api_client/models/form_fields_url.rb +1 -1
- data/lib/pdf_generator_api_client/models/form_fill_base64.rb +1 -1
- data/lib/pdf_generator_api_client/models/form_fill_url.rb +1 -1
- data/lib/pdf_generator_api_client/models/format_param.rb +1 -1
- data/lib/pdf_generator_api_client/models/generate_document_asynchronous_request.rb +1 -1
- data/lib/pdf_generator_api_client/models/generate_document_batch_asynchronous_request.rb +1 -1
- data/lib/pdf_generator_api_client/models/generate_document_batch_request.rb +1 -1
- data/lib/pdf_generator_api_client/models/generate_document_request.rb +1 -1
- data/lib/pdf_generator_api_client/models/generate_qr_code201_response.rb +1 -1
- data/lib/pdf_generator_api_client/models/generate_qr_code201_response_meta.rb +1 -1
- data/lib/pdf_generator_api_client/models/generate_qr_code_request.rb +1 -1
- data/lib/pdf_generator_api_client/models/generate_viewer_url200_response.rb +1 -1
- data/lib/pdf_generator_api_client/models/generate_viewer_url200_response_meta.rb +1 -1
- data/lib/pdf_generator_api_client/models/generate_viewer_url_request.rb +1 -1
- data/lib/pdf_generator_api_client/models/get_status200_response.rb +1 -1
- data/lib/pdf_generator_api_client/models/get_template_library200_response.rb +1 -1
- data/lib/pdf_generator_api_client/models/get_template_version422_response.rb +1 -1
- data/lib/pdf_generator_api_client/models/import_form_base64.rb +1 -1
- data/lib/pdf_generator_api_client/models/import_form_request.rb +1 -1
- data/lib/pdf_generator_api_client/models/import_form_url.rb +1 -1
- data/lib/pdf_generator_api_client/models/import_template_base64.rb +1 -1
- data/lib/pdf_generator_api_client/models/import_template_request.rb +1 -1
- data/lib/pdf_generator_api_client/models/import_template_url.rb +1 -1
- data/lib/pdf_generator_api_client/models/import_template_url_template.rb +1 -1
- data/lib/pdf_generator_api_client/models/inline_object.rb +1 -1
- data/lib/pdf_generator_api_client/models/inline_object1.rb +1 -1
- data/lib/pdf_generator_api_client/models/inline_object10.rb +1 -1
- data/lib/pdf_generator_api_client/models/inline_object10_meta.rb +1 -1
- data/lib/pdf_generator_api_client/models/inline_object11.rb +1 -1
- data/lib/pdf_generator_api_client/models/inline_object11_meta.rb +1 -1
- data/lib/pdf_generator_api_client/models/inline_object12.rb +1 -1
- data/lib/pdf_generator_api_client/models/inline_object12_meta.rb +1 -1
- data/lib/pdf_generator_api_client/models/inline_object12_meta_stats.rb +1 -1
- data/lib/pdf_generator_api_client/models/inline_object13.rb +1 -1
- data/lib/pdf_generator_api_client/models/inline_object14.rb +1 -1
- data/lib/pdf_generator_api_client/models/inline_object14_response_value.rb +1 -1
- data/lib/pdf_generator_api_client/models/inline_object14_response_value_default.rb +1 -1
- data/lib/pdf_generator_api_client/models/inline_object14_response_value_value.rb +1 -1
- data/lib/pdf_generator_api_client/models/inline_object15.rb +1 -1
- data/lib/pdf_generator_api_client/models/inline_object16.rb +1 -1
- data/lib/pdf_generator_api_client/models/inline_object17.rb +3 -5
- data/lib/pdf_generator_api_client/models/inline_object18.rb +8 -15
- data/lib/pdf_generator_api_client/models/inline_object19.rb +14 -5
- data/lib/pdf_generator_api_client/models/inline_object1_response.rb +1 -1
- data/lib/pdf_generator_api_client/models/inline_object2.rb +1 -1
- data/lib/pdf_generator_api_client/models/inline_object20.rb +5 -15
- data/lib/pdf_generator_api_client/models/inline_object21.rb +15 -6
- data/lib/pdf_generator_api_client/models/{inline_object20_meta.rb → inline_object21_meta.rb} +4 -4
- data/lib/pdf_generator_api_client/models/inline_object22.rb +3 -2
- data/lib/pdf_generator_api_client/models/inline_object23.rb +8 -43
- data/lib/pdf_generator_api_client/models/{inline_object22_response.rb → inline_object23_response.rb} +4 -4
- data/lib/pdf_generator_api_client/models/inline_object24.rb +3 -3
- data/lib/pdf_generator_api_client/models/inline_object25.rb +3 -3
- data/lib/pdf_generator_api_client/models/inline_object26.rb +3 -3
- data/lib/pdf_generator_api_client/models/inline_object27.rb +38 -14
- data/lib/pdf_generator_api_client/models/inline_object28.rb +1 -1
- data/lib/pdf_generator_api_client/models/inline_object29.rb +15 -5
- data/lib/pdf_generator_api_client/models/inline_object3.rb +1 -1
- data/lib/pdf_generator_api_client/models/inline_object30.rb +221 -0
- data/lib/pdf_generator_api_client/models/inline_object31.rb +221 -0
- data/lib/pdf_generator_api_client/models/inline_object4.rb +1 -1
- data/lib/pdf_generator_api_client/models/inline_object5.rb +1 -1
- data/lib/pdf_generator_api_client/models/inline_object6.rb +1 -1
- data/lib/pdf_generator_api_client/models/inline_object7.rb +1 -1
- data/lib/pdf_generator_api_client/models/inline_object7_response.rb +1 -1
- data/lib/pdf_generator_api_client/models/inline_object8.rb +1 -1
- data/lib/pdf_generator_api_client/models/inline_object9.rb +1 -1
- data/lib/pdf_generator_api_client/models/inline_object9_meta.rb +1 -1
- data/lib/pdf_generator_api_client/models/inline_object_meta.rb +1 -1
- data/lib/pdf_generator_api_client/models/key_field_param.rb +1 -1
- data/lib/pdf_generator_api_client/models/make_accessible_base64.rb +1 -1
- data/lib/pdf_generator_api_client/models/make_accessible_request.rb +1 -1
- data/lib/pdf_generator_api_client/models/make_accessible_url.rb +1 -1
- data/lib/pdf_generator_api_client/models/metadata_param.rb +1 -1
- data/lib/pdf_generator_api_client/models/open_editor_request.rb +1 -1
- data/lib/pdf_generator_api_client/models/open_editor_request_data.rb +1 -1
- data/lib/pdf_generator_api_client/models/optimize_base64.rb +1 -1
- data/lib/pdf_generator_api_client/models/optimize_document_request.rb +1 -1
- data/lib/pdf_generator_api_client/models/optimize_url.rb +1 -1
- data/lib/pdf_generator_api_client/models/output_param.rb +1 -1
- data/lib/pdf_generator_api_client/models/pagination_meta.rb +1 -1
- data/lib/pdf_generator_api_client/models/prefill_param.rb +1 -1
- data/lib/pdf_generator_api_client/models/promote_template_version200_response.rb +1 -1
- data/lib/pdf_generator_api_client/models/public_template_library_item.rb +1 -1
- data/lib/pdf_generator_api_client/models/status_param.rb +1 -1
- data/lib/pdf_generator_api_client/models/store_document_request.rb +1 -1
- data/lib/pdf_generator_api_client/models/template.rb +1 -1
- data/lib/pdf_generator_api_client/models/template_definition.rb +1 -1
- data/lib/pdf_generator_api_client/models/template_definition_data_settings.rb +1 -1
- data/lib/pdf_generator_api_client/models/template_definition_editor.rb +1 -1
- data/lib/pdf_generator_api_client/models/template_definition_new.rb +1 -1
- data/lib/pdf_generator_api_client/models/template_definition_new_data_settings.rb +1 -1
- data/lib/pdf_generator_api_client/models/template_definition_new_editor.rb +1 -1
- data/lib/pdf_generator_api_client/models/template_definition_new_layout.rb +1 -1
- data/lib/pdf_generator_api_client/models/template_definition_new_layout_margins.rb +1 -1
- data/lib/pdf_generator_api_client/models/template_definition_new_layout_repeat_layout.rb +1 -1
- data/lib/pdf_generator_api_client/models/template_definition_new_pages_inner.rb +1 -1
- data/lib/pdf_generator_api_client/models/template_definition_new_pages_inner_margins.rb +1 -1
- data/lib/pdf_generator_api_client/models/template_definition_pages_inner.rb +1 -1
- data/lib/pdf_generator_api_client/models/template_param.rb +1 -1
- data/lib/pdf_generator_api_client/models/template_param_data.rb +1 -1
- data/lib/pdf_generator_api_client/models/template_param_id.rb +1 -1
- data/lib/pdf_generator_api_client/models/template_version.rb +1 -1
- data/lib/pdf_generator_api_client/models/template_version_collection.rb +1 -1
- data/lib/pdf_generator_api_client/models/template_version_collection_meta.rb +1 -1
- data/lib/pdf_generator_api_client/models/watermark_base64.rb +1 -1
- data/lib/pdf_generator_api_client/models/watermark_file_url_watermark.rb +1 -1
- data/lib/pdf_generator_api_client/models/watermark_image.rb +1 -1
- data/lib/pdf_generator_api_client/models/watermark_image_content_base64.rb +1 -1
- data/lib/pdf_generator_api_client/models/watermark_image_content_url.rb +1 -1
- data/lib/pdf_generator_api_client/models/watermark_position.rb +1 -1
- data/lib/pdf_generator_api_client/models/watermark_text.rb +1 -1
- data/lib/pdf_generator_api_client/models/workspace.rb +1 -1
- data/lib/pdf_generator_api_client/version.rb +2 -2
- data/lib/pdf_generator_api_client.rb +7 -3
- data/pdf_generator_api_client.gemspec +1 -1
- data/spec/api/assets_api_spec.rb +1 -1
- data/spec/api/conversion_api_spec.rb +1 -1
- data/spec/api/documents_api_spec.rb +17 -4
- data/spec/api/e_invoices_api_spec.rb +1 -1
- data/spec/api/forms_api_spec.rb +8 -8
- data/spec/api/misc_api_spec.rb +1 -1
- data/spec/api/services_api_spec.rb +1 -1
- data/spec/api/template_library_api_spec.rb +2 -2
- data/spec/api/template_versions_api_spec.rb +2 -2
- data/spec/api/templates_api_spec.rb +6 -6
- data/spec/api/workspaces_api_spec.rb +1 -1
- data/spec/models/accessibility_option_spec.rb +1 -1
- data/spec/models/add_watermark_request_spec.rb +1 -1
- data/spec/models/async_output_param_spec.rb +1 -1
- data/spec/models/callback_param_spec.rb +1 -1
- data/spec/models/component_spec.rb +1 -1
- data/spec/models/convert_html2_pdf_request_spec.rb +1 -1
- data/spec/models/convert_pdf2_image_request_spec.rb +1 -1
- data/spec/models/convert_url2_pdf_request_spec.rb +1 -1
- data/spec/models/copy_template_request_spec.rb +1 -1
- data/spec/models/create_e_invoice_request_spec.rb +1 -1
- data/spec/models/create_factur_xe_invoice_request_spec.rb +1 -1
- data/spec/models/create_factur_xe_invoice_request_template_spec.rb +1 -1
- data/spec/models/create_workspace_request_spec.rb +1 -1
- data/spec/models/data_batch_inner_spec.rb +1 -1
- data/spec/models/document_action_spec.rb +1 -1
- data/spec/models/document_signature_spec.rb +116 -0
- data/spec/models/document_signatures_spec.rb +70 -0
- data/spec/models/document_spec.rb +1 -1
- data/spec/models/document_user_spec.rb +1 -1
- data/spec/models/document_version_spec.rb +1 -1
- data/spec/models/encrypt_and_decrypt_base64_spec.rb +1 -1
- data/spec/models/encrypt_and_decrypt_url_spec.rb +1 -1
- data/spec/models/encrypt_document_request_spec.rb +1 -1
- data/spec/models/extract_form_fields_request_spec.rb +1 -1
- data/spec/models/fill_form_fields_request_spec.rb +1 -1
- data/spec/models/form_action_download_spec.rb +1 -1
- data/spec/models/form_action_send_send_document_headers_inner_spec.rb +1 -1
- data/spec/models/form_action_send_send_document_spec.rb +1 -1
- data/spec/models/form_action_send_spec.rb +1 -1
- data/spec/models/form_action_store_spec.rb +1 -1
- data/spec/models/form_configuration_new_actions_inner_spec.rb +1 -1
- data/spec/models/form_configuration_new_spec.rb +1 -1
- data/spec/models/form_configuration_spec.rb +1 -1
- data/spec/models/form_fields_base64_spec.rb +1 -1
- data/spec/models/form_fields_inner_spec.rb +1 -1
- data/spec/models/form_fields_url_spec.rb +1 -1
- data/spec/models/form_fill_base64_spec.rb +1 -1
- data/spec/models/form_fill_url_spec.rb +1 -1
- data/spec/models/format_param_spec.rb +1 -1
- data/spec/models/generate_document_asynchronous_request_spec.rb +1 -1
- data/spec/models/generate_document_batch_asynchronous_request_spec.rb +1 -1
- data/spec/models/generate_document_batch_request_spec.rb +1 -1
- data/spec/models/generate_document_request_spec.rb +1 -1
- data/spec/models/generate_qr_code201_response_meta_spec.rb +1 -1
- data/spec/models/generate_qr_code201_response_spec.rb +1 -1
- data/spec/models/generate_qr_code_request_spec.rb +1 -1
- data/spec/models/generate_viewer_url200_response_meta_spec.rb +1 -1
- data/spec/models/generate_viewer_url200_response_spec.rb +1 -1
- data/spec/models/generate_viewer_url_request_spec.rb +1 -1
- data/spec/models/get_status200_response_spec.rb +1 -1
- data/spec/models/get_template_library200_response_spec.rb +1 -1
- data/spec/models/get_template_version422_response_spec.rb +1 -1
- data/spec/models/import_form_base64_spec.rb +1 -1
- data/spec/models/import_form_request_spec.rb +1 -1
- data/spec/models/import_form_url_spec.rb +1 -1
- data/spec/models/import_template_base64_spec.rb +1 -1
- data/spec/models/import_template_request_spec.rb +1 -1
- data/spec/models/import_template_url_spec.rb +1 -1
- data/spec/models/import_template_url_template_spec.rb +1 -1
- data/spec/models/inline_object10_meta_spec.rb +1 -1
- data/spec/models/inline_object10_spec.rb +1 -1
- data/spec/models/inline_object11_meta_spec.rb +1 -1
- data/spec/models/inline_object11_spec.rb +1 -1
- data/spec/models/inline_object12_meta_spec.rb +1 -1
- data/spec/models/inline_object12_meta_stats_spec.rb +1 -1
- data/spec/models/inline_object12_spec.rb +1 -1
- data/spec/models/inline_object13_spec.rb +1 -1
- data/spec/models/inline_object14_response_value_default_spec.rb +1 -1
- data/spec/models/inline_object14_response_value_spec.rb +1 -1
- data/spec/models/inline_object14_response_value_value_spec.rb +1 -1
- data/spec/models/inline_object14_spec.rb +1 -1
- data/spec/models/inline_object15_spec.rb +1 -1
- data/spec/models/inline_object16_spec.rb +1 -1
- data/spec/models/inline_object17_spec.rb +1 -1
- data/spec/models/inline_object18_spec.rb +1 -7
- data/spec/models/inline_object19_spec.rb +7 -1
- data/spec/models/inline_object1_response_spec.rb +1 -1
- data/spec/models/inline_object1_spec.rb +1 -1
- data/spec/models/inline_object20_spec.rb +1 -7
- data/spec/models/{inline_object20_meta_spec.rb → inline_object21_meta_spec.rb} +7 -7
- data/spec/models/inline_object21_spec.rb +7 -1
- data/spec/models/inline_object22_spec.rb +1 -1
- data/spec/models/{inline_object22_response_spec.rb → inline_object23_response_spec.rb} +7 -7
- data/spec/models/inline_object23_spec.rb +2 -6
- data/spec/models/inline_object24_spec.rb +2 -2
- data/spec/models/inline_object25_spec.rb +2 -2
- data/spec/models/inline_object26_spec.rb +2 -2
- data/spec/models/inline_object27_spec.rb +5 -7
- data/spec/models/inline_object28_spec.rb +1 -1
- data/spec/models/inline_object29_spec.rb +7 -1
- data/spec/models/inline_object2_spec.rb +1 -1
- data/spec/models/inline_object30_spec.rb +36 -0
- data/spec/models/inline_object31_spec.rb +36 -0
- data/spec/models/inline_object3_spec.rb +1 -1
- data/spec/models/inline_object4_spec.rb +1 -1
- data/spec/models/inline_object5_spec.rb +1 -1
- data/spec/models/inline_object6_spec.rb +1 -1
- data/spec/models/inline_object7_response_spec.rb +1 -1
- data/spec/models/inline_object7_spec.rb +1 -1
- data/spec/models/inline_object8_spec.rb +1 -1
- data/spec/models/inline_object9_meta_spec.rb +1 -1
- data/spec/models/inline_object9_spec.rb +1 -1
- data/spec/models/inline_object_meta_spec.rb +1 -1
- data/spec/models/inline_object_spec.rb +1 -1
- data/spec/models/key_field_param_spec.rb +1 -1
- data/spec/models/make_accessible_base64_spec.rb +1 -1
- data/spec/models/make_accessible_request_spec.rb +1 -1
- data/spec/models/make_accessible_url_spec.rb +1 -1
- data/spec/models/metadata_param_spec.rb +1 -1
- data/spec/models/open_editor_request_data_spec.rb +1 -1
- data/spec/models/open_editor_request_spec.rb +1 -1
- data/spec/models/optimize_base64_spec.rb +1 -1
- data/spec/models/optimize_document_request_spec.rb +1 -1
- data/spec/models/optimize_url_spec.rb +1 -1
- data/spec/models/output_param_spec.rb +1 -1
- data/spec/models/pagination_meta_spec.rb +1 -1
- data/spec/models/prefill_param_spec.rb +1 -1
- data/spec/models/promote_template_version200_response_spec.rb +1 -1
- data/spec/models/public_template_library_item_spec.rb +1 -1
- data/spec/models/status_param_spec.rb +1 -1
- data/spec/models/store_document_request_spec.rb +1 -1
- data/spec/models/template_definition_data_settings_spec.rb +1 -1
- data/spec/models/template_definition_editor_spec.rb +1 -1
- data/spec/models/template_definition_new_data_settings_spec.rb +1 -1
- data/spec/models/template_definition_new_editor_spec.rb +1 -1
- data/spec/models/template_definition_new_layout_margins_spec.rb +1 -1
- data/spec/models/template_definition_new_layout_repeat_layout_spec.rb +1 -1
- data/spec/models/template_definition_new_layout_spec.rb +1 -1
- data/spec/models/template_definition_new_pages_inner_margins_spec.rb +1 -1
- data/spec/models/template_definition_new_pages_inner_spec.rb +1 -1
- data/spec/models/template_definition_new_spec.rb +1 -1
- data/spec/models/template_definition_pages_inner_spec.rb +1 -1
- data/spec/models/template_definition_spec.rb +1 -1
- data/spec/models/template_param_data_spec.rb +1 -1
- data/spec/models/template_param_id_spec.rb +1 -1
- data/spec/models/template_param_spec.rb +1 -1
- data/spec/models/template_spec.rb +1 -1
- data/spec/models/template_version_collection_meta_spec.rb +1 -1
- data/spec/models/template_version_collection_spec.rb +1 -1
- data/spec/models/template_version_spec.rb +1 -1
- data/spec/models/watermark_base64_spec.rb +1 -1
- data/spec/models/watermark_file_url_watermark_spec.rb +1 -1
- data/spec/models/watermark_image_content_base64_spec.rb +1 -1
- data/spec/models/watermark_image_content_url_spec.rb +1 -1
- data/spec/models/watermark_image_spec.rb +1 -1
- data/spec/models/watermark_position_spec.rb +1 -1
- data/spec/models/watermark_text_spec.rb +1 -1
- data/spec/models/workspace_spec.rb +1 -1
- data/spec/spec_helper.rb +1 -1
- metadata +151 -135
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: 227d8a0d103851d2e66af2da6182e189c87e44e4d9426c0dd6532354655860fe
|
|
4
|
+
data.tar.gz: 2a342fa09f651854a346da44dc63cfb116447119fccdf74076369ef82a49bfdb
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: 5b23d40b72da750605bd513cd7d778ae36549f8685fc492bea0d6cf32aaaeb40a7fd5c32e563064a024847dd0b24c47a06548fe23784e7d671e9c3b8e95adca1
|
|
7
|
+
data.tar.gz: 0a1f0eceda8d69b6a11397dfb001d234f374c9bba60df3f6275ee319e1baaf5ddc50ce12dcf9d373200f42a66d8b85cd987720181da88953611745f2f0398473
|
data/README.md
CHANGED
|
@@ -234,8 +234,8 @@ You can also use [jwt.io](https://jwt.io/) to generate test tokens for your API
|
|
|
234
234
|
|
|
235
235
|
This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
|
|
236
236
|
|
|
237
|
-
- API version: 4.0.
|
|
238
|
-
- Package version: 8.0.
|
|
237
|
+
- API version: 4.0.29
|
|
238
|
+
- Package version: 8.0.29
|
|
239
239
|
- Generator version: 7.14.0
|
|
240
240
|
- Build package: org.openapitools.codegen.languages.RubyClientCodegen
|
|
241
241
|
For more information, please visit [https://support.pdfgeneratorapi.com](https://support.pdfgeneratorapi.com)
|
|
@@ -253,16 +253,16 @@ gem build pdf_generator_api_client.gemspec
|
|
|
253
253
|
Then either install the gem locally:
|
|
254
254
|
|
|
255
255
|
```shell
|
|
256
|
-
gem install ./pdf_generator_api_client-8.0.
|
|
256
|
+
gem install ./pdf_generator_api_client-8.0.29.gem
|
|
257
257
|
```
|
|
258
258
|
|
|
259
|
-
(for development, run `gem install --dev ./pdf_generator_api_client-8.0.
|
|
259
|
+
(for development, run `gem install --dev ./pdf_generator_api_client-8.0.29.gem` to install the development dependencies)
|
|
260
260
|
|
|
261
261
|
or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
|
|
262
262
|
|
|
263
263
|
Finally add this to the Gemfile:
|
|
264
264
|
|
|
265
|
-
gem 'pdf_generator_api_client', '~> 8.0.
|
|
265
|
+
gem 'pdf_generator_api_client', '~> 8.0.29'
|
|
266
266
|
|
|
267
267
|
### Install from Git
|
|
268
268
|
|
|
@@ -326,6 +326,7 @@ Class | Method | HTTP request | Description
|
|
|
326
326
|
*PDFGeneratorAPI::DocumentsApi* | [**get_async_job_status**](docs/DocumentsApi.md#get_async_job_status) | **GET** /documents/async/{jobId} | Get job status
|
|
327
327
|
*PDFGeneratorAPI::DocumentsApi* | [**get_document**](docs/DocumentsApi.md#get_document) | **GET** /documents/{publicId} | Get document
|
|
328
328
|
*PDFGeneratorAPI::DocumentsApi* | [**get_document_actions**](docs/DocumentsApi.md#get_document_actions) | **GET** /documents/{publicId}/actions | Get document actions
|
|
329
|
+
*PDFGeneratorAPI::DocumentsApi* | [**get_document_signatures**](docs/DocumentsApi.md#get_document_signatures) | **GET** /documents/{publicId}/signatures | Validate document signatures
|
|
329
330
|
*PDFGeneratorAPI::DocumentsApi* | [**get_document_versions**](docs/DocumentsApi.md#get_document_versions) | **GET** /documents/{publicId}/versions | Get document versions
|
|
330
331
|
*PDFGeneratorAPI::DocumentsApi* | [**get_documents**](docs/DocumentsApi.md#get_documents) | **GET** /documents | Get documents
|
|
331
332
|
*PDFGeneratorAPI::DocumentsApi* | [**store_document**](docs/DocumentsApi.md#store_document) | **POST** /documents | Store document
|
|
@@ -391,6 +392,8 @@ Class | Method | HTTP request | Description
|
|
|
391
392
|
- [PDFGeneratorAPI::DataBatchInner](docs/DataBatchInner.md)
|
|
392
393
|
- [PDFGeneratorAPI::Document](docs/Document.md)
|
|
393
394
|
- [PDFGeneratorAPI::DocumentAction](docs/DocumentAction.md)
|
|
395
|
+
- [PDFGeneratorAPI::DocumentSignature](docs/DocumentSignature.md)
|
|
396
|
+
- [PDFGeneratorAPI::DocumentSignatures](docs/DocumentSignatures.md)
|
|
394
397
|
- [PDFGeneratorAPI::DocumentUser](docs/DocumentUser.md)
|
|
395
398
|
- [PDFGeneratorAPI::DocumentVersion](docs/DocumentVersion.md)
|
|
396
399
|
- [PDFGeneratorAPI::EncryptAndDecryptBase64](docs/EncryptAndDecryptBase64.md)
|
|
@@ -454,11 +457,11 @@ Class | Method | HTTP request | Description
|
|
|
454
457
|
- [PDFGeneratorAPI::InlineObject1Response](docs/InlineObject1Response.md)
|
|
455
458
|
- [PDFGeneratorAPI::InlineObject2](docs/InlineObject2.md)
|
|
456
459
|
- [PDFGeneratorAPI::InlineObject20](docs/InlineObject20.md)
|
|
457
|
-
- [PDFGeneratorAPI::InlineObject20Meta](docs/InlineObject20Meta.md)
|
|
458
460
|
- [PDFGeneratorAPI::InlineObject21](docs/InlineObject21.md)
|
|
461
|
+
- [PDFGeneratorAPI::InlineObject21Meta](docs/InlineObject21Meta.md)
|
|
459
462
|
- [PDFGeneratorAPI::InlineObject22](docs/InlineObject22.md)
|
|
460
|
-
- [PDFGeneratorAPI::InlineObject22Response](docs/InlineObject22Response.md)
|
|
461
463
|
- [PDFGeneratorAPI::InlineObject23](docs/InlineObject23.md)
|
|
464
|
+
- [PDFGeneratorAPI::InlineObject23Response](docs/InlineObject23Response.md)
|
|
462
465
|
- [PDFGeneratorAPI::InlineObject24](docs/InlineObject24.md)
|
|
463
466
|
- [PDFGeneratorAPI::InlineObject25](docs/InlineObject25.md)
|
|
464
467
|
- [PDFGeneratorAPI::InlineObject26](docs/InlineObject26.md)
|
|
@@ -466,6 +469,8 @@ Class | Method | HTTP request | Description
|
|
|
466
469
|
- [PDFGeneratorAPI::InlineObject28](docs/InlineObject28.md)
|
|
467
470
|
- [PDFGeneratorAPI::InlineObject29](docs/InlineObject29.md)
|
|
468
471
|
- [PDFGeneratorAPI::InlineObject3](docs/InlineObject3.md)
|
|
472
|
+
- [PDFGeneratorAPI::InlineObject30](docs/InlineObject30.md)
|
|
473
|
+
- [PDFGeneratorAPI::InlineObject31](docs/InlineObject31.md)
|
|
469
474
|
- [PDFGeneratorAPI::InlineObject4](docs/InlineObject4.md)
|
|
470
475
|
- [PDFGeneratorAPI::InlineObject5](docs/InlineObject5.md)
|
|
471
476
|
- [PDFGeneratorAPI::InlineObject6](docs/InlineObject6.md)
|
|
@@ -0,0 +1,42 @@
|
|
|
1
|
+
# PDFGeneratorAPI::DocumentSignature
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **field_name** | **String** | Name of the signature field in the document. | [optional] |
|
|
8
|
+
| **signer_name** | **String** | The name the signer signed under. | [optional] |
|
|
9
|
+
| **signer** | **String** | Subject of the certificate that sealed it — an organization, not a person. | [optional] |
|
|
10
|
+
| **issuer** | **String** | Subject of the certificate authority that issued it. | [optional] |
|
|
11
|
+
| **signed_at** | **String** | When a timestamp authority attested the signature (ISO-8601). This is the defensible time; the signer's own clock proves nothing. | [optional] |
|
|
12
|
+
| **claimed_signed_at** | **String** | The time the signer's own software recorded (ISO-8601). | [optional] |
|
|
13
|
+
| **timestamp_authority** | **String** | The timestamp authority that attested the signature. | [optional] |
|
|
14
|
+
| **intact** | **Boolean** | The bytes this signature covers are unchanged. | [optional] |
|
|
15
|
+
| **valid** | **Boolean** | The signature block itself adds up. On its own this does NOT mean the document is unchanged: a tampered file reports `valid` true with `intact` false, so a verdict needs intact AND valid AND trusted. | [optional] |
|
|
16
|
+
| **trusted** | **Boolean** | The certificate chains to a trusted root. | [optional] |
|
|
17
|
+
| **coverage** | **String** | How much of the file this signature protects. | [optional] |
|
|
18
|
+
| **ades_indication** | **String** | The ETSI EN 319 102-1 indication, when the AdES engine could run. | [optional] |
|
|
19
|
+
| **ades_sub_indication** | **String** | The AdES sub-indication, naming why an indication is not PASSED. | [optional] |
|
|
20
|
+
|
|
21
|
+
## Example
|
|
22
|
+
|
|
23
|
+
```ruby
|
|
24
|
+
require 'pdf_generator_api_client'
|
|
25
|
+
|
|
26
|
+
instance = PDFGeneratorAPI::DocumentSignature.new(
|
|
27
|
+
field_name: disclosing_party_signature,
|
|
28
|
+
signer_name: Jane Doe,
|
|
29
|
+
signer: Common Name: Actual Reports OÜ, Organization: Actual Reports OÜ, Country: EE,
|
|
30
|
+
issuer: Common Name: SSL.com Client Certificate Intermediate CA RSA R2, Country: US,
|
|
31
|
+
signed_at: 2026-08-21T09:17:08+00:00,
|
|
32
|
+
claimed_signed_at: 2026-08-21T09:17:06+00:00,
|
|
33
|
+
timestamp_authority: Common Name: SSL.com Timestamping Unit 2025 E1, Country: US,
|
|
34
|
+
intact: true,
|
|
35
|
+
valid: true,
|
|
36
|
+
trusted: true,
|
|
37
|
+
coverage: ENTIRE_FILE,
|
|
38
|
+
ades_indication: PASSED,
|
|
39
|
+
ades_sub_indication: OK
|
|
40
|
+
)
|
|
41
|
+
```
|
|
42
|
+
|
|
@@ -0,0 +1,28 @@
|
|
|
1
|
+
# PDFGeneratorAPI::DocumentSignatures
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **status** | **String** | The one-line answer, reduced from every signature worst case first. `unavailable` means signature validation is not enabled on this deployment — it says nothing about the document. | [optional] |
|
|
8
|
+
| **status_label** | **String** | The status in words, ready to display. | [optional] |
|
|
9
|
+
| **has_long_term_validation** | **Boolean** | The document carries the certificate and revocation data needed to verify it after the signing certificates expire. | [optional] |
|
|
10
|
+
| **covers_whole_document** | **Boolean** | The last signature covers every byte, so nothing was appended after it. | [optional] |
|
|
11
|
+
| **document_timestamps** | **Integer** | Timestamp-only signatures, counted rather than listed: they are machinery, not people, and would double every signer. | [optional] |
|
|
12
|
+
| **signatures** | [**Array<DocumentSignature>**](DocumentSignature.md) | One entry per signature, excluding document timestamps. | [optional] |
|
|
13
|
+
|
|
14
|
+
## Example
|
|
15
|
+
|
|
16
|
+
```ruby
|
|
17
|
+
require 'pdf_generator_api_client'
|
|
18
|
+
|
|
19
|
+
instance = PDFGeneratorAPI::DocumentSignatures.new(
|
|
20
|
+
status: valid,
|
|
21
|
+
status_label: Signed, and every signature is valid,
|
|
22
|
+
has_long_term_validation: true,
|
|
23
|
+
covers_whole_document: true,
|
|
24
|
+
document_timestamps: 2,
|
|
25
|
+
signatures: null
|
|
26
|
+
)
|
|
27
|
+
```
|
|
28
|
+
|
data/docs/DocumentsApi.md
CHANGED
|
@@ -13,6 +13,7 @@ All URIs are relative to *https://us1.pdfgeneratorapi.com/api/v4*
|
|
|
13
13
|
| [**get_async_job_status**](DocumentsApi.md#get_async_job_status) | **GET** /documents/async/{jobId} | Get job status |
|
|
14
14
|
| [**get_document**](DocumentsApi.md#get_document) | **GET** /documents/{publicId} | Get document |
|
|
15
15
|
| [**get_document_actions**](DocumentsApi.md#get_document_actions) | **GET** /documents/{publicId}/actions | Get document actions |
|
|
16
|
+
| [**get_document_signatures**](DocumentsApi.md#get_document_signatures) | **GET** /documents/{publicId}/signatures | Validate document signatures |
|
|
16
17
|
| [**get_document_versions**](DocumentsApi.md#get_document_versions) | **GET** /documents/{publicId}/versions | Get document versions |
|
|
17
18
|
| [**get_documents**](DocumentsApi.md#get_documents) | **GET** /documents | Get documents |
|
|
18
19
|
| [**store_document**](DocumentsApi.md#store_document) | **POST** /documents | Store document |
|
|
@@ -157,7 +158,7 @@ end
|
|
|
157
158
|
|
|
158
159
|
## generate_document_asynchronous
|
|
159
160
|
|
|
160
|
-
> <
|
|
161
|
+
> <InlineObject23> generate_document_asynchronous(generate_document_asynchronous_request)
|
|
161
162
|
|
|
162
163
|
Generate document (async)
|
|
163
164
|
|
|
@@ -190,7 +191,7 @@ end
|
|
|
190
191
|
|
|
191
192
|
This returns an Array which contains the response data, status code and headers.
|
|
192
193
|
|
|
193
|
-
> <Array(<
|
|
194
|
+
> <Array(<InlineObject23>, Integer, Hash)> generate_document_asynchronous_with_http_info(generate_document_asynchronous_request)
|
|
194
195
|
|
|
195
196
|
```ruby
|
|
196
197
|
begin
|
|
@@ -198,7 +199,7 @@ begin
|
|
|
198
199
|
data, status_code, headers = api_instance.generate_document_asynchronous_with_http_info(generate_document_asynchronous_request)
|
|
199
200
|
p status_code # => 2xx
|
|
200
201
|
p headers # => { ... }
|
|
201
|
-
p data # => <
|
|
202
|
+
p data # => <InlineObject23>
|
|
202
203
|
rescue PDFGeneratorAPI::ApiError => e
|
|
203
204
|
puts "Error when calling DocumentsApi->generate_document_asynchronous_with_http_info: #{e}"
|
|
204
205
|
end
|
|
@@ -212,7 +213,7 @@ end
|
|
|
212
213
|
|
|
213
214
|
### Return type
|
|
214
215
|
|
|
215
|
-
[**
|
|
216
|
+
[**InlineObject23**](InlineObject23.md)
|
|
216
217
|
|
|
217
218
|
### Authorization
|
|
218
219
|
|
|
@@ -295,7 +296,7 @@ end
|
|
|
295
296
|
|
|
296
297
|
## generate_document_batch_asynchronous
|
|
297
298
|
|
|
298
|
-
> <
|
|
299
|
+
> <InlineObject23> generate_document_batch_asynchronous(generate_document_batch_asynchronous_request)
|
|
299
300
|
|
|
300
301
|
Generate document (batch + async)
|
|
301
302
|
|
|
@@ -328,7 +329,7 @@ end
|
|
|
328
329
|
|
|
329
330
|
This returns an Array which contains the response data, status code and headers.
|
|
330
331
|
|
|
331
|
-
> <Array(<
|
|
332
|
+
> <Array(<InlineObject23>, Integer, Hash)> generate_document_batch_asynchronous_with_http_info(generate_document_batch_asynchronous_request)
|
|
332
333
|
|
|
333
334
|
```ruby
|
|
334
335
|
begin
|
|
@@ -336,7 +337,7 @@ begin
|
|
|
336
337
|
data, status_code, headers = api_instance.generate_document_batch_asynchronous_with_http_info(generate_document_batch_asynchronous_request)
|
|
337
338
|
p status_code # => 2xx
|
|
338
339
|
p headers # => { ... }
|
|
339
|
-
p data # => <
|
|
340
|
+
p data # => <InlineObject23>
|
|
340
341
|
rescue PDFGeneratorAPI::ApiError => e
|
|
341
342
|
puts "Error when calling DocumentsApi->generate_document_batch_asynchronous_with_http_info: #{e}"
|
|
342
343
|
end
|
|
@@ -350,7 +351,7 @@ end
|
|
|
350
351
|
|
|
351
352
|
### Return type
|
|
352
353
|
|
|
353
|
-
[**
|
|
354
|
+
[**InlineObject23**](InlineObject23.md)
|
|
354
355
|
|
|
355
356
|
### Authorization
|
|
356
357
|
|
|
@@ -575,7 +576,7 @@ end
|
|
|
575
576
|
|
|
576
577
|
## get_document_actions
|
|
577
578
|
|
|
578
|
-
> <
|
|
579
|
+
> <InlineObject18> get_document_actions(public_id)
|
|
579
580
|
|
|
580
581
|
Get document actions
|
|
581
582
|
|
|
@@ -608,7 +609,7 @@ end
|
|
|
608
609
|
|
|
609
610
|
This returns an Array which contains the response data, status code and headers.
|
|
610
611
|
|
|
611
|
-
> <Array(<
|
|
612
|
+
> <Array(<InlineObject18>, Integer, Hash)> get_document_actions_with_http_info(public_id)
|
|
612
613
|
|
|
613
614
|
```ruby
|
|
614
615
|
begin
|
|
@@ -616,7 +617,7 @@ begin
|
|
|
616
617
|
data, status_code, headers = api_instance.get_document_actions_with_http_info(public_id)
|
|
617
618
|
p status_code # => 2xx
|
|
618
619
|
p headers # => { ... }
|
|
619
|
-
p data # => <
|
|
620
|
+
p data # => <InlineObject18>
|
|
620
621
|
rescue PDFGeneratorAPI::ApiError => e
|
|
621
622
|
puts "Error when calling DocumentsApi->get_document_actions_with_http_info: #{e}"
|
|
622
623
|
end
|
|
@@ -630,6 +631,79 @@ end
|
|
|
630
631
|
|
|
631
632
|
### Return type
|
|
632
633
|
|
|
634
|
+
[**InlineObject18**](InlineObject18.md)
|
|
635
|
+
|
|
636
|
+
### Authorization
|
|
637
|
+
|
|
638
|
+
[JSONWebTokenAuth](../README.md#JSONWebTokenAuth)
|
|
639
|
+
|
|
640
|
+
### HTTP request headers
|
|
641
|
+
|
|
642
|
+
- **Content-Type**: Not defined
|
|
643
|
+
- **Accept**: application/json
|
|
644
|
+
|
|
645
|
+
|
|
646
|
+
## get_document_signatures
|
|
647
|
+
|
|
648
|
+
> <InlineObject17> get_document_signatures(public_id, opts)
|
|
649
|
+
|
|
650
|
+
Validate document signatures
|
|
651
|
+
|
|
652
|
+
Reports on every digital signature a stored document carries: who signed, when a timestamp authority attested it, whether the signed bytes are unchanged and whether the certificate chains to a trusted root. Facts are reported separately from the verdict, because a reader and a validation library can disagree in both directions. `status` reduces them to one answer, worst case first. Each request consumes one credit. A request that reports `unavailable` — signature validation not being enabled on the deployment — validates nothing and is not charged.
|
|
653
|
+
|
|
654
|
+
### Examples
|
|
655
|
+
|
|
656
|
+
```ruby
|
|
657
|
+
require 'time'
|
|
658
|
+
require 'pdf_generator_api_client'
|
|
659
|
+
# setup authorization
|
|
660
|
+
PDFGeneratorAPI.configure do |config|
|
|
661
|
+
# Configure Bearer authorization (JWT): JSONWebTokenAuth
|
|
662
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
663
|
+
end
|
|
664
|
+
|
|
665
|
+
api_instance = PDFGeneratorAPI::DocumentsApi.new
|
|
666
|
+
public_id = 'bac8381bce1982e5f6957a0f52371336' # String | Resource public id
|
|
667
|
+
opts = {
|
|
668
|
+
version: '5f3c2b1a9d8e7f6a' # String | Which stored version to report on. A version identifier reports on that version, `initial` on the document as first generated. Defaults to the latest version. A version is always reported on as itself: reporting the latest would describe bytes the caller is not holding.
|
|
669
|
+
}
|
|
670
|
+
|
|
671
|
+
begin
|
|
672
|
+
# Validate document signatures
|
|
673
|
+
result = api_instance.get_document_signatures(public_id, opts)
|
|
674
|
+
p result
|
|
675
|
+
rescue PDFGeneratorAPI::ApiError => e
|
|
676
|
+
puts "Error when calling DocumentsApi->get_document_signatures: #{e}"
|
|
677
|
+
end
|
|
678
|
+
```
|
|
679
|
+
|
|
680
|
+
#### Using the get_document_signatures_with_http_info variant
|
|
681
|
+
|
|
682
|
+
This returns an Array which contains the response data, status code and headers.
|
|
683
|
+
|
|
684
|
+
> <Array(<InlineObject17>, Integer, Hash)> get_document_signatures_with_http_info(public_id, opts)
|
|
685
|
+
|
|
686
|
+
```ruby
|
|
687
|
+
begin
|
|
688
|
+
# Validate document signatures
|
|
689
|
+
data, status_code, headers = api_instance.get_document_signatures_with_http_info(public_id, opts)
|
|
690
|
+
p status_code # => 2xx
|
|
691
|
+
p headers # => { ... }
|
|
692
|
+
p data # => <InlineObject17>
|
|
693
|
+
rescue PDFGeneratorAPI::ApiError => e
|
|
694
|
+
puts "Error when calling DocumentsApi->get_document_signatures_with_http_info: #{e}"
|
|
695
|
+
end
|
|
696
|
+
```
|
|
697
|
+
|
|
698
|
+
### Parameters
|
|
699
|
+
|
|
700
|
+
| Name | Type | Description | Notes |
|
|
701
|
+
| ---- | ---- | ----------- | ----- |
|
|
702
|
+
| **public_id** | **String** | Resource public id | |
|
|
703
|
+
| **version** | **String** | Which stored version to report on. A version identifier reports on that version, `initial` on the document as first generated. Defaults to the latest version. A version is always reported on as itself: reporting the latest would describe bytes the caller is not holding. | [optional] |
|
|
704
|
+
|
|
705
|
+
### Return type
|
|
706
|
+
|
|
633
707
|
[**InlineObject17**](InlineObject17.md)
|
|
634
708
|
|
|
635
709
|
### Authorization
|
data/docs/FormsApi.md
CHANGED
|
@@ -17,7 +17,7 @@ All URIs are relative to *https://us1.pdfgeneratorapi.com/api/v4*
|
|
|
17
17
|
|
|
18
18
|
## create_form
|
|
19
19
|
|
|
20
|
-
> <
|
|
20
|
+
> <InlineObject20> create_form(form_configuration_new)
|
|
21
21
|
|
|
22
22
|
Create form
|
|
23
23
|
|
|
@@ -50,7 +50,7 @@ end
|
|
|
50
50
|
|
|
51
51
|
This returns an Array which contains the response data, status code and headers.
|
|
52
52
|
|
|
53
|
-
> <Array(<
|
|
53
|
+
> <Array(<InlineObject20>, Integer, Hash)> create_form_with_http_info(form_configuration_new)
|
|
54
54
|
|
|
55
55
|
```ruby
|
|
56
56
|
begin
|
|
@@ -58,7 +58,7 @@ begin
|
|
|
58
58
|
data, status_code, headers = api_instance.create_form_with_http_info(form_configuration_new)
|
|
59
59
|
p status_code # => 2xx
|
|
60
60
|
p headers # => { ... }
|
|
61
|
-
p data # => <
|
|
61
|
+
p data # => <InlineObject20>
|
|
62
62
|
rescue PDFGeneratorAPI::ApiError => e
|
|
63
63
|
puts "Error when calling FormsApi->create_form_with_http_info: #{e}"
|
|
64
64
|
end
|
|
@@ -72,7 +72,7 @@ end
|
|
|
72
72
|
|
|
73
73
|
### Return type
|
|
74
74
|
|
|
75
|
-
[**
|
|
75
|
+
[**InlineObject20**](InlineObject20.md)
|
|
76
76
|
|
|
77
77
|
### Authorization
|
|
78
78
|
|
|
@@ -154,7 +154,7 @@ nil (empty response body)
|
|
|
154
154
|
|
|
155
155
|
## get_form
|
|
156
156
|
|
|
157
|
-
> <
|
|
157
|
+
> <InlineObject20> get_form(form_id)
|
|
158
158
|
|
|
159
159
|
Get form
|
|
160
160
|
|
|
@@ -187,7 +187,7 @@ end
|
|
|
187
187
|
|
|
188
188
|
This returns an Array which contains the response data, status code and headers.
|
|
189
189
|
|
|
190
|
-
> <Array(<
|
|
190
|
+
> <Array(<InlineObject20>, Integer, Hash)> get_form_with_http_info(form_id)
|
|
191
191
|
|
|
192
192
|
```ruby
|
|
193
193
|
begin
|
|
@@ -195,7 +195,7 @@ begin
|
|
|
195
195
|
data, status_code, headers = api_instance.get_form_with_http_info(form_id)
|
|
196
196
|
p status_code # => 2xx
|
|
197
197
|
p headers # => { ... }
|
|
198
|
-
p data # => <
|
|
198
|
+
p data # => <InlineObject20>
|
|
199
199
|
rescue PDFGeneratorAPI::ApiError => e
|
|
200
200
|
puts "Error when calling FormsApi->get_form_with_http_info: #{e}"
|
|
201
201
|
end
|
|
@@ -209,7 +209,7 @@ end
|
|
|
209
209
|
|
|
210
210
|
### Return type
|
|
211
211
|
|
|
212
|
-
[**
|
|
212
|
+
[**InlineObject20**](InlineObject20.md)
|
|
213
213
|
|
|
214
214
|
### Authorization
|
|
215
215
|
|
|
@@ -296,7 +296,7 @@ end
|
|
|
296
296
|
|
|
297
297
|
## import_form
|
|
298
298
|
|
|
299
|
-
> <
|
|
299
|
+
> <InlineObject20> import_form(import_form_request)
|
|
300
300
|
|
|
301
301
|
Import Form
|
|
302
302
|
|
|
@@ -329,7 +329,7 @@ end
|
|
|
329
329
|
|
|
330
330
|
This returns an Array which contains the response data, status code and headers.
|
|
331
331
|
|
|
332
|
-
> <Array(<
|
|
332
|
+
> <Array(<InlineObject20>, Integer, Hash)> import_form_with_http_info(import_form_request)
|
|
333
333
|
|
|
334
334
|
```ruby
|
|
335
335
|
begin
|
|
@@ -337,7 +337,7 @@ begin
|
|
|
337
337
|
data, status_code, headers = api_instance.import_form_with_http_info(import_form_request)
|
|
338
338
|
p status_code # => 2xx
|
|
339
339
|
p headers # => { ... }
|
|
340
|
-
p data # => <
|
|
340
|
+
p data # => <InlineObject20>
|
|
341
341
|
rescue PDFGeneratorAPI::ApiError => e
|
|
342
342
|
puts "Error when calling FormsApi->import_form_with_http_info: #{e}"
|
|
343
343
|
end
|
|
@@ -351,7 +351,7 @@ end
|
|
|
351
351
|
|
|
352
352
|
### Return type
|
|
353
353
|
|
|
354
|
-
[**
|
|
354
|
+
[**InlineObject20**](InlineObject20.md)
|
|
355
355
|
|
|
356
356
|
### Authorization
|
|
357
357
|
|
|
@@ -365,7 +365,7 @@ end
|
|
|
365
365
|
|
|
366
366
|
## open_form_builder
|
|
367
367
|
|
|
368
|
-
> <
|
|
368
|
+
> <InlineObject22> open_form_builder
|
|
369
369
|
|
|
370
370
|
Open new form builder
|
|
371
371
|
|
|
@@ -397,7 +397,7 @@ end
|
|
|
397
397
|
|
|
398
398
|
This returns an Array which contains the response data, status code and headers.
|
|
399
399
|
|
|
400
|
-
> <Array(<
|
|
400
|
+
> <Array(<InlineObject22>, Integer, Hash)> open_form_builder_with_http_info
|
|
401
401
|
|
|
402
402
|
```ruby
|
|
403
403
|
begin
|
|
@@ -405,7 +405,7 @@ begin
|
|
|
405
405
|
data, status_code, headers = api_instance.open_form_builder_with_http_info
|
|
406
406
|
p status_code # => 2xx
|
|
407
407
|
p headers # => { ... }
|
|
408
|
-
p data # => <
|
|
408
|
+
p data # => <InlineObject22>
|
|
409
409
|
rescue PDFGeneratorAPI::ApiError => e
|
|
410
410
|
puts "Error when calling FormsApi->open_form_builder_with_http_info: #{e}"
|
|
411
411
|
end
|
|
@@ -417,7 +417,7 @@ This endpoint does not need any parameter.
|
|
|
417
417
|
|
|
418
418
|
### Return type
|
|
419
419
|
|
|
420
|
-
[**
|
|
420
|
+
[**InlineObject22**](InlineObject22.md)
|
|
421
421
|
|
|
422
422
|
### Authorization
|
|
423
423
|
|
|
@@ -431,7 +431,7 @@ This endpoint does not need any parameter.
|
|
|
431
431
|
|
|
432
432
|
## open_form_builder_for_existing_form
|
|
433
433
|
|
|
434
|
-
> <
|
|
434
|
+
> <InlineObject22> open_form_builder_for_existing_form(form_id)
|
|
435
435
|
|
|
436
436
|
Open existing form builder
|
|
437
437
|
|
|
@@ -464,7 +464,7 @@ end
|
|
|
464
464
|
|
|
465
465
|
This returns an Array which contains the response data, status code and headers.
|
|
466
466
|
|
|
467
|
-
> <Array(<
|
|
467
|
+
> <Array(<InlineObject22>, Integer, Hash)> open_form_builder_for_existing_form_with_http_info(form_id)
|
|
468
468
|
|
|
469
469
|
```ruby
|
|
470
470
|
begin
|
|
@@ -472,7 +472,7 @@ begin
|
|
|
472
472
|
data, status_code, headers = api_instance.open_form_builder_for_existing_form_with_http_info(form_id)
|
|
473
473
|
p status_code # => 2xx
|
|
474
474
|
p headers # => { ... }
|
|
475
|
-
p data # => <
|
|
475
|
+
p data # => <InlineObject22>
|
|
476
476
|
rescue PDFGeneratorAPI::ApiError => e
|
|
477
477
|
puts "Error when calling FormsApi->open_form_builder_for_existing_form_with_http_info: #{e}"
|
|
478
478
|
end
|
|
@@ -486,7 +486,7 @@ end
|
|
|
486
486
|
|
|
487
487
|
### Return type
|
|
488
488
|
|
|
489
|
-
[**
|
|
489
|
+
[**InlineObject22**](InlineObject22.md)
|
|
490
490
|
|
|
491
491
|
### Authorization
|
|
492
492
|
|
|
@@ -500,7 +500,7 @@ end
|
|
|
500
500
|
|
|
501
501
|
## share_form
|
|
502
502
|
|
|
503
|
-
> <
|
|
503
|
+
> <InlineObject21> share_form(form_id)
|
|
504
504
|
|
|
505
505
|
Share form
|
|
506
506
|
|
|
@@ -533,7 +533,7 @@ end
|
|
|
533
533
|
|
|
534
534
|
This returns an Array which contains the response data, status code and headers.
|
|
535
535
|
|
|
536
|
-
> <Array(<
|
|
536
|
+
> <Array(<InlineObject21>, Integer, Hash)> share_form_with_http_info(form_id)
|
|
537
537
|
|
|
538
538
|
```ruby
|
|
539
539
|
begin
|
|
@@ -541,7 +541,7 @@ begin
|
|
|
541
541
|
data, status_code, headers = api_instance.share_form_with_http_info(form_id)
|
|
542
542
|
p status_code # => 2xx
|
|
543
543
|
p headers # => { ... }
|
|
544
|
-
p data # => <
|
|
544
|
+
p data # => <InlineObject21>
|
|
545
545
|
rescue PDFGeneratorAPI::ApiError => e
|
|
546
546
|
puts "Error when calling FormsApi->share_form_with_http_info: #{e}"
|
|
547
547
|
end
|
|
@@ -555,7 +555,7 @@ end
|
|
|
555
555
|
|
|
556
556
|
### Return type
|
|
557
557
|
|
|
558
|
-
[**
|
|
558
|
+
[**InlineObject21**](InlineObject21.md)
|
|
559
559
|
|
|
560
560
|
### Authorization
|
|
561
561
|
|
|
@@ -569,7 +569,7 @@ end
|
|
|
569
569
|
|
|
570
570
|
## update_form
|
|
571
571
|
|
|
572
|
-
> <
|
|
572
|
+
> <InlineObject20> update_form(form_id, form_configuration_new)
|
|
573
573
|
|
|
574
574
|
Update form
|
|
575
575
|
|
|
@@ -603,7 +603,7 @@ end
|
|
|
603
603
|
|
|
604
604
|
This returns an Array which contains the response data, status code and headers.
|
|
605
605
|
|
|
606
|
-
> <Array(<
|
|
606
|
+
> <Array(<InlineObject20>, Integer, Hash)> update_form_with_http_info(form_id, form_configuration_new)
|
|
607
607
|
|
|
608
608
|
```ruby
|
|
609
609
|
begin
|
|
@@ -611,7 +611,7 @@ begin
|
|
|
611
611
|
data, status_code, headers = api_instance.update_form_with_http_info(form_id, form_configuration_new)
|
|
612
612
|
p status_code # => 2xx
|
|
613
613
|
p headers # => { ... }
|
|
614
|
-
p data # => <
|
|
614
|
+
p data # => <InlineObject20>
|
|
615
615
|
rescue PDFGeneratorAPI::ApiError => e
|
|
616
616
|
puts "Error when calling FormsApi->update_form_with_http_info: #{e}"
|
|
617
617
|
end
|
|
@@ -626,7 +626,7 @@ end
|
|
|
626
626
|
|
|
627
627
|
### Return type
|
|
628
628
|
|
|
629
|
-
[**
|
|
629
|
+
[**InlineObject20**](InlineObject20.md)
|
|
630
630
|
|
|
631
631
|
### Authorization
|
|
632
632
|
|
data/docs/InlineObject17.md
CHANGED
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
|
|
5
5
|
| Name | Type | Description | Notes |
|
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
|
7
|
-
| **response** | [**
|
|
7
|
+
| **response** | [**DocumentSignatures**](DocumentSignatures.md) | | [optional] |
|
|
8
8
|
|
|
9
9
|
## Example
|
|
10
10
|
|
data/docs/InlineObject18.md
CHANGED
|
@@ -4,8 +4,7 @@
|
|
|
4
4
|
|
|
5
5
|
| Name | Type | Description | Notes |
|
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
|
7
|
-
| **response** | [**
|
|
8
|
-
| **meta** | **Object** | | [optional] |
|
|
7
|
+
| **response** | [**Array<DocumentAction>**](DocumentAction.md) | | [optional] |
|
|
9
8
|
|
|
10
9
|
## Example
|
|
11
10
|
|
|
@@ -13,8 +12,7 @@
|
|
|
13
12
|
require 'pdf_generator_api_client'
|
|
14
13
|
|
|
15
14
|
instance = PDFGeneratorAPI::InlineObject18.new(
|
|
16
|
-
response: null
|
|
17
|
-
meta: null
|
|
15
|
+
response: null
|
|
18
16
|
)
|
|
19
17
|
```
|
|
20
18
|
|
data/docs/InlineObject19.md
CHANGED
|
@@ -4,7 +4,8 @@
|
|
|
4
4
|
|
|
5
5
|
| Name | Type | Description | Notes |
|
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
|
7
|
-
| **response** | [**
|
|
7
|
+
| **response** | [**TemplateDefinition**](TemplateDefinition.md) | | [optional] |
|
|
8
|
+
| **meta** | **Object** | | [optional] |
|
|
8
9
|
|
|
9
10
|
## Example
|
|
10
11
|
|
|
@@ -12,7 +13,8 @@
|
|
|
12
13
|
require 'pdf_generator_api_client'
|
|
13
14
|
|
|
14
15
|
instance = PDFGeneratorAPI::InlineObject19.new(
|
|
15
|
-
response: null
|
|
16
|
+
response: null,
|
|
17
|
+
meta: null
|
|
16
18
|
)
|
|
17
19
|
```
|
|
18
20
|
|
data/docs/InlineObject20.md
CHANGED
|
@@ -4,8 +4,7 @@
|
|
|
4
4
|
|
|
5
5
|
| Name | Type | Description | Notes |
|
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
|
7
|
-
| **response** | **
|
|
8
|
-
| **meta** | [**InlineObject20Meta**](InlineObject20Meta.md) | | [optional] |
|
|
7
|
+
| **response** | [**FormConfiguration**](FormConfiguration.md) | | [optional] |
|
|
9
8
|
|
|
10
9
|
## Example
|
|
11
10
|
|
|
@@ -13,8 +12,7 @@
|
|
|
13
12
|
require 'pdf_generator_api_client'
|
|
14
13
|
|
|
15
14
|
instance = PDFGeneratorAPI::InlineObject20.new(
|
|
16
|
-
response:
|
|
17
|
-
meta: null
|
|
15
|
+
response: null
|
|
18
16
|
)
|
|
19
17
|
```
|
|
20
18
|
|
data/docs/InlineObject21.md
CHANGED
|
@@ -4,7 +4,8 @@
|
|
|
4
4
|
|
|
5
5
|
| Name | Type | Description | Notes |
|
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
|
7
|
-
| **response** | **String** | URL
|
|
7
|
+
| **response** | **String** | Public URL for form data collection | [optional] |
|
|
8
|
+
| **meta** | [**InlineObject21Meta**](InlineObject21Meta.md) | | [optional] |
|
|
8
9
|
|
|
9
10
|
## Example
|
|
10
11
|
|
|
@@ -12,7 +13,8 @@
|
|
|
12
13
|
require 'pdf_generator_api_client'
|
|
13
14
|
|
|
14
15
|
instance = PDFGeneratorAPI::InlineObject21.new(
|
|
15
|
-
response: https://app.pdfgeneratorapi.com/forms/
|
|
16
|
+
response: https://app.pdfgeneratorapi.com/forms/097475c4-dcd5-42ca-814f-b9fa3da66b5a/share,
|
|
17
|
+
meta: null
|
|
16
18
|
)
|
|
17
19
|
```
|
|
18
20
|
|