form_api 1.3.0 → 1.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: af755c2ce95f2c89f1b61a8c7f20b450f2d00c11
-  data.tar.gz: a0cda83d2f444986fe463e58e55e9431503a4073
+SHA256:
+  metadata.gz: 6dd09b3224514218c63ed4c1752f8d815c6532b65c0189e04e67a923e51a003b
+  data.tar.gz: 73e413951e1122745546ba9532f467be904461f2b05cbc0881ea626899540c9f
 SHA512:
-  metadata.gz: b7ca49414dfcb85f294ebb0075eec300bd7b8f4eb61c91f8de8850892edfb2f9b26c8ba3fdd34c3ed2c561a97d559df9856c1211f4cbed38b25fb6398ba093b9
-  data.tar.gz: c5839a4716ab0f937d012443b33c7353e98bfa1ac404dc874f751e26b8babbf989147ddab4681d6f5916577df6195fb65a71dac7cd766b128f8124c92a55e56c
+  metadata.gz: b3eb0272496eccf34f371532c6865364982a5e929a403457baa601e334b5d76892de124f9c5ccd60e15f7f14ced8bc4c197e53909a7406b11fac330843497972
+  data.tar.gz: 59fed76f6536c9e371a96d733923e27bc6d2e9660e8cc22682e95529e05ca9bedf63545aa5ac8086e86543bd02c3e235c93cf867cbe3bd49193fe3f9f36b8c64

data/.swagger-codegen-ignore

@@ -0,0 +1,31 @@
+# Swagger Codegen Ignore
+# Generated by swagger-codegen https://github.com/swagger-api/swagger-codegen
+
+# 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:
+#ApiClient.cs
+
+# You can match any string of characters against a directory, file or extension with a single asterisk (*):
+#foo/*/qux
+# The above matches foo/bar/qux and foo/baz/qux, but not foo/bar/baz/qux
+
+# You can recursively match patterns against a directory, file or extension with a double asterisk (**):
+#foo/**/qux
+# This matches foo/bar/qux, foo/baz/qux, and foo/bar/baz/qux
+
+# You can also negate patterns with an exclamation (!).
+# For example, you can ignore all files in a docs folder with the file extension .md:
+#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/.swagger-codegen/VERSION

@@ -0,0 +1 @@
+2.3.0-SNAPSHOT

data/.swagger-revision

@@ -0,0 +1 @@
+28a5b74dbf313529a2fc697d46e9ed870cfd6a30

data/.travis.yml

@@ -0,0 +1,8 @@
+language: ruby
+rvm:
+ - 2.4.2
+ - 2.1.10
+ - 1.9.3
+
+before_install:
+  - gem update bundler

data/Gemfile.lock

@@ -1,7 +1,8 @@
 PATH
   remote: .
   specs:
-    form_api (1.0.0)
+    form_api (1.4.0)
+      ffi (~> 1.0, >= 1.9.24)
       json (~> 2.1, >= 2.1.0)
       typhoeus (~> 1.0, >= 1.0.1)
 
@@ -76,4 +77,4 @@ DEPENDENCIES
   webmock (~> 1.24, >= 1.24.3)
 
 BUNDLED WITH
-   1.16.2
+   1.17.1

data/LICENSE

@@ -0,0 +1,7 @@
+Copyright © 2018 Form Applications Inc.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -1,13 +1,13 @@
 # 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
@@ -23,15 +23,15 @@ gem build form_api.gemspec
 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
 
@@ -85,6 +85,7 @@ Class | Method | HTTP request | Description
 *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
@@ -92,6 +93,8 @@ Class | Method | HTTP request | Description
 *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
@@ -120,6 +123,7 @@ Class | Method | HTTP request | Description
  - [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)
 

data/docs/PDFApi.md

