README.md in form_api-1.3.0 vs README.md in form_api-1.4.0
- old
+ new
@@ -1,15 +1,15 @@
# form_api
-FormAPI - the Ruby gem for the API V1
+FormAPI - the Ruby gem for the API v1
-No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+FormAPI is a service that helps you fill out and sign PDF templates.
This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
- API version: v1
-- Package version: 1.3.0
+- Package version: 1.4.0
- Build package: io.formapi.codegen.FormApiRubyClientCodegen
## Installation
### Build a gem
@@ -21,19 +21,19 @@
```
Then either install the gem locally:
```shell
-gem install ./form_api-1.3.0.gem
+gem install ./form_api-1.4.0.gem
```
-(for development, run `gem install --dev ./form_api-1.3.0.gem` to install the development dependencies)
+(for development, run `gem install --dev ./form_api-1.4.0.gem` to install the development dependencies)
or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
Finally add this to the Gemfile:
- gem 'form_api', '~> 1.3.0'
+ gem 'form_api', '~> 1.4.0'
### Install from Git
If 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:
@@ -83,17 +83,20 @@
------------ | ------------- | ------------- | -------------
*FormAPI::PDFApi* | [**batch_generate_pdf_v1**](docs/PDFApi.md#batch_generate_pdf_v1) | **POST** /templates/{template_id}/submissions/batch | Generates multiple PDFs
*FormAPI::PDFApi* | [**batch_generate_pdfs**](docs/PDFApi.md#batch_generate_pdfs) | **POST** /submissions/batches | Generates multiple PDFs
*FormAPI::PDFApi* | [**combine_submissions**](docs/PDFApi.md#combine_submissions) | **POST** /combined_submissions | Merge generated PDFs together
*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
+*FormAPI::PDFApi* | [**create_template**](docs/PDFApi.md#create_template) | **POST** /templates | Upload a new PDF template
*FormAPI::PDFApi* | [**expire_combined_submission**](docs/PDFApi.md#expire_combined_submission) | **DELETE** /combined_submissions/{combined_submission_id} | Expire a combined submission
*FormAPI::PDFApi* | [**expire_submission**](docs/PDFApi.md#expire_submission) | **DELETE** /submissions/{submission_id} | Expire a PDF submission
*FormAPI::PDFApi* | [**generate_pdf**](docs/PDFApi.md#generate_pdf) | **POST** /templates/{template_id}/submissions | Generates a new PDF
*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)
*FormAPI::PDFApi* | [**get_data_request**](docs/PDFApi.md#get_data_request) | **GET** /data_requests/{data_request_id} | Look up a submission data request
*FormAPI::PDFApi* | [**get_submission**](docs/PDFApi.md#get_submission) | **GET** /submissions/{submission_id} | Check the status of a PDF
*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
+*FormAPI::PDFApi* | [**get_template**](docs/PDFApi.md#get_template) | **GET** /templates/{template_id} | Check the status of an uploaded template
+*FormAPI::PDFApi* | [**get_template_schema**](docs/PDFApi.md#get_template_schema) | **GET** /templates/{template_id}/schema | Fetch the JSON schema for a template
*FormAPI::PDFApi* | [**get_templates**](docs/PDFApi.md#get_templates) | **GET** /templates | Get a list of all templates
*FormAPI::PDFApi* | [**test_authentication**](docs/PDFApi.md#test_authentication) | **GET** /authentication | Test Authentication
*FormAPI::PDFApi* | [**update_data_request**](docs/PDFApi.md#update_data_request) | **PUT** /data_requests/{data_request_id} | Update a submission data request
@@ -118,9 +121,10 @@
- [FormAPI::Submission](docs/Submission.md)
- [FormAPI::SubmissionBatch](docs/SubmissionBatch.md)
- [FormAPI::SubmissionBatchData](docs/SubmissionBatchData.md)
- [FormAPI::SubmissionDataRequest](docs/SubmissionDataRequest.md)
- [FormAPI::Template](docs/Template.md)
+ - [FormAPI::Template1](docs/Template1.md)
- [FormAPI::UpdateDataRequestResponse](docs/UpdateDataRequestResponse.md)
- [FormAPI::UpdateSubmissionDataRequestData](docs/UpdateSubmissionDataRequestData.md)
## Documentation for Authorization