form_api 0.1.5 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: '00169a4fbb7ab1b2beb13f813f396f46dcc2b085'
-  data.tar.gz: a13b337783a72f2e63485661d340d18ead404619
+  metadata.gz: 7b00921152a148d757ec6772ee4da728448e8c3b
+  data.tar.gz: fedf600a57f3cfda8daf9616ddcfade8779902f8
 SHA512:
-  metadata.gz: b59bb93e0c541f0149d58f3fb5d9b6184337a8cbffecfb5ed993aaab97d94fff4228859cd1db49af3adb3592193ed45798d720d90d47c23a2d83c94469cea393
-  data.tar.gz: 60076f7208a1398837a4a417c9abe6764b3c2a2d41c473647f9c213d4de6efd87c0b8b7e1789d08bf4ab08ad71ea45c158410afe6b23c506cd814cd72bab65b4
+  metadata.gz: 304fb110f255378abfd32295b2002d968fe3b1a26d789936c5faf33d8250a0cb911c344af7fe6ffe392491aa6f44d50b978f9a06ea7a2e2d9de7143619944232
+  data.tar.gz: 832fc6b95b6bab276a13ba6ecc52acf7eda99c334a32b0405e9fe76feed22806a334a4070a3b9b4506855164fee829d33fbb4424efa87af23ba27a2484e0161a

data/.gitignore

@@ -1,3 +1,6 @@
+# Generated by: https://github.com/swagger-api/swagger-codegen.git
+#
+
 *.gem
 *.rbc
 /.config
@@ -9,7 +12,11 @@
 /test/tmp/
 /test/version_tmp/
 /tmp/
-.byebug_history
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
 
 ## Documentation cache and generated files:
 /.yardoc/
@@ -21,17 +28,12 @@
 /.bundle/
 /vendor/bundle
 /lib/bundler/man/
-Gemfile.lock
-.ruby-version
-.ruby-gemset
-.rvmrc
 
-## Emacs files
-*~
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+# Gemfile.lock
+# .ruby-version
+# .ruby-gemset
 
-## OSX files
-.DS_Store
-Thumbs.db
-
-## Ignore baked in swagger generator
-swagger-codegen
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc

data/.swagger-codegen-ignore

@@ -21,11 +21,3 @@
 #docs/*.md
 # Then explicitly reverse the ignore rule for a single file:
 #!docs/README.md
-
-README.md
-CHANGELOG.md
-git_push.sh
-docs/
-.gitignore
-LICENSE
-Rakefile

data/Gemfile

@@ -4,4 +4,5 @@ gemspec
 
 group :development, :test do
   gem 'rake', '~> 12.0.0'
+  gem 'pry-byebug'
 end

data/Gemfile.lock

@@ -0,0 +1,80 @@
+PATH
+  remote: .
+  specs:
+    form_api (0.2.0)
+      json (~> 2.1, >= 2.1.0)
+      typhoeus (~> 1.0, >= 1.0.1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ZenTest (4.11.1)
+    addressable (2.5.2)
+      public_suffix (>= 2.0.2, < 4.0)
+    autotest (4.4.6)
+      ZenTest (>= 4.4.1)
+    autotest-fsevent (0.2.13)
+      sys-uname
+    autotest-growl (0.2.16)
+    autotest-rails-pure (4.1.2)
+    byebug (10.0.2)
+    coderay (1.1.2)
+    crack (0.4.3)
+      safe_yaml (~> 1.0.0)
+    diff-lcs (1.3)
+    ethon (0.11.0)
+      ffi (>= 1.3.0)
+    ffi (1.9.23)
+    hashdiff (0.3.7)
+    json (2.1.0)
+    method_source (0.9.0)
+    pry (0.11.3)
+      coderay (~> 1.1.0)
+      method_source (~> 0.9.0)
+    pry-byebug (3.6.0)
+      byebug (~> 10.0)
+      pry (~> 0.10)
+    public_suffix (3.0.2)
+    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)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-mocks (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-support (3.7.1)
+    safe_yaml (1.0.4)
+    sys-uname (1.0.3)
+      ffi (>= 1.0.0)
+    typhoeus (1.3.0)
+      ethon (>= 0.9.0)
+    vcr (3.0.3)
+    webmock (1.24.6)
+      addressable (>= 2.3.6)
+      crack (>= 0.3.2)
+      hashdiff
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  autotest (~> 4.4, >= 4.4.6)
+  autotest-fsevent (~> 0.2, >= 0.2.12)
+  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)
+  vcr (~> 3.0, >= 3.0.1)
+  webmock (~> 1.24, >= 1.24.3)
+
+BUNDLED WITH
+   1.16.2

