{"id":19383888,"url":"https://github.com/docspring/formapi-ruby","last_synced_at":"2025-02-24T17:18:22.317Z","repository":{"id":48771094,"uuid":"105559427","full_name":"DocSpring/formapi-ruby","owner":"DocSpring","description":" Ruby API Client for FormAPI","archived":false,"fork":false,"pushed_at":"2021-07-12T20:58:42.000Z","size":163,"stargazers_count":1,"open_issues_count":3,"forks_count":0,"subscribers_count":3,"default_branch":"master","last_synced_at":"2025-01-28T13:35:30.709Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"https://rubygems.org/gems/form_api","language":"Ruby","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/DocSpring.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2017-10-02T16:47:33.000Z","updated_at":"2019-11-08T18:16:50.000Z","dependencies_parsed_at":"2022-08-30T20:20:52.926Z","dependency_job_id":null,"html_url":"https://github.com/DocSpring/formapi-ruby","commit_stats":null,"previous_names":["formapi/formapi-ruby"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/DocSpring%2Fformapi-ruby","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/DocSpring%2Fformapi-ruby/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/DocSpring%2Fformapi-ruby/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/DocSpring%2Fformapi-ruby/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/DocSpring","download_url":"https://codeload.github.com/DocSpring/formapi-ruby/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":240521037,"owners_count":19814694,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-11-10T09:28:16.841Z","updated_at":"2025-02-24T17:18:22.296Z","avatar_url":"https://github.com/DocSpring.png","language":"Ruby","funding_links":[],"categories":[],"sub_categories":[],"readme":"# form_api\n\nFormAPI - the Ruby gem for the API v1\n\nFormAPI is a service that helps you fill out and sign PDF templates.\n\nThis SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:\n\n- API version: v1\n- Package version: 1.12.0\n- Build package: io.formapi.codegen.FormApiRubyClientCodegen\n\n## Installation\n\n### Build a gem\n\nTo build the Ruby code into a gem:\n\n```shell\ngem build form_api.gemspec\n```\n\nThen either install the gem locally:\n\n```shell\ngem install ./form_api-1.12.0.gem\n```\n(for development, run `gem install --dev ./form_api-1.12.0.gem` to install the development dependencies)\n\nor publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).\n\nFinally add this to the Gemfile:\n\n    gem 'form_api', '~\u003e 1.12.0'\n\n### Install from Git\n\nIf the Ruby gem is hosted at a git repository: https://github.com/GIT_USER_ID/GIT_REPO_ID, then add the following in the Gemfile:\n\n    gem 'form_api', :git =\u003e 'https://github.com/GIT_USER_ID/GIT_REPO_ID.git'\n\n### Include the Ruby code directly\n\nInclude the Ruby code directly using `-I` as follows:\n\n```shell\nruby -Ilib script.rb\n```\n\n## Getting Started\n\nPlease follow the [installation](#installation) procedure and then run the following code:\n```ruby\n# Load the gem\nrequire 'form_api'\n\n# Setup authorization\nFormAPI.configure do |config|\n  # Configure HTTP basic authorization: api_token_basic\n  config.username = 'YOUR USERNAME'\n  config.password = 'YOUR PASSWORD'\nend\n\napi_instance = FormAPI::PDFApi.new\ntemplate_id = 'tpl_000000000000000001' # String | \nrequest_body = nil # Array\u003cObject\u003e | \n\nbegin\n  #Generates multiple PDFs\n  result = api_instance.batch_generate_pdf_v1(template_id, request_body)\n  p result\nrescue FormAPI::ApiError =\u003e e\n  puts \"Exception when calling PDFApi-\u003ebatch_generate_pdf_v1: #{e}\"\nend\n\n```\n\n## Documentation for API Endpoints\n\nAll URIs are relative to *https://api.formapi.io/api/v1*\n\nClass | Method | HTTP request | Description\n------------ | ------------- | ------------- | -------------\n*FormAPI::PDFApi* | [**batch_generate_pdf_v1**](docs/PDFApi.md#batch_generate_pdf_v1) | **POST** /templates/{template_id}/submissions/batch | Generates multiple PDFs\n*FormAPI::PDFApi* | [**batch_generate_pdfs**](docs/PDFApi.md#batch_generate_pdfs) | **POST** /submissions/batches | Generates multiple PDFs\n*FormAPI::PDFApi* | [**combine_pdfs**](docs/PDFApi.md#combine_pdfs) | **POST** /combined_submissions?v\u0026#x3D;2 | Merge submission PDFs, template PDFs, or custom files\n*FormAPI::PDFApi* | [**combine_submissions**](docs/PDFApi.md#combine_submissions) | **POST** /combined_submissions | Merge generated PDFs together\n*FormAPI::PDFApi* | [**create_custom_file_from_upload**](docs/PDFApi.md#create_custom_file_from_upload) | **POST** /custom_files | Create a new custom file from a cached presign upload\n*FormAPI::PDFApi* | [**create_data_request_token**](docs/PDFApi.md#create_data_request_token) | **POST** /data_requests/{data_request_id}/tokens | Creates a new data request token for form authentication\n*FormAPI::PDFApi* | [**create_folder**](docs/PDFApi.md#create_folder) | **POST** /folders/ | Create a folder\n*FormAPI::PDFApi* | [**create_template**](docs/PDFApi.md#create_template) | **POST** /templates | Upload a new PDF template with a file upload\n*FormAPI::PDFApi* | [**create_template_from_upload**](docs/PDFApi.md#create_template_from_upload) | **POST** /templates?v\u0026#x3D;2 | Create a new PDF template from a cached presign upload\n*FormAPI::PDFApi* | [**delete_folder**](docs/PDFApi.md#delete_folder) | **DELETE** /folders/{folder_id} | Delete a folder\n*FormAPI::PDFApi* | [**expire_combined_submission**](docs/PDFApi.md#expire_combined_submission) | **DELETE** /combined_submissions/{combined_submission_id} | Expire a combined submission\n*FormAPI::PDFApi* | [**expire_submission**](docs/PDFApi.md#expire_submission) | **DELETE** /submissions/{submission_id} | Expire a PDF submission\n*FormAPI::PDFApi* | [**generate_pdf**](docs/PDFApi.md#generate_pdf) | **POST** /templates/{template_id}/submissions | Generates a new PDF\n*FormAPI::PDFApi* | [**get_combined_submission**](docs/PDFApi.md#get_combined_submission) | **GET** /combined_submissions/{combined_submission_id} | Check the status of a combined submission (merged PDFs)\n*FormAPI::PDFApi* | [**get_data_request**](docs/PDFApi.md#get_data_request) | **GET** /data_requests/{data_request_id} | Look up a submission data request\n*FormAPI::PDFApi* | [**get_presign_url**](docs/PDFApi.md#get_presign_url) | **GET** /uploads/presign | Get a presigned URL so that you can upload a file to our AWS S3 bucket\n*FormAPI::PDFApi* | [**get_submission**](docs/PDFApi.md#get_submission) | **GET** /submissions/{submission_id} | Check the status of a PDF\n*FormAPI::PDFApi* | [**get_submission_batch**](docs/PDFApi.md#get_submission_batch) | **GET** /submissions/batches/{submission_batch_id} | Check the status of a submission batch job\n*FormAPI::PDFApi* | [**get_template**](docs/PDFApi.md#get_template) | **GET** /templates/{template_id} | Get a single template\n*FormAPI::PDFApi* | [**get_template_schema**](docs/PDFApi.md#get_template_schema) | **GET** /templates/{template_id}/schema | Fetch the JSON schema for a template\n*FormAPI::PDFApi* | [**list_folders**](docs/PDFApi.md#list_folders) | **GET** /folders/ | Get a list of all folders\n*FormAPI::PDFApi* | [**list_templates**](docs/PDFApi.md#list_templates) | **GET** /templates | Get a list of all templates\n*FormAPI::PDFApi* | [**move_folder_to_folder**](docs/PDFApi.md#move_folder_to_folder) | **POST** /folders/{folder_id}/move | Move a folder\n*FormAPI::PDFApi* | [**move_template_to_folder**](docs/PDFApi.md#move_template_to_folder) | **POST** /templates/{template_id}/move | Move Template to folder\n*FormAPI::PDFApi* | [**rename_folder**](docs/PDFApi.md#rename_folder) | **POST** /folders/{folder_id}/rename | Rename a folder\n*FormAPI::PDFApi* | [**test_authentication**](docs/PDFApi.md#test_authentication) | **GET** /authentication | Test Authentication\n*FormAPI::PDFApi* | [**update_data_request**](docs/PDFApi.md#update_data_request) | **PUT** /data_requests/{data_request_id} | Update a submission data request\n\n\n## Documentation for Models\n\n - [FormAPI::AuthenticationError](docs/AuthenticationError.md)\n - [FormAPI::AuthenticationSuccessResponse](docs/AuthenticationSuccessResponse.md)\n - [FormAPI::CombinePdfsData](docs/CombinePdfsData.md)\n - [FormAPI::CombinedSubmission](docs/CombinedSubmission.md)\n - [FormAPI::CombinedSubmissionAction](docs/CombinedSubmissionAction.md)\n - [FormAPI::CombinedSubmissionData](docs/CombinedSubmissionData.md)\n - [FormAPI::CreateCombinedSubmissionResponse](docs/CreateCombinedSubmissionResponse.md)\n - [FormAPI::CreateCustomFileData](docs/CreateCustomFileData.md)\n - [FormAPI::CreateCustomFileResponse](docs/CreateCustomFileResponse.md)\n - [FormAPI::CreateFolderData](docs/CreateFolderData.md)\n - [FormAPI::CreateSubmissionBatchResponse](docs/CreateSubmissionBatchResponse.md)\n - [FormAPI::CreateSubmissionBatchSubmissionsResponse](docs/CreateSubmissionBatchSubmissionsResponse.md)\n - [FormAPI::CreateSubmissionDataRequestData](docs/CreateSubmissionDataRequestData.md)\n - [FormAPI::CreateSubmissionDataRequestTokenResponse](docs/CreateSubmissionDataRequestTokenResponse.md)\n - [FormAPI::CreateSubmissionDataRequestTokenResponseToken](docs/CreateSubmissionDataRequestTokenResponseToken.md)\n - [FormAPI::CreateSubmissionResponse](docs/CreateSubmissionResponse.md)\n - [FormAPI::CreateTemplateData](docs/CreateTemplateData.md)\n - [FormAPI::CustomFile](docs/CustomFile.md)\n - [FormAPI::Error](docs/Error.md)\n - [FormAPI::Folder](docs/Folder.md)\n - [FormAPI::FoldersFolder](docs/FoldersFolder.md)\n - [FormAPI::InvalidRequest](docs/InvalidRequest.md)\n - [FormAPI::MoveFolderData](docs/MoveFolderData.md)\n - [FormAPI::MoveTemplateData](docs/MoveTemplateData.md)\n - [FormAPI::PendingTemplate](docs/PendingTemplate.md)\n - [FormAPI::RenameFolderData](docs/RenameFolderData.md)\n - [FormAPI::Submission](docs/Submission.md)\n - [FormAPI::SubmissionAction](docs/SubmissionAction.md)\n - [FormAPI::SubmissionBatch](docs/SubmissionBatch.md)\n - [FormAPI::SubmissionBatchData](docs/SubmissionBatchData.md)\n - [FormAPI::SubmissionData](docs/SubmissionData.md)\n - [FormAPI::SubmissionDataBatchRequest](docs/SubmissionDataBatchRequest.md)\n - [FormAPI::SubmissionDataRequest](docs/SubmissionDataRequest.md)\n - [FormAPI::Template](docs/Template.md)\n - [FormAPI::Templatesv2Template](docs/Templatesv2Template.md)\n - [FormAPI::Templatesv2TemplateDocument](docs/Templatesv2TemplateDocument.md)\n - [FormAPI::Templatesv2TemplateDocumentMetadata](docs/Templatesv2TemplateDocumentMetadata.md)\n - [FormAPI::UpdateDataRequestResponse](docs/UpdateDataRequestResponse.md)\n - [FormAPI::UpdateSubmissionDataRequestData](docs/UpdateSubmissionDataRequestData.md)\n\n\n## Documentation for Authorization\n\n\n### api_token_basic\n\n- **Type**: HTTP basic authentication\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdocspring%2Fformapi-ruby","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fdocspring%2Fformapi-ruby","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdocspring%2Fformapi-ruby/lists"}