form_api 0.2.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7b00921152a148d757ec6772ee4da728448e8c3b
-  data.tar.gz: fedf600a57f3cfda8daf9616ddcfade8779902f8
+  metadata.gz: 252b2f73a7400095897e1d4b38fea5c3d3e5f41f
+  data.tar.gz: 88a374bd364facffeef0294e7ab6c3fe7db11d1c
 SHA512:
-  metadata.gz: 304fb110f255378abfd32295b2002d968fe3b1a26d789936c5faf33d8250a0cb911c344af7fe6ffe392491aa6f44d50b978f9a06ea7a2e2d9de7143619944232
-  data.tar.gz: 832fc6b95b6bab276a13ba6ecc52acf7eda99c334a32b0405e9fe76feed22806a334a4070a3b9b4506855164fee829d33fbb4424efa87af23ba27a2484e0161a
+  metadata.gz: bbd3204cacb14c5844e37f5838efe9eda1251680e0efd6d1ab5d850debdbd7114614222f0b2b9ddd75a1523cb3ec6d0404a9b51d695e82b3eca4470e839e821e
+  data.tar.gz: 3e17afcc2bc6ddbd06b9d3191c5f11aad1e76946108d3d65d84c3cff4fc49a8afc37359bcf8fb32c0425997d12921f9a62ec03cb4515fb4f228c802e988f1a99

data/.gitignore

@@ -1,4 +1,4 @@
-# Generated by: https://github.com/swagger-api/swagger-codegen.git
+# Generated by: https://openapi-generator.tech
 #
 
 *.gem

data/{.swagger-codegen-ignore → .openapi-generator-ignore}

@@ -1,11 +1,11 @@
-# Swagger Codegen Ignore
-# Generated by swagger-codegen https://github.com/swagger-api/swagger-codegen
+# OpenAPI Generator Ignore
+# Generated by openapi-generator https://github.com/openapitools/openapi-generator
 
 # Use this file to prevent files from being overwritten by the generator.
 # The patterns follow closely to .gitignore or .dockerignore.
 
 # As an example, the C# client generator defines ApiClient.cs.
-# You can make changes and tell Swagger Codgen to ignore just this file by uncommenting the following line:
+# You can make changes and tell OpenAPI Generator to ignore just this file by uncommenting the following line:
 #ApiClient.cs
 
 # You can match any string of characters against a directory, file or extension with a single asterisk (*):

data/.openapi-generator/VERSION

@@ -0,0 +1 @@
+3.3.0-SNAPSHOT

data/.rubocop.yml