data/README.md

@@ -1,105 +1,121 @@
-# FormAPI Ruby Client
+# form_api
 
-[![Build Status](https://travis-ci.org/FormAPI/formapi-ruby.svg?branch=master)](https://travis-ci.org/FormAPI/formapi-ruby)
+FormAPI - the Ruby gem for the API V1
 
-The `form_api` gem is an API client library for [FormAPI](https://formapi.io).
-You can use FormAPI to generate PDFs. Configure your PDF template in our online editor,
-then post data to fill out the PDF.
+No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
 
-## Supported Ruby Versions
+This SDK is automatically generated by the [Swagger Codegen](https://github.com/swagger-api/swagger-codegen) project:
 
-The `form_api` gem supports Ruby >= `1.9.3`. We run our tests with the following Ruby versions:
-
-* `1.9.3`
-* `2.1.10`
-* `2.4.2`
+- API version: v1
+- Package version: 0.2.0
+- Build package: io.swagger.codegen.languages.RubyClientCodegen
 
 ## Installation
 
-```bash
-gem install form_api
-```
+### Build a gem
 
-Or add the following to your `Gemfile`.
+To build the Ruby code into a gem:
 
-```ruby
-gem "form_api"
+```shell
+gem build form_api.gemspec
 ```
 
-Then run:
+Then either install the gem locally:
 
-```bash
-bundle install
+```shell
+gem install ./form_api-0.2.0.gem
 ```
+(for development, run `gem install --dev ./form_api-0.2.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'
 
-## Usage
+### Install from Git
 
-See [examples](examples/) for some runnable examples.
+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:
 
+    gem 'form_api', :git => 'https://github.com/GIT_USER_ID/GIT_REPO_ID.git'
+
+### Include the Ruby code directly
+
+Include the Ruby code directly using `-I` as follows:
+
+```shell
+ruby -Ilib script.rb
+```
+
+## Getting Started
+
+Please follow the [installation](#installation) procedure and then run the following code:
 ```ruby
+# Load the gem
+require 'form_api'
+
+# Setup authorization
 FormAPI.configure do |config|
-  config.username = "YOUR_API_TOKEN_ID"
-  config.password = "YOUR_API_TOKEN_SECRET"
+  # Configure HTTP basic authorization: api_token_basic
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
 end
 
-formapi = FormAPI::Client.new
-
-response = formapi.generate_pdf(
-  template_id: 'YOUR_TEMPLATE_ID',   # ID of a template that you have configured
-  test: true,                        # Test documents are free but watermarked
-  wait: true,                        # Wait for the PDF to be processed   (default: true)
-  data: {                            # Data to render in the template
-    name: "foo",
-    number: 42
-  },
-  metadata: {                        # Custom data to include in the request, for your own purposes
-    user_id: 123
-  }
-)
-
-# {
-#   status: "success",
-#   submission: {
-#     id: "bymRSZYTKDnd6jfY",
-#     test: true,
-#     state: "processed",
-#     download_url: "https://..."
-#   }
-# }
-```
+api_instance = FormAPI::PDFApi.new
 
-This submits a PDF request and waits for the job to finish.
+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)
+  p result
+rescue FormAPI::ApiError => e
+  puts "Exception when calling PDFApi->batch_generate_pdf: #{e}"
+end
+
+```
 
-## More Help
+## Documentation for API Endpoints
 
-See the [FormAPI documentation](https://formapi.io/docs) for more information.
+All URIs are relative to *https://app.formapi.io/api/v1*
 
-Please [email us](mailto:support@formapi.io) if you need any help.
+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* | [**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_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
 
 
-## Development
+## Documentation for Models
 
-The majority of the code in this repo is generated using swagger-codegen.
-You can modify this file and regenerate the client using `scripts/generate`.
+ - [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)
 
 
-## Release Process
+## Documentation for Authorization
 
-1. Pull latest master
-2. Merge feature branch(es) into master
-3. `script/test`
-4. Increment version in code:
-  - `swagger-config.json`
-  - `lib/formapi/version.rb`
-5. Update [CHANGELOG.md](CHANGELOG.md)
-6. Commit "Release version vX.Y.Z"
-7. `rake release`
-8. Verify package release at https://rubygems.org/gems/formapi
-9. Refresh documentation on formapi.io
 
+### api_token_basic
 
-## Version Policy
+- **Type**: HTTP basic authentication
 
-This library follows [Semantic Versioning 2.0.0](http://semver.org).

data/Rakefile

@@ -1,6 +1,3 @@
-require 'bundler/setup'
-require 'bundler/gem_tasks'
-
 begin
   require 'rspec/core/rake_task'
 

data/docs/CreateCombinedSubmissionBody.md

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

data/docs/CreateSubmissionBatchBody.md

@@ -0,0 +1,10 @@
+# FormAPI::CreateSubmissionBatchBody
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**test** | **BOOLEAN** |  | [optional]
+**data** | **Object** |  |
+**metadata** | **Object** |  | [optional]
+
+

data/docs/CreateSubmissionBody.md

@@ -0,0 +1,10 @@
+# FormAPI::CreateSubmissionBody
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**test** | **BOOLEAN** |  | [optional]
+**data** | **Object** |  |
+**metadata** | **Object** |  | [optional]
+
+

data/docs/InlineResponse200.md

@@ -0,0 +1,8 @@
+# FormAPI::InlineResponse200
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**status** | **String** |  |
+
+

data/docs/InlineResponse2001.md

@@ -0,0 +1,21 @@
+# FormAPI::InlineResponse2001
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **String** |  |
+**name** | **String** |  |
+**template_type** | **String** |  |
+**public_web_form** | **BOOLEAN** |  |
+**public_submissions** | **BOOLEAN** |  |
+**expire_submissions** | **BOOLEAN** |  |
+**expire_after** | **Float** |  | [optional]
+**expiration_interval** | **String** |  | [optional]
+**allow_additional_properties** | **BOOLEAN** |  |
+**page_dimensions** | **Array<Array<Float>>** |  |
+**webhook_url** | **String** |  |
+**slack_webhook_url** | **String** |  |
+**redirect_url** | **String** |  |
+**blockchain_timestamp_verification** | **BOOLEAN** |  |
+
+

data/docs/InlineResponse201.md

@@ -0,0 +1,9 @@
+# FormAPI::InlineResponse201
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**status** | **String** |  |
+**combined_submission** | [**InlineResponse201CombinedSubmission**](InlineResponse201CombinedSubmission.md) |  | [optional]
+
+

data/docs/InlineResponse2011.md

@@ -0,0 +1,9 @@
+# FormAPI::InlineResponse2011
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**status** | **String** |  |
+**submission** | [**TemplatestemplateIdsubmissionsbatchSubmission**](TemplatestemplateIdsubmissionsbatchSubmission.md) |  | [optional]
+
+

data/docs/InlineResponse201CombinedSubmission.md

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

data/docs/InlineResponse400.md

@@ -0,0 +1,9 @@
+# FormAPI::InlineResponse400
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**status** | **String** |  |
+**error** | **String** |  |
+
+

data/docs/InlineResponse401.md

@@ -0,0 +1,8 @@
+# FormAPI::InlineResponse401
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**error** | **String** |  |
+
+

data/docs/InlineResponse422.md

@@ -0,0 +1,9 @@
+# FormAPI::InlineResponse422
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**status** | **String** |  |
+**errors** | **Array<String>** |  |
+
+