@@ -8,6 +8,7 @@ Method | HTTP request | Description
 [**batch_generate_pdfs**](PDFApi.md#batch_generate_pdfs) | **POST** /submissions/batches | Generates multiple PDFs
 [**combine_submissions**](PDFApi.md#combine_submissions) | **POST** /combined_submissions | Merge generated PDFs together
 [**create_data_request_token**](PDFApi.md#create_data_request_token) | **POST** /data_requests/{data_request_id}/tokens | Creates a new data request token for form authentication
+[**create_template**](PDFApi.md#create_template) | **POST** /templates | Upload a new PDF template
 [**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
@@ -15,6 +16,8 @@ Method | HTTP request | Description
 [**get_data_request**](PDFApi.md#get_data_request) | **GET** /data_requests/{data_request_id} | Look up a submission data request
 [**get_submission**](PDFApi.md#get_submission) | **GET** /submissions/{submission_id} | Check the status of a PDF
 [**get_submission_batch**](PDFApi.md#get_submission_batch) | **GET** /submissions/batches/{submission_batch_id} | Check the status of a submission batch job
+[**get_template**](PDFApi.md#get_template) | **GET** /templates/{template_id} | Check the status of an uploaded template
+[**get_template_schema**](PDFApi.md#get_template_schema) | **GET** /templates/{template_id}/schema | Fetch the JSON schema for a template
 [**get_templates**](PDFApi.md#get_templates) | **GET** /templates | Get a list of all templates
 [**test_authentication**](PDFApi.md#test_authentication) | **GET** /authentication | Test Authentication
 [**update_data_request**](PDFApi.md#update_data_request) | **PUT** /data_requests/{data_request_id} | Update a submission data request
@@ -218,6 +221,57 @@ Name | Type | Description  | Notes
 
 
 
+# **create_template**
+> Template1 create_template(template_document, template_name)
+
+Upload a new PDF template
+
+### 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_document = File.new('/path/to/file') # File | 
+template_name = 'template_name_example' # String | 
+
+begin
+  #Upload a new PDF template
+  result = api_instance.create_template(template_document, template_name)
+  p result
+rescue FormAPI::ApiError => e
+  puts "Exception when calling PDFApi->create_template: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **template_document** | **File**|  | 
+ **template_name** | **String**|  | 
+
+### Return type
+
+[**Template1**](Template1.md)
+
+### Authorization
+
+[api_token_basic](../README.md#api_token_basic)
+
+### HTTP request headers
+
+ - **Content-Type**: multipart/form-data
+ - **Accept**: application/json
+
+
+
 # **expire_combined_submission**
 > CombinedSubmission expire_combined_submission(combined_submission_id)
 
@@ -567,6 +621,104 @@ Name | Type | Description  | Notes
 
 
 
+# **get_template**
+> Template get_template(template_id)
+
+Check the status of an uploaded template
+
+### 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 = 'tpl_000000000000000001' # String | 
+
+begin
+  #Check the status of an uploaded template
+  result = api_instance.get_template(template_id)
+  p result
+rescue FormAPI::ApiError => e
+  puts "Exception when calling PDFApi->get_template: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **template_id** | **String**|  | 
+
+### Return type
+
+[**Template**](Template.md)
+
+### Authorization
+
+[api_token_basic](../README.md#api_token_basic)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+
+# **get_template_schema**
+> Hash<String, Object> get_template_schema(template_id)
+
+Fetch the JSON schema for a template
+
+### 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 = 'tpl_000000000000000001' # String | 
+
+begin
+  #Fetch the JSON schema for a template
+  result = api_instance.get_template_schema(template_id)
+  p result
+rescue FormAPI::ApiError => e
+  puts "Exception when calling PDFApi->get_template_schema: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **template_id** | **String**|  | 
+
+### Return type
+
+**Hash<String, Object>**
+
+### Authorization
+
+[api_token_basic](../README.md#api_token_basic)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+
 # **get_templates**
 > Array<Template> get_templates(opts)
 

data/form_api.gemspec

@@ -1,9 +1,9 @@
 # -*- encoding: utf-8 -*-
 
 =begin
-#API V1
+#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.
 
 OpenAPI spec version: v1
 
@@ -28,6 +28,7 @@ Gem::Specification.new do |s|
   s.required_ruby_version = ">= 1.9"
 
   s.add_runtime_dependency 'typhoeus', '~> 1.0', '>= 1.0.1'
+  s.add_runtime_dependency 'ffi', '~> 1.0', '>= 1.9.24'
   s.add_runtime_dependency 'json', '~> 2.1', '>= 2.1.0'
 
   s.add_development_dependency 'rspec', '~> 3.6', '>= 3.6.0'

data/lib/form_api.rb

@@ -1,7 +1,7 @@
 =begin
-#API V1
+#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.
 
 OpenAPI spec version: v1
 
@@ -38,6 +38,7 @@ require 'form_api/models/submission_batch'
 require 'form_api/models/submission_batch_data'
 require 'form_api/models/submission_data_request'
 require 'form_api/models/template'
+require 'form_api/models/template1'
 require 'form_api/models/update_data_request_response'
 require 'form_api/models/update_submission_data_request_data'
 

data/lib/form_api/api/pdf_api.rb

@@ -1,7 +1,7 @@
 =begin
-#API V1
+#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.
 
 OpenAPI spec version: v1
 
@@ -235,6 +235,67 @@ module FormAPI
       return data, status_code, headers
     end
 
+    # Upload a new PDF template
+    # @param template_document 
+    # @param template_name 
+    # @param [Hash] opts the optional parameters
+    # @return [Template1]
+    def create_template(template_document, template_name, opts = {})
+      data, _status_code, _headers = create_template_with_http_info(template_document, template_name, opts)
+      data
+    end
+
+    # Upload a new PDF template
+    # @param template_document 
+    # @param template_name 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(Template1, Fixnum, Hash)>] Template1 data, response status code and response headers
+    def create_template_with_http_info(template_document, template_name, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: PDFApi.create_template ...'
+      end
+      # verify the required parameter 'template_document' is set
+      if @api_client.config.client_side_validation && template_document.nil?
+        fail ArgumentError, "Missing the required parameter 'template_document' when calling PDFApi.create_template"
+      end
+      # verify the required parameter 'template_name' is set
+      if @api_client.config.client_side_validation && template_name.nil?
+        fail ArgumentError, "Missing the required parameter 'template_name' when calling PDFApi.create_template"
+      end
+      # resource path
+      local_var_path = '/templates'
+
+      # query parameters
+      query_params = {}
+
+      # header parameters
+      header_params = {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+      # HTTP header 'Content-Type'
+      header_params['Content-Type'] = @api_client.select_header_content_type(['multipart/form-data'])
+
+      # form parameters
+      form_params = {}
+      form_params['template[document]'] = template_document
+      form_params['template[name]'] = template_name
+
+      # http body (model)
+      post_body = nil
+      auth_names = ['api_token_basic']
+      data, status_code, headers = @api_client.call_api(:POST, local_var_path,
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => 'Template1')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: PDFApi#create_template\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
     # Expire a combined submission
     # @param combined_submission_id 
     # @param [Hash] opts the optional parameters
@@ -603,6 +664,108 @@ module FormAPI
       return data, status_code, headers
     end
 
+    # Check the status of an uploaded template
+    # @param template_id 
+    # @param [Hash] opts the optional parameters
+    # @return [Template]
+    def get_template(template_id, opts = {})
+      data, _status_code, _headers = get_template_with_http_info(template_id, opts)
+      data
+    end
+
+    # Check the status of an uploaded template
+    # @param template_id 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(Template, Fixnum, Hash)>] Template data, response status code and response headers
+    def get_template_with_http_info(template_id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: PDFApi.get_template ...'
+      end
+      # verify the required parameter 'template_id' is set
+      if @api_client.config.client_side_validation && template_id.nil?
+        fail ArgumentError, "Missing the required parameter 'template_id' when calling PDFApi.get_template"
+      end
+      # resource path
+      local_var_path = '/templates/{template_id}'.sub('{' + 'template_id' + '}', template_id.to_s)
+
+      # query parameters
+      query_params = {}
+
+      # header parameters
+      header_params = {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+
+      # form parameters
+      form_params = {}
+
+      # http body (model)
+      post_body = nil
+      auth_names = ['api_token_basic']
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path,
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => 'Template')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: PDFApi#get_template\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Fetch the JSON schema for a template
+    # @param template_id 
+    # @param [Hash] opts the optional parameters
+    # @return [Hash<String, Object>]
+    def get_template_schema(template_id, opts = {})
+      data, _status_code, _headers = get_template_schema_with_http_info(template_id, opts)
+      data
+    end
+
+    # Fetch the JSON schema for a template
+    # @param template_id 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(Hash<String, Object>, Fixnum, Hash)>] Hash<String, Object> data, response status code and response headers
+    def get_template_schema_with_http_info(template_id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: PDFApi.get_template_schema ...'
+      end
+      # verify the required parameter 'template_id' is set
+      if @api_client.config.client_side_validation && template_id.nil?
+        fail ArgumentError, "Missing the required parameter 'template_id' when calling PDFApi.get_template_schema"
+      end
+      # resource path
+      local_var_path = '/templates/{template_id}/schema'.sub('{' + 'template_id' + '}', template_id.to_s)
+
+      # query parameters
+      query_params = {}
+
+      # header parameters
+      header_params = {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+
+      # form parameters
+      form_params = {}
+
+      # http body (model)
+      post_body = nil
+      auth_names = ['api_token_basic']
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path,
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => 'Hash<String, Object>')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: PDFApi#get_template_schema\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
     # Get a list of all templates
     # @param [Hash] opts the optional parameters
     # @option opts [Integer] :page Default: 1