@@ -0,0 +1,154 @@
+# This file is based on https://github.com/rails/rails/blob/master/.rubocop.yml (MIT license)
+# Automatically generated by OpenAPI Generator (https://openapi-generator.tech)
+AllCops:
+  TargetRubyVersion: 2.2
+  # RuboCop has a bunch of cops enabled by default. This setting tells RuboCop
+  # to ignore them, so only the ones explicitly set in this file are enabled.
+  DisabledByDefault: true
+  Exclude:
+    - '**/templates/**/*'
+    - '**/vendor/**/*'
+    - 'actionpack/lib/action_dispatch/journey/parser.rb'
+
+# Prefer &&/|| over and/or.
+Style/AndOr:
+  Enabled: true
+
+# Do not use braces for hash literals when they are the last argument of a
+# method call.
+Style/BracesAroundHashParameters:
+  Enabled: true
+  EnforcedStyle: context_dependent
+
+# Align `when` with `case`.
+Layout/CaseIndentation:
+  Enabled: true
+
+# Align comments with method definitions.
+Layout/CommentIndentation:
+  Enabled: true
+
+Layout/ElseAlignment:
+  Enabled: true
+
+Layout/EmptyLineAfterMagicComment:
+  Enabled: true
+
+# In a regular class definition, no empty lines around the body.
+Layout/EmptyLinesAroundClassBody:
+  Enabled: true
+
+# In a regular method definition, no empty lines around the body.
+Layout/EmptyLinesAroundMethodBody:
+  Enabled: true
+
+# In a regular module definition, no empty lines around the body.
+Layout/EmptyLinesAroundModuleBody:
+  Enabled: true
+
+Layout/FirstParameterIndentation:
+  Enabled: true
+
+# Use Ruby >= 1.9 syntax for hashes. Prefer { a: :b } over { :a => :b }.
+Style/HashSyntax:
+  Enabled: false
+
+# Method definitions after `private` or `protected` isolated calls need one
+# extra level of indentation.
+Layout/IndentationConsistency:
+  Enabled: true
+  EnforcedStyle: rails
+
+# Two spaces, no tabs (for indentation).
+Layout/IndentationWidth:
+  Enabled: true
+
+Layout/LeadingCommentSpace:
+  Enabled: true
+
+Layout/SpaceAfterColon:
+  Enabled: true
+
+Layout/SpaceAfterComma:
+  Enabled: true
+
+Layout/SpaceAroundEqualsInParameterDefault:
+  Enabled: true
+
+Layout/SpaceAroundKeyword:
+  Enabled: true
+
+Layout/SpaceAroundOperators:
+  Enabled: true
+
+Layout/SpaceBeforeComma:
+    Enabled: true
+
+Layout/SpaceBeforeFirstArg:
+    Enabled: true
+
+Style/DefWithParentheses:
+  Enabled: true
+
+# Defining a method with parameters needs parentheses.
+Style/MethodDefParentheses:
+  Enabled: true
+
+Style/FrozenStringLiteralComment:
+  Enabled: false
+  EnforcedStyle: always
+
+# Use `foo {}` not `foo{}`.
+Layout/SpaceBeforeBlockBraces:
+  Enabled: true
+
+# Use `foo { bar }` not `foo {bar}`.
+Layout/SpaceInsideBlockBraces:
+  Enabled: true
+
+# Use `{ a: 1 }` not `{a:1}`.
+Layout/SpaceInsideHashLiteralBraces:
+  Enabled: true
+
+Layout/SpaceInsideParens:
+  Enabled: true
+
+# Check quotes usage according to lint rule below.
+#Style/StringLiterals:
+#  Enabled: true
+#  EnforcedStyle: single_quotes
+
+# Detect hard tabs, no hard tabs.
+Layout/Tab:
+  Enabled: true
+
+# Blank lines should not have any spaces.
+Layout/TrailingBlankLines:
+  Enabled: true
+
+# No trailing whitespace.
+Layout/TrailingWhitespace:
+  Enabled: false
+
+# Use quotes for string literals when they are enough.
+Style/UnneededPercentQ:
+  Enabled: true
+
+# Align `end` with the matching keyword or starting expression except for
+# assignments, where it should be aligned with the LHS.
+Layout/EndAlignment:
+  Enabled: true
+  EnforcedStyleAlignWith: variable
+  AutoCorrect: true
+
+# Use my_method(my_arg) not my_method( my_arg ) or my_method my_arg.
+Lint/RequireParentheses:
+  Enabled: true
+
+Style/RedundantReturn:
+  Enabled: true
+  AllowMultipleReturnValues: true
+
+Style/Semicolon:
+  Enabled: true
+  AllowAsExpressionSeparator: true

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    form_api (0.2.0)
+    form_api (1.0.0)
       json (~> 2.1, >= 2.1.0)
       typhoeus (~> 1.0, >= 1.0.1)
 
@@ -24,7 +24,7 @@ GEM
     diff-lcs (1.3)
     ethon (0.11.0)
       ffi (>= 1.3.0)
-    ffi (1.9.23)
+    ffi (1.9.25)
     hashdiff (0.3.7)
     json (2.1.0)
     method_source (0.9.0)
@@ -34,21 +34,21 @@ GEM
     pry-byebug (3.6.0)
       byebug (~> 10.0)
       pry (~> 0.10)
-    public_suffix (3.0.2)
+    public_suffix (3.0.3)
     rake (12.0.0)
-    rspec (3.7.0)
-      rspec-core (~> 3.7.0)
-      rspec-expectations (~> 3.7.0)
-      rspec-mocks (~> 3.7.0)
-    rspec-core (3.7.1)
-      rspec-support (~> 3.7.0)
-    rspec-expectations (3.7.0)
+    rspec (3.8.0)
+      rspec-core (~> 3.8.0)
+      rspec-expectations (~> 3.8.0)
+      rspec-mocks (~> 3.8.0)
+    rspec-core (3.8.0)
+      rspec-support (~> 3.8.0)
+    rspec-expectations (3.8.1)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.7.0)
-    rspec-mocks (3.7.0)
+      rspec-support (~> 3.8.0)
+    rspec-mocks (3.8.0)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.7.0)
-    rspec-support (3.7.1)
+      rspec-support (~> 3.8.0)
+    rspec-support (3.8.0)
     safe_yaml (1.0.4)
     sys-uname (1.0.3)
       ffi (>= 1.0.0)
