README.md in form_api-0.2.0 vs README.md in form_api-1.0.0
- old
+ new
@@ -1,16 +1,16 @@
# form_api
FormAPI - the Ruby gem for the API V1
-No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
+No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
-This SDK is automatically generated by the [Swagger Codegen](https://github.com/swagger-api/swagger-codegen) project:
+This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
- API version: v1
-- Package version: 0.2.0
-- Build package: io.swagger.codegen.languages.RubyClientCodegen
+- Package version: 1.0.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-0.2.0.gem
+gem install ./form_api-1.0.0.gem
```
-(for development, run `gem install --dev ./form_api-0.2.0.gem` to install the development dependencies)
+(for development, run `gem install --dev ./form_api-1.0.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', '~> 0.2.0'
+ gem 'form_api', '~> 1.0.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:
@@ -60,57 +60,59 @@
config.username = 'YOUR USERNAME'
config.password = 'YOUR PASSWORD'
end
api_instance = FormAPI::PDFApi.new
+template_id = 'tpl_000000000000000001' # String |
+create_submission_data = nil # Array<CreateSubmissionData> |
-template_id = "template_id_example" # String |
-
-opts = {
- create_submission_batch_body: [FormAPI::CreateSubmissionBatchBody.new] # Array<CreateSubmissionBatchBody> |
-}
-
begin
#Generates multiple PDFs
- result = api_instance.batch_generate_pdf(template_id, opts)
+ result = api_instance.batch_generate_pdf_v1(template_id, create_submission_data)
p result
rescue FormAPI::ApiError => e
- puts "Exception when calling PDFApi->batch_generate_pdf: #{e}"
+ puts "Exception when calling PDFApi->batch_generate_pdf_v1: #{e}"
end
```
## Documentation for API Endpoints
All URIs are relative to *https://app.formapi.io/api/v1*
Class | Method | HTTP request | Description
------------ | ------------- | ------------- | -------------
-*FormAPI::PDFApi* | [**batch_generate_pdf**](docs/PDFApi.md#batch_generate_pdf) | **POST** /templates/{template_id}/submissions/batch | Generates multiple PDFs
+*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* | [**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_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_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
## Documentation for Models
- - [FormAPI::CreateCombinedSubmissionBody](docs/CreateCombinedSubmissionBody.md)
- - [FormAPI::CreateSubmissionBatchBody](docs/CreateSubmissionBatchBody.md)
- - [FormAPI::CreateSubmissionBody](docs/CreateSubmissionBody.md)
- - [FormAPI::InlineResponse200](docs/InlineResponse200.md)
- - [FormAPI::InlineResponse2001](docs/InlineResponse2001.md)
- - [FormAPI::InlineResponse201](docs/InlineResponse201.md)
- - [FormAPI::InlineResponse2011](docs/InlineResponse2011.md)
- - [FormAPI::InlineResponse201CombinedSubmission](docs/InlineResponse201CombinedSubmission.md)
- - [FormAPI::InlineResponse400](docs/InlineResponse400.md)
- - [FormAPI::InlineResponse401](docs/InlineResponse401.md)
- - [FormAPI::InlineResponse422](docs/InlineResponse422.md)
- - [FormAPI::TemplatestemplateIdsubmissionsbatchSubmission](docs/TemplatestemplateIdsubmissionsbatchSubmission.md)
+ - [FormAPI::AuthenticationError](docs/AuthenticationError.md)
+ - [FormAPI::AuthenticationSuccessResponse](docs/AuthenticationSuccessResponse.md)
+ - [FormAPI::CombinedSubmission](docs/CombinedSubmission.md)
+ - [FormAPI::CombinedSubmissionData](docs/CombinedSubmissionData.md)
+ - [FormAPI::CreateCombinedSubmissionResponse](docs/CreateCombinedSubmissionResponse.md)
+ - [FormAPI::CreateSubmissionBatchResponse](docs/CreateSubmissionBatchResponse.md)
+ - [FormAPI::CreateSubmissionData](docs/CreateSubmissionData.md)
+ - [FormAPI::CreateSubmissionDataBatchRequest](docs/CreateSubmissionDataBatchRequest.md)
+ - [FormAPI::CreateSubmissionResponse](docs/CreateSubmissionResponse.md)
+ - [FormAPI::CreateSubmissionResponse1](docs/CreateSubmissionResponse1.md)
+ - [FormAPI::Error](docs/Error.md)
+ - [FormAPI::InvalidRequest](docs/InvalidRequest.md)
+ - [FormAPI::Submission](docs/Submission.md)
+ - [FormAPI::SubmissionBatch](docs/SubmissionBatch.md)
+ - [FormAPI::SubmissionBatchData](docs/SubmissionBatchData.md)
+ - [FormAPI::Template](docs/Template.md)
## Documentation for Authorization