form_api 0.1.5 → 0.2.0

data/docs/PDFApi.md

@@ -0,0 +1,482 @@
+# FormAPI::PDFApi
+
+All URIs are relative to *https://app.formapi.io/api/v1*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**batch_generate_pdf**](PDFApi.md#batch_generate_pdf) | **POST** /templates/{template_id}/submissions/batch | Generates multiple PDFs
+[**combine_submissions**](PDFApi.md#combine_submissions) | **POST** /combined_submissions | Merge generated PDFs together
+[**expire_combined_submission**](PDFApi.md#expire_combined_submission) | **DELETE** /combined_submissions/{combined_submission_id} | Expire a combined submission
+[**expire_submission**](PDFApi.md#expire_submission) | **DELETE** /submissions/{submission_id} | Expire a PDF submission
+[**generate_pdf**](PDFApi.md#generate_pdf) | **POST** /templates/{template_id}/submissions | Generates a new PDF
+[**get_combined_submission**](PDFApi.md#get_combined_submission) | **GET** /combined_submissions/{combined_submission_id} | Check the status of a combined submission (merged PDFs)
+[**get_submission**](PDFApi.md#get_submission) | **GET** /submissions/{submission_id} | Check the status of a PDF
+[**get_templates**](PDFApi.md#get_templates) | **GET** /templates | Get a list of all templates
+[**test_authentication**](PDFApi.md#test_authentication) | **GET** /authentication | Test Authentication
+
+
+# **batch_generate_pdf**
+> Array<InlineResponse2011> batch_generate_pdf(template_id, opts)
+
+Generates multiple PDFs
+
+### Example
+```ruby
+# load the gem
+require 'form_api'
+# setup authorization
+FormAPI.configure do |config|
+  # Configure HTTP basic authorization: api_token_basic
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = FormAPI::PDFApi.new
+
+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
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **template_id** | **String**|  |
+ **create_submission_batch_body** | [**Array&lt;CreateSubmissionBatchBody&gt;**](CreateSubmissionBatchBody.md)|  | [optional]
+
+### Return type
+
+[**Array&lt;InlineResponse2011&gt;**](InlineResponse2011.md)
+
+### Authorization
+
+[api_token_basic](../README.md#api_token_basic)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **combine_submissions**
+> InlineResponse201 combine_submissions(opts)
+
+Merge generated PDFs together
+
+### Example
+```ruby
+# load the gem
+require 'form_api'
+# setup authorization
+FormAPI.configure do |config|
+  # Configure HTTP basic authorization: api_token_basic
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = FormAPI::PDFApi.new
+
+opts = {
+  create_combined_submission_body: FormAPI::CreateCombinedSubmissionBody.new # CreateCombinedSubmissionBody |
+}
+
+begin
+  #Merge generated PDFs together
+  result = api_instance.combine_submissions(opts)
+  p result
+rescue FormAPI::ApiError => e
+  puts "Exception when calling PDFApi->combine_submissions: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **create_combined_submission_body** | [**CreateCombinedSubmissionBody**](CreateCombinedSubmissionBody.md)|  | [optional]
+
+### Return type
+
+[**InlineResponse201**](InlineResponse201.md)
+
+### Authorization
+
+[api_token_basic](../README.md#api_token_basic)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **expire_combined_submission**
+> InlineResponse201CombinedSubmission expire_combined_submission(combined_submission_id)
+
+Expire a combined submission
+
+### Example
+```ruby
+# load the gem
+require 'form_api'
+# setup authorization
+FormAPI.configure do |config|
+  # Configure HTTP basic authorization: api_token_basic
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = FormAPI::PDFApi.new
+
+combined_submission_id = "combined_submission_id_example" # String |
+
+
+begin
+  #Expire a combined submission
+  result = api_instance.expire_combined_submission(combined_submission_id)
+  p result
+rescue FormAPI::ApiError => e
+  puts "Exception when calling PDFApi->expire_combined_submission: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **combined_submission_id** | **String**|  |
+
+### Return type
+
+[**InlineResponse201CombinedSubmission**](InlineResponse201CombinedSubmission.md)
+
+### Authorization
+
+[api_token_basic](../README.md#api_token_basic)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+
+# **expire_submission**
+> TemplatestemplateIdsubmissionsbatchSubmission expire_submission(submission_id)
+
+Expire a PDF submission
+
+### Example
+```ruby
+# load the gem
+require 'form_api'
+# setup authorization
+FormAPI.configure do |config|
+  # Configure HTTP basic authorization: api_token_basic
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = FormAPI::PDFApi.new
+
+submission_id = "submission_id_example" # String |
+
+
+begin
+  #Expire a PDF submission
+  result = api_instance.expire_submission(submission_id)
+  p result
+rescue FormAPI::ApiError => e
+  puts "Exception when calling PDFApi->expire_submission: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **submission_id** | **String**|  |
+
+### Return type
+
+[**TemplatestemplateIdsubmissionsbatchSubmission**](TemplatestemplateIdsubmissionsbatchSubmission.md)
+
+### Authorization
+
+[api_token_basic](../README.md#api_token_basic)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+
+# **generate_pdf**
+> InlineResponse2011 generate_pdf(template_id, opts)
+
+Generates a new PDF
+
+### Example
+```ruby
+# load the gem
+require 'form_api'
+# setup authorization
+FormAPI.configure do |config|
+  # Configure HTTP basic authorization: api_token_basic
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = FormAPI::PDFApi.new
+
+template_id = "template_id_example" # String |
+
+opts = {
+  create_submission_body: FormAPI::CreateSubmissionBody.new # CreateSubmissionBody |
+}
+
+begin
+  #Generates a new PDF
+  result = api_instance.generate_pdf(template_id, opts)
+  p result
+rescue FormAPI::ApiError => e
+  puts "Exception when calling PDFApi->generate_pdf: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **template_id** | **String**|  |
+ **create_submission_body** | [**CreateSubmissionBody**](CreateSubmissionBody.md)|  | [optional]
+
+### Return type
+
+[**InlineResponse2011**](InlineResponse2011.md)
+
+### Authorization
+
+[api_token_basic](../README.md#api_token_basic)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **get_combined_submission**
+> InlineResponse201CombinedSubmission get_combined_submission(combined_submission_id)
+
+Check the status of a combined submission (merged PDFs)
+
+### Example
+```ruby
+# load the gem
+require 'form_api'
+# setup authorization
+FormAPI.configure do |config|
+  # Configure HTTP basic authorization: api_token_basic
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = FormAPI::PDFApi.new
+
+combined_submission_id = "combined_submission_id_example" # String |
+
+
+begin
+  #Check the status of a combined submission (merged PDFs)
+  result = api_instance.get_combined_submission(combined_submission_id)
+  p result
+rescue FormAPI::ApiError => e
+  puts "Exception when calling PDFApi->get_combined_submission: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **combined_submission_id** | **String**|  |
+
+### Return type
+
+[**InlineResponse201CombinedSubmission**](InlineResponse201CombinedSubmission.md)
+
+### Authorization
+
+[api_token_basic](../README.md#api_token_basic)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+
+# **get_submission**
+> TemplatestemplateIdsubmissionsbatchSubmission get_submission(submission_id)
+
+Check the status of a PDF
+
+### Example
+```ruby
+# load the gem
+require 'form_api'
+# setup authorization
+FormAPI.configure do |config|
+  # Configure HTTP basic authorization: api_token_basic
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = FormAPI::PDFApi.new
+
+submission_id = "submission_id_example" # String |
+
+
+begin
+  #Check the status of a PDF
+  result = api_instance.get_submission(submission_id)
+  p result
+rescue FormAPI::ApiError => e
+  puts "Exception when calling PDFApi->get_submission: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **submission_id** | **String**|  |
+
+### Return type
+
+[**TemplatestemplateIdsubmissionsbatchSubmission**](TemplatestemplateIdsubmissionsbatchSubmission.md)
+
+### Authorization
+
+[api_token_basic](../README.md#api_token_basic)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+
+# **get_templates**
+> Array&lt;InlineResponse2001&gt; get_templates(opts)
+
+Get a list of all templates
+
+### Example
+```ruby
+# load the gem
+require 'form_api'
+# setup authorization
+FormAPI.configure do |config|
+  # Configure HTTP basic authorization: api_token_basic
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = FormAPI::PDFApi.new
+
+opts = {
+  page: 56, # Integer | Default: 1
+  per_page: 56 # Integer | Default: 50
+}
+
+begin
+  #Get a list of all templates
+  result = api_instance.get_templates(opts)
+  p result
+rescue FormAPI::ApiError => e
+  puts "Exception when calling PDFApi->get_templates: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **page** | **Integer**| Default: 1 | [optional]
+ **per_page** | **Integer**| Default: 50 | [optional]
+
+### Return type
+
+[**Array&lt;InlineResponse2001&gt;**](InlineResponse2001.md)
+
+### Authorization
+
+[api_token_basic](../README.md#api_token_basic)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+
+# **test_authentication**
+> InlineResponse200 test_authentication
+
+Test Authentication
+
+### Example
+```ruby
+# load the gem
+require 'form_api'
+# setup authorization
+FormAPI.configure do |config|
+  # Configure HTTP basic authorization: api_token_basic
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = FormAPI::PDFApi.new
+
+begin
+  #Test Authentication
+  result = api_instance.test_authentication
+  p result
+rescue FormAPI::ApiError => e
+  puts "Exception when calling PDFApi->test_authentication: #{e}"
+end
+```
+
+### Parameters
+This endpoint does not need any parameter.
+
+### Return type
+
+[**InlineResponse200**](InlineResponse200.md)
+
+### Authorization
+
+[api_token_basic](../README.md#api_token_basic)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+

data/docs/TemplatestemplateIdsubmissionsbatchSubmission.md

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

data/form_api.gemspec

@@ -22,8 +22,8 @@ Gem::Specification.new do |s|
   s.authors     = ["Form Applications Inc."]
   s.email       = ["support@formapi.io"]
   s.homepage    = "https://github.com/FormAPI/formapi-ruby"
-  s.summary     = "A client library for the FormAPI PDF generation service"
-  s.description = "A client library for the FormAPI PDF generation service"
+  s.summary     = "FormAPI API Client"
+  s.description = "Client library for the FormAPI PDF generation service"
   s.license     = "MIT"
   s.required_ruby_version = ">= 1.9"
 
@@ -33,8 +33,6 @@ Gem::Specification.new do |s|
   s.add_development_dependency 'rspec', '~> 3.6', '>= 3.6.0'
   s.add_development_dependency 'vcr', '~> 3.0', '>= 3.0.1'
   s.add_development_dependency 'webmock', '~> 1.24', '>= 1.24.3'
-  # This version of addressable is required for Ruby 1.9.3 support
-  s.add_development_dependency 'addressable', '~> 2.4.0'
   s.add_development_dependency 'autotest', '~> 4.4', '>= 4.4.6'
   s.add_development_dependency 'autotest-rails-pure', '~> 4.1', '>= 4.1.2'
   s.add_development_dependency 'autotest-growl', '~> 0.2', '>= 0.2.16'
@@ -42,12 +40,7 @@ Gem::Specification.new do |s|
 
   # added by script/fix_gemspec.rb.
   s.add_development_dependency 'rake', '~>11.2', '>= 11.2.2'
-  if RUBY_VERSION >= '2.2.0'
-    s.add_development_dependency 'pry-byebug'
-  else
-    s.add_development_dependency 'pry', '~>0.10', '>= 0.10.4'
-  end
-
+  s.add_development_dependency 'pry', '~>0.10', '>= 0.10.4'
   # </added> : if the above lines are missing in the gemspec, then
   # the matcher for autotest is probably broken
 

data/git_push.sh

@@ -0,0 +1,55 @@
+#!/bin/sh
+#
+# Generated by: https://github.com/swagger-api/swagger-codegen.git
+#
+# ref: https://help.github.com/articles/adding-an-existing-project-to-github-using-the-command-line/
+#
+# Usage example: /bin/sh ./git_push.sh wing328 swagger-petstore-perl "minor update"
+
+git_user_id=$1
+git_repo_id=$2
+release_note=$3
+
+if [ "$git_user_id" = "" ]; then
+    git_user_id="GIT_USER_ID"
+    echo "[INFO] No command line input provided. Set \$git_user_id to $git_user_id"
+fi
+
+if [ "$git_repo_id" = "" ]; then
+    git_repo_id="GIT_REPO_ID"
+    echo "[INFO] No command line input provided. Set \$git_repo_id to $git_repo_id"
+fi
+
+if [ "$release_note" = "" ]; then
+    release_note="Minor update"
+    echo "[INFO] No command line input provided. Set \$release_note to $release_note"
+fi
+
+# Initialize the local directory as a Git repository
+git init
+
+# Adds the files in the local repository and stages them for commit.
+git add .
+
+# Commits the tracked changes and prepares them to be pushed to a remote repository.
+git commit -m "$release_note"
+
+# Sets the new remote
+git_remote=`git remote`
+if [ "$git_remote" = "" ]; then # git remote not defined
+
+    if [ "$GIT_TOKEN" = "" ]; then
+        echo "[INFO] \$GIT_TOKEN (environment variable) is not set. Using the git crediential in your environment."
+        git remote add origin https://github.com/${git_user_id}/${git_repo_id}.git
+    else
+        git remote add origin https://${git_user_id}:${GIT_TOKEN}@github.com/${git_user_id}/${git_repo_id}.git
+    fi
+
+fi
+
+git pull origin master
+
+# Pushes (Forces) the changes in the local repository up to the remote repository
+echo "Git pushing to https://github.com/${git_user_id}/${git_repo_id}.git"
+git push origin master 2>&1 | grep -v 'To https'
+

data/{extensions/lib → lib}/form_api/api/client.rb

@@ -21,9 +21,9 @@ module FormAPI
       end
 
       # FormAPI requires a nested :data object.
-      opts[:data] = { data: opts.delete(:data) }
+      opts[:'create_submission_body'] = { data: opts.delete(:data) }
       if opts[:metadata]
-        opts[:data][:metadata] = opts.delete(:metadata)
+        opts[:'create_submission_body'][:metadata] = opts.delete(:metadata)
       end
 
       template_id = opts.delete :template_id