@@ -69,7 +69,6 @@ DEPENDENCIES
   autotest-growl (~> 0.2, >= 0.2.16)
   autotest-rails-pure (~> 4.1, >= 4.1.2)
   form_api!
-  pry (~> 0.10, >= 0.10.4)
   pry-byebug
   rake (~> 12.0.0)
   rspec (~> 3.6, >= 3.6.0)
@@ -77,4 +76,4 @@ DEPENDENCIES
   webmock (~> 1.24, >= 1.24.3)
 
 BUNDLED WITH
-   1.16.2
+   1.16.1

data/README.md

@@ -2,13 +2,13 @@
 
 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
 
@@ -23,15 +23,15 @@ gem build form_api.gemspec
 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
 
@@ -62,19 +62,15 @@ FormAPI.configure do |config|
 end
 
 api_instance = FormAPI::PDFApi.new
-
-template_id = "template_id_example" # String |
-
-opts = {
-  create_submission_batch_body: [FormAPI::CreateSubmissionBatchBody.new] # Array<CreateSubmissionBatchBody> |
-}
+template_id = 'tpl_000000000000000001' # String | 
+create_submission_data = nil # Array<CreateSubmissionData> | 
 
 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
 
 ```
@@ -85,31 +81,37 @@ 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

data/Rakefile

@@ -1,3 +1,5 @@
+require "bundler/gem_tasks"
+
 begin
   require 'rspec/core/rake_task'
 

data/docs/{InlineResponse422.md → AuthenticationError.md}

@@ -1,9 +1,9 @@
-# FormAPI::InlineResponse422
+# FormAPI::AuthenticationError
 
 ## Properties
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**status** | **String** |  |
-**errors** | **Array<String>** |  |
+**status** | **String** |  | [optional] 
+**error** | **String** |  | 
 
 

data/docs/{InlineResponse401.md → AuthenticationSuccessResponse.md}

@@ -1,8 +1,8 @@
-# FormAPI::InlineResponse401
+# FormAPI::AuthenticationSuccessResponse
 
 ## Properties
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**error** | **String** |  |
+**status** | **String** |  | [optional] 
 
 

data/docs/CombinedSubmission.md

@@ -0,0 +1,14 @@
+# FormAPI::CombinedSubmission
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**metadata** | **Object** |  | [optional] 
+**expired** | **BOOLEAN** |  | [optional] 
+**expires_at** | **String** |  | [optional] 
+**download_url** | **String** |  | [optional] 
+**submission_ids** | **Array<String>** |  | [optional] 
+**id** | **String** |  | [optional] 
+**state** | **String** |  | [optional] 
+
+

data/docs/CombinedSubmissionData.md

@@ -0,0 +1,11 @@
+# FormAPI::CombinedSubmissionData
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**test** | **BOOLEAN** |  | [optional] 
+**submission_ids** | **Array<String>** |  | 
+**metadata** | **Object** |  | [optional] 
+**expires_in** | **Float** |  | [optional] 
+
+

data/docs/CreateCombinedSubmissionResponse.md

@@ -0,0 +1,10 @@
+# FormAPI::CreateCombinedSubmissionResponse
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**combined_submission** | [**CombinedSubmission**](CombinedSubmission.md) |  | [optional] 
+**errors** | **Array<String>** |  | [optional] 
+**status** | **String** |  | [optional] 
+
+

data/docs/CreateSubmissionBatchResponse.md

@@ -0,0 +1,12 @@
+# FormAPI::CreateSubmissionBatchResponse
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**submission_batch** | [**SubmissionBatch**](SubmissionBatch.md) |  | [optional] 
+**submissions** | [**Array<CreateSubmissionResponse1>**](CreateSubmissionResponse1.md) |  | [optional] 
+**error** | **String** |  | [optional] 
+**errors** | **Array<String>** |  | [optional] 
+**status** | **String** |  | [optional] 
+
+