form_api 0.2.0 → 1.0.0

data/docs/Submission.md

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

data/docs/SubmissionBatch.md

@@ -0,0 +1,16 @@
+# FormAPI::SubmissionBatch
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**pending_count** | **Integer** |  | [optional] 
+**completion_percentage** | **Integer** |  | [optional] 
+**metadata** | **Object** |  | [optional] 
+**total_count** | **Integer** |  | [optional] 
+**submissions** | [**Array<Submission>**](Submission.md) |  | [optional] 
+**processed_at** | **String** |  | [optional] 
+**id** | **String** |  | [optional] 
+**state** | **String** |  | [optional] 
+**error_count** | **Integer** |  | [optional] 
+
+

data/docs/SubmissionBatchData.md

@@ -0,0 +1,11 @@
+# FormAPI::SubmissionBatchData
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**metadata** | **Object** |  | [optional] 
+**test** | **BOOLEAN** |  | [optional] 
+**template_id** | **String** |  | [optional] 
+**submissions** | [**Array<CreateSubmissionDataBatchRequest>**](CreateSubmissionDataBatchRequest.md) |  | 
+
+

data/docs/Template.md

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

data/form_api.gemspec

@@ -1,14 +1,14 @@
 # -*- encoding: utf-8 -*-
-#
+
 =begin
 #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)
 
 OpenAPI spec version: v1
 
-Generated by: https://github.com/swagger-api/swagger-codegen.git
-Swagger Codegen version: 2.3.0-SNAPSHOT
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 3.3.0-SNAPSHOT
 
 =end
 
@@ -24,7 +24,7 @@ Gem::Specification.new do |s|
   s.homepage    = "https://github.com/FormAPI/formapi-ruby"
   s.summary     = "FormAPI API Client"
   s.description = "Client library for the FormAPI PDF generation service"
-  s.license     = "MIT"
+  s.license     = 'MIT'
   s.required_ruby_version = ">= 1.9"
 
   s.add_runtime_dependency 'typhoeus', '~> 1.0', '>= 1.0.1'
@@ -38,12 +38,7 @@ Gem::Specification.new do |s|
   s.add_development_dependency 'autotest-growl', '~> 0.2', '>= 0.2.16'
   s.add_development_dependency 'autotest-fsevent', '~> 0.2', '>= 0.2.12'
 
-  # added by script/fix_gemspec.rb.
-  s.add_development_dependency 'rake', '~>11.2', '>= 11.2.2'
-  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
-
+  # Use git ls-files to ignore anything in .gitignore
   s.files         = `git ls-files`.split("\n").uniq.sort.select{|f| !f.empty? }
   s.test_files    = `git ls-files spec test`.split("\n")
   s.executables   = []

data/git_push.sh

@@ -1,10 +1,10 @@
 #!/bin/sh
 #
-# Generated by: https://github.com/swagger-api/swagger-codegen.git
+# Generated by: https://openapi-generator.tech
 #
 # 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"
+# Usage example: /bin/sh ./git_push.sh wing328 openapi-pestore-perl "minor update"
 
 git_user_id=$1
 git_repo_id=$2
@@ -39,7 +39,7 @@ 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."
+        echo "[INFO] \$GIT_TOKEN (environment variable) is not set. Using the git credential 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

data/lib/form_api.rb

@@ -1,12 +1,12 @@
 =begin
 #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)
 
 OpenAPI spec version: v1
 
-Generated by: https://github.com/swagger-api/swagger-codegen.git
-Swagger Codegen version: 2.3.0-SNAPSHOT
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 3.3.0-SNAPSHOT
 
 =end
 
@@ -17,20 +17,27 @@ require 'form_api/version'
 require 'form_api/configuration'
 
 # Models
-require 'form_api/models/create_combined_submission_body'
-require 'form_api/models/create_submission_batch_body'
-require 'form_api/models/create_submission_body'
-require 'form_api/models/inline_response_200'
-require 'form_api/models/inline_response_200_1'
-require 'form_api/models/inline_response_201'
-require 'form_api/models/inline_response_201_1'
-require 'form_api/models/inline_response_201_combined_submission'
-require 'form_api/models/inline_response_400'
-require 'form_api/models/inline_response_401'
-require 'form_api/models/inline_response_422'
-require 'form_api/models/templatestemplate_idsubmissionsbatch_submission'
+require 'form_api/models/authentication_error'
+require 'form_api/models/authentication_success_response'
+require 'form_api/models/combined_submission'
+require 'form_api/models/combined_submission_data'
+require 'form_api/models/create_combined_submission_response'
+require 'form_api/models/create_submission_batch_response'
+require 'form_api/models/create_submission_data'
+require 'form_api/models/create_submission_data_batch_request'
+require 'form_api/models/create_submission_response'
+require 'form_api/models/create_submission_response1'
+require 'form_api/models/error'
+require 'form_api/models/invalid_request'
+require 'form_api/models/submission'
+require 'form_api/models/submission_batch'
+require 'form_api/models/submission_batch_data'
+require 'form_api/models/template'
 
 # APIs
+require 'form_api/api/pdf_api'
+
+# Custom client
 require 'form_api/api/client'
 
 module FormAPI

data/lib/form_api/api/client.rb

@@ -1,82 +1,123 @@
 require 'form_api/api/pdf_api'
 
-# The original 'lib' files are overriden every time we
-# regenerate the client, so custom methods go in here.
-# Also I want to call it "Client".
-
 module FormAPI
   class Client < PDFApi
     class InvalidDataError < ApiError; end
     class PollTimeoutError < ApiError; end
     class InvalidResponseError < ApiError; end
+    class FailedBatchError < ApiError; end
 
-    def generate_pdf(opts = {})
-      unless opts[:data].kind_of?(::Hash)
+    def generate_pdf(options)
+      unless options[:data].is_a?(::Hash)
         raise InvalidDataError, "data is required, and must be a Hash."
       end
 
       # Wait for job to finish by default.
-      if !opts.has_key?(:wait)
-        opts[:wait] = true
-      end
-
-      # FormAPI requires a nested :data object.
-      opts[:'create_submission_body'] = { data: opts.delete(:data) }
-      if opts[:metadata]
-        opts[:'create_submission_body'][:metadata] = opts.delete(:metadata)
-      end
+      options[:wait] = options.key?(:wait) ? options[:wait] : true
 
-      template_id = opts.delete :template_id
-      response = super(template_id, opts)
+      template_id = options.delete :template_id
+      create_submission_data = options
+      response = super(template_id, create_submission_data)
 
-      return response unless opts[:wait]
+      return response unless options[:wait]
 
       submission = response.submission
-      timeout = opts[:timeout] || 60
+      timeout = options[:timeout] || 60
       start_time = Time.now
 
       # Wait for submission to be ready
       while submission.state == 'pending'
         sleep 1
         submission = get_submission(submission.id)
-
         if Time.now - start_time > timeout
-          raise PollTimeoutError, "PDF was not ready after #{timeout} seconds!"
+          raise PollTimeoutError, "PDF was not processed after #{timeout} seconds!"
         end
       end
 
-      return InlineResponse2011.new(
+      CreateSubmissionResponse.new(
         status: submission.state == 'processed' ? 'success' : 'error',
         submission: submission
       )
     end
 
-
-    def combine_submissions(opts = {})
-      unless opts[:submission_ids].kind_of?(::Array)
-        raise InvalidDataError, "submission_ids is required, and must be an Array."
+    def batch_generate_pdfs(options)
+      unless options[:submissions].is_a?(::Array)
+        raise InvalidDataError, ":submissions is required, and must be an Array."
+      end
+      options[:submissions].each do |submission|
+        unless submission[:data].is_a?(::Hash)
+          raise InvalidDataError,
+            ":data is required for each submission, and must be a Hash."
+        end
       end
 
       # Wait for job to finish by default.
-      if !opts.has_key?(:wait)
-        opts[:wait] = true
+      options[:wait] = options.key?(:wait) ? options[:wait] : true
+
+      submission_batch_data = options
+      response = super(submission_batch_data)
+
+      return response unless options[:wait]
+
+      batch = response.submission_batch
+      submissions = response.submissions
+      timeout = options[:timeout] || 600
+      start_time = Time.now
+
+      # Wait for submission to be ready
+      while batch.state == 'pending'
+        sleep 1
+        batch = get_submission_batch(batch.id)
+        if Time.now - start_time > timeout
+          raise PollTimeoutError, "PDFs were not processed after #{timeout} seconds!"
+        end
       end
 
-      # FormAPI requires a nested :data object.
-      opts[:data] = { submission_ids: opts.delete(:submission_ids) }
-      if opts[:metadata]
-        opts[:data][:metadata] = opts.delete(:metadata)
+      # While polling the batch status, we exclude any info about the submissions.
+      # We need to make one more request to fetch the updated submissions and
+      # prepare the correct responses for CreateSubmissionBatchResponse
+      batch_with_submissions = get_submission_batch(batch.id, include_submissions: true)
+      if batch_with_submissions.submissions && batch_with_submissions.submissions.any?
+        updated_submissions_hash =
+          batch_with_submissions.submissions.each_with_object({}) do |sub, h|
+            next h unless sub && sub.id
+            h[sub.id] = sub
+          end
+        submissions.each do |sub|
+          # If there's no submission it's already an error.
+          next unless sub.submission
+          updated_sub = updated_submissions_hash[sub.submission.id]
+          if updated_sub
+            sub.submission = updated_sub
+            sub.status = updated_sub.state == 'processed' ? 'success' : 'error'
+          else
+            sub.status = 'error'
+          end
+        end
       end
-      if opts[:expire_in]
-        opts[:data][:expire_in] = opts.delete(:expire_in)
+
+      CreateSubmissionBatchResponse.new(
+        status: batch.state == 'processed' ? 'success' : 'error',
+        submission_batch: batch,
+        submissions: submissions
+      )
+    end
+
+    def combine_submissions(options)
+      unless options[:submission_ids].is_a?(::Array)
+        raise InvalidDataError, "submission_ids is required, and must be an Array."
       end
 
-      response = super(opts)
+      # Wait for job to finish by default.
+      options[:wait] = options.key?(:wait) ? options[:wait] : true
+
+      # PdfAPI requires a :combined_submission_data option.
+      response = super(options)
 
-      return response unless opts[:wait]
+      return response unless options[:wait]
 
       combined_submission = response.combined_submission
-      timeout = opts[:timeout] || 60
+      timeout = options[:timeout] || 600
       start_time = Time.now
 
       # Wait for submission to be ready
@@ -89,10 +130,22 @@ module FormAPI
         end
       end
 
-      return InlineResponse201.new(
+      CreateCombinedSubmissionResponse.new(
         status: combined_submission.state == 'processed' ? 'success' : 'error',
         combined_submission: combined_submission
       )
     end
+
+    def batch_generate_and_combine_pdfs(options)
+      # We pass the wait option to the combine_submissions method
+      wait = options.key?(:wait) ? options.delete(:wait) : true
+
+      response = batch_generate_pdfs(options)
+      if response.status == 'error'
+        raise FailedBatchError, 'Batch job failed, cannot combine PDFs!'
+      end
+      submission_ids = response.submissions.map { |s| s.submission.id }
+      combine_submissions(submission_ids: submission_ids, wait: wait)
+    end
   end
 end

data/lib/form_api/api/pdf_api.rb

@@ -1,16 +1,16 @@
 =begin
 #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)
 
 OpenAPI spec version: v1
 
-Generated by: https://github.com/swagger-api/swagger-codegen.git
-Swagger Codegen version: 2.3.0-SNAPSHOT
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 3.3.0-SNAPSHOT
 
 =end
 
-require "uri"
+require 'uri'
 
 module FormAPI
   class PDFApi
@@ -19,34 +19,35 @@ module FormAPI
     def initialize(api_client = ApiClient.default)
       @api_client = api_client
     end
-
     # Generates multiple PDFs
-    #
-    # @param template_id
+    # @param template_id 
+    # @param create_submission_data 
     # @param [Hash] opts the optional parameters
-    # @option opts [Array<CreateSubmissionBatchBody>] :create_submission_batch_body
-    # @return [Array<InlineResponse2011>]
-    def batch_generate_pdf(template_id, opts = {})
-      data, _status_code, _headers = batch_generate_pdf_with_http_info(template_id, opts)
-      return data
+    # @return [Array<CreateSubmissionResponse>]
+    def batch_generate_pdf_v1(template_id, create_submission_data, opts = {})
+      data, _status_code, _headers = batch_generate_pdf_v1_with_http_info(template_id, create_submission_data, opts)
+      data
     end
 
     # Generates multiple PDFs
-    #
-    # @param template_id
+    # @param template_id 
+    # @param create_submission_data 
     # @param [Hash] opts the optional parameters
-    # @option opts [Array<CreateSubmissionBatchBody>] :create_submission_batch_body
-    # @return [Array<(Array<InlineResponse2011>, Fixnum, Hash)>] Array<InlineResponse2011> data, response status code and response headers
-    def batch_generate_pdf_with_http_info(template_id, opts = {})
+    # @return [Array<(Array<CreateSubmissionResponse>, Fixnum, Hash)>] Array<CreateSubmissionResponse> data, response status code and response headers
+    def batch_generate_pdf_v1_with_http_info(template_id, create_submission_data, opts = {})
       if @api_client.config.debugging
-        @api_client.config.logger.debug "Calling API: PDFApi.batch_generate_pdf ..."
+        @api_client.config.logger.debug 'Calling API: PDFApi.batch_generate_pdf_v1 ...'
       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.batch_generate_pdf"
+        fail ArgumentError, "Missing the required parameter 'template_id' when calling PDFApi.batch_generate_pdf_v1"
+      end
+      # verify the required parameter 'create_submission_data' is set
+      if @api_client.config.client_side_validation && create_submission_data.nil?
+        fail ArgumentError, "Missing the required parameter 'create_submission_data' when calling PDFApi.batch_generate_pdf_v1"
       end
       # resource path
-      local_var_path = "/templates/{template_id}/submissions/batch".sub('{' + 'template_id' + '}', template_id.to_s)
+      local_var_path = '/templates/{template_id}/submissions/batch'.sub('{' + 'template_id' + '}', template_id.to_s)
 
       # query parameters
       query_params = {}
@@ -62,7 +63,7 @@ module FormAPI
       form_params = {}
 
       # http body (model)
-      post_body = @api_client.object_to_http_body(opts[:'create_submission_batch_body'])
+      post_body = @api_client.object_to_http_body(create_submission_data)
       auth_names = ['api_token_basic']
       data, status_code, headers = @api_client.call_api(:POST, local_var_path,
         :header_params => header_params,
@@ -70,34 +71,89 @@ module FormAPI
         :form_params => form_params,
         :body => post_body,
         :auth_names => auth_names,
-        :return_type => 'Array<InlineResponse2011>')
+        :return_type => 'Array<CreateSubmissionResponse>')
       if @api_client.config.debugging
-        @api_client.config.logger.debug "API called: PDFApi#batch_generate_pdf\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+        @api_client.config.logger.debug "API called: PDFApi#batch_generate_pdf_v1\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Generates multiple PDFs
+    # @param submission_batch_data 
+    # @param [Hash] opts the optional parameters
+    # @return [CreateSubmissionBatchResponse]
+    def batch_generate_pdfs(submission_batch_data, opts = {})
+      data, _status_code, _headers = batch_generate_pdfs_with_http_info(submission_batch_data, opts)
+      data
+    end
+
+    # Generates multiple PDFs
+    # @param submission_batch_data 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(CreateSubmissionBatchResponse, Fixnum, Hash)>] CreateSubmissionBatchResponse data, response status code and response headers
+    def batch_generate_pdfs_with_http_info(submission_batch_data, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: PDFApi.batch_generate_pdfs ...'
+      end
+      # verify the required parameter 'submission_batch_data' is set
+      if @api_client.config.client_side_validation && submission_batch_data.nil?
+        fail ArgumentError, "Missing the required parameter 'submission_batch_data' when calling PDFApi.batch_generate_pdfs"
+      end
+      # resource path
+      local_var_path = '/submissions/batches'
+
+      # 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(['application/json'])
+
+      # form parameters
+      form_params = {}
+
+      # http body (model)
+      post_body = @api_client.object_to_http_body(submission_batch_data)
+      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 => 'CreateSubmissionBatchResponse')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: PDFApi#batch_generate_pdfs\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
       end
       return data, status_code, headers
     end
 
     # Merge generated PDFs together
-    #
+    # @param combined_submission_data 
     # @param [Hash] opts the optional parameters
-    # @option opts [CreateCombinedSubmissionBody] :create_combined_submission_body
-    # @return [InlineResponse201]
-    def combine_submissions(opts = {})
-      data, _status_code, _headers = combine_submissions_with_http_info(opts)
-      return data
+    # @return [CreateCombinedSubmissionResponse]
+    def combine_submissions(combined_submission_data, opts = {})
+      data, _status_code, _headers = combine_submissions_with_http_info(combined_submission_data, opts)
+      data
     end
 
     # Merge generated PDFs together
-    #
+    # @param combined_submission_data 
     # @param [Hash] opts the optional parameters
-    # @option opts [CreateCombinedSubmissionBody] :create_combined_submission_body
-    # @return [Array<(InlineResponse201, Fixnum, Hash)>] InlineResponse201 data, response status code and response headers
-    def combine_submissions_with_http_info(opts = {})
+    # @return [Array<(CreateCombinedSubmissionResponse, Fixnum, Hash)>] CreateCombinedSubmissionResponse data, response status code and response headers
+    def combine_submissions_with_http_info(combined_submission_data, opts = {})
       if @api_client.config.debugging
-        @api_client.config.logger.debug "Calling API: PDFApi.combine_submissions ..."
+        @api_client.config.logger.debug 'Calling API: PDFApi.combine_submissions ...'
+      end
+      # verify the required parameter 'combined_submission_data' is set
+      if @api_client.config.client_side_validation && combined_submission_data.nil?
+        fail ArgumentError, "Missing the required parameter 'combined_submission_data' when calling PDFApi.combine_submissions"
       end
       # resource path
-      local_var_path = "/combined_submissions"
+      local_var_path = '/combined_submissions'
 
       # query parameters
       query_params = {}
@@ -113,7 +169,7 @@ module FormAPI
       form_params = {}
 
       # http body (model)
-      post_body = @api_client.object_to_http_body(opts[:'create_combined_submission_body'])
+      post_body = @api_client.object_to_http_body(combined_submission_data)
       auth_names = ['api_token_basic']
       data, status_code, headers = @api_client.call_api(:POST, local_var_path,
         :header_params => header_params,
@@ -121,7 +177,7 @@ module FormAPI
         :form_params => form_params,
         :body => post_body,
         :auth_names => auth_names,
-        :return_type => 'InlineResponse201')
+        :return_type => 'CreateCombinedSubmissionResponse')
       if @api_client.config.debugging
         @api_client.config.logger.debug "API called: PDFApi#combine_submissions\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
       end
@@ -129,30 +185,28 @@ module FormAPI
     end
 
     # Expire a combined submission
-    #
-    # @param combined_submission_id
+    # @param combined_submission_id 
     # @param [Hash] opts the optional parameters
-    # @return [InlineResponse201CombinedSubmission]
+    # @return [CombinedSubmission]
     def expire_combined_submission(combined_submission_id, opts = {})
       data, _status_code, _headers = expire_combined_submission_with_http_info(combined_submission_id, opts)
-      return data
+      data
     end
 
     # Expire a combined submission
-    #
-    # @param combined_submission_id
+    # @param combined_submission_id 
     # @param [Hash] opts the optional parameters
-    # @return [Array<(InlineResponse201CombinedSubmission, Fixnum, Hash)>] InlineResponse201CombinedSubmission data, response status code and response headers
+    # @return [Array<(CombinedSubmission, Fixnum, Hash)>] CombinedSubmission data, response status code and response headers
     def expire_combined_submission_with_http_info(combined_submission_id, opts = {})
       if @api_client.config.debugging
-        @api_client.config.logger.debug "Calling API: PDFApi.expire_combined_submission ..."
+        @api_client.config.logger.debug 'Calling API: PDFApi.expire_combined_submission ...'
       end
       # verify the required parameter 'combined_submission_id' is set
       if @api_client.config.client_side_validation && combined_submission_id.nil?
         fail ArgumentError, "Missing the required parameter 'combined_submission_id' when calling PDFApi.expire_combined_submission"
       end
       # resource path
-      local_var_path = "/combined_submissions/{combined_submission_id}".sub('{' + 'combined_submission_id' + '}', combined_submission_id.to_s)
+      local_var_path = '/combined_submissions/{combined_submission_id}'.sub('{' + 'combined_submission_id' + '}', combined_submission_id.to_s)
 
       # query parameters
       query_params = {}
@@ -174,7 +228,7 @@ module FormAPI
         :form_params => form_params,
         :body => post_body,
         :auth_names => auth_names,
-        :return_type => 'InlineResponse201CombinedSubmission')
+        :return_type => 'CombinedSubmission')
       if @api_client.config.debugging
         @api_client.config.logger.debug "API called: PDFApi#expire_combined_submission\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
       end
@@ -182,30 +236,28 @@ module FormAPI
     end
 
     # Expire a PDF submission
-    #
-    # @param submission_id
+    # @param submission_id 
     # @param [Hash] opts the optional parameters
-    # @return [TemplatestemplateIdsubmissionsbatchSubmission]
+    # @return [Submission]
     def expire_submission(submission_id, opts = {})
       data, _status_code, _headers = expire_submission_with_http_info(submission_id, opts)
-      return data
+      data
     end
 
     # Expire a PDF submission
-    #
-    # @param submission_id
+    # @param submission_id 
     # @param [Hash] opts the optional parameters
-    # @return [Array<(TemplatestemplateIdsubmissionsbatchSubmission, Fixnum, Hash)>] TemplatestemplateIdsubmissionsbatchSubmission data, response status code and response headers
+    # @return [Array<(Submission, Fixnum, Hash)>] Submission data, response status code and response headers
     def expire_submission_with_http_info(submission_id, opts = {})
       if @api_client.config.debugging
-        @api_client.config.logger.debug "Calling API: PDFApi.expire_submission ..."
+        @api_client.config.logger.debug 'Calling API: PDFApi.expire_submission ...'
       end
       # verify the required parameter 'submission_id' is set
       if @api_client.config.client_side_validation && submission_id.nil?
         fail ArgumentError, "Missing the required parameter 'submission_id' when calling PDFApi.expire_submission"
       end
       # resource path
-      local_var_path = "/submissions/{submission_id}".sub('{' + 'submission_id' + '}', submission_id.to_s)
+      local_var_path = '/submissions/{submission_id}'.sub('{' + 'submission_id' + '}', submission_id.to_s)
 
       # query parameters
       query_params = {}
@@ -227,7 +279,7 @@ module FormAPI
         :form_params => form_params,
         :body => post_body,
         :auth_names => auth_names,
-        :return_type => 'TemplatestemplateIdsubmissionsbatchSubmission')
+        :return_type => 'Submission')
       if @api_client.config.debugging
         @api_client.config.logger.debug "API called: PDFApi#expire_submission\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
       end
@@ -235,32 +287,34 @@ module FormAPI
     end
 
     # Generates a new PDF
-    #
-    # @param template_id
+    # @param template_id 
+    # @param create_submission_data 
     # @param [Hash] opts the optional parameters
-    # @option opts [CreateSubmissionBody] :create_submission_body
-    # @return [InlineResponse2011]
-    def generate_pdf(template_id, opts = {})
-      data, _status_code, _headers = generate_pdf_with_http_info(template_id, opts)
-      return data
+    # @return [CreateSubmissionResponse]
+    def generate_pdf(template_id, create_submission_data, opts = {})
+      data, _status_code, _headers = generate_pdf_with_http_info(template_id, create_submission_data, opts)
+      data
     end
 
     # Generates a new PDF
-    #
-    # @param template_id
+    # @param template_id 
+    # @param create_submission_data 
     # @param [Hash] opts the optional parameters
-    # @option opts [CreateSubmissionBody] :create_submission_body
-    # @return [Array<(InlineResponse2011, Fixnum, Hash)>] InlineResponse2011 data, response status code and response headers
-    def generate_pdf_with_http_info(template_id, opts = {})
+    # @return [Array<(CreateSubmissionResponse, Fixnum, Hash)>] CreateSubmissionResponse data, response status code and response headers
+    def generate_pdf_with_http_info(template_id, create_submission_data, opts = {})
       if @api_client.config.debugging
-        @api_client.config.logger.debug "Calling API: PDFApi.generate_pdf ..."
+        @api_client.config.logger.debug 'Calling API: PDFApi.generate_pdf ...'
       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.generate_pdf"
       end
+      # verify the required parameter 'create_submission_data' is set
+      if @api_client.config.client_side_validation && create_submission_data.nil?
+        fail ArgumentError, "Missing the required parameter 'create_submission_data' when calling PDFApi.generate_pdf"
+      end
       # resource path
-      local_var_path = "/templates/{template_id}/submissions".sub('{' + 'template_id' + '}', template_id.to_s)
+      local_var_path = '/templates/{template_id}/submissions'.sub('{' + 'template_id' + '}', template_id.to_s)
 
       # query parameters
       query_params = {}
@@ -276,7 +330,7 @@ module FormAPI
       form_params = {}
 
       # http body (model)
-      post_body = @api_client.object_to_http_body(opts[:'create_submission_body'])
+      post_body = @api_client.object_to_http_body(create_submission_data)
       auth_names = ['api_token_basic']
       data, status_code, headers = @api_client.call_api(:POST, local_var_path,
         :header_params => header_params,
@@ -284,7 +338,7 @@ module FormAPI
         :form_params => form_params,
         :body => post_body,
         :auth_names => auth_names,
-        :return_type => 'InlineResponse2011')
+        :return_type => 'CreateSubmissionResponse')
       if @api_client.config.debugging
         @api_client.config.logger.debug "API called: PDFApi#generate_pdf\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
       end
@@ -292,30 +346,28 @@ module FormAPI
     end
 
     # Check the status of a combined submission (merged PDFs)
-    #
-    # @param combined_submission_id
+    # @param combined_submission_id 
     # @param [Hash] opts the optional parameters
-    # @return [InlineResponse201CombinedSubmission]
+    # @return [CombinedSubmission]
     def get_combined_submission(combined_submission_id, opts = {})
       data, _status_code, _headers = get_combined_submission_with_http_info(combined_submission_id, opts)
-      return data
+      data
     end
 
     # Check the status of a combined submission (merged PDFs)
-    #
-    # @param combined_submission_id
+    # @param combined_submission_id 
     # @param [Hash] opts the optional parameters
-    # @return [Array<(InlineResponse201CombinedSubmission, Fixnum, Hash)>] InlineResponse201CombinedSubmission data, response status code and response headers
+    # @return [Array<(CombinedSubmission, Fixnum, Hash)>] CombinedSubmission data, response status code and response headers
     def get_combined_submission_with_http_info(combined_submission_id, opts = {})
       if @api_client.config.debugging
-        @api_client.config.logger.debug "Calling API: PDFApi.get_combined_submission ..."
+        @api_client.config.logger.debug 'Calling API: PDFApi.get_combined_submission ...'
       end
       # verify the required parameter 'combined_submission_id' is set
       if @api_client.config.client_side_validation && combined_submission_id.nil?
         fail ArgumentError, "Missing the required parameter 'combined_submission_id' when calling PDFApi.get_combined_submission"
       end
       # resource path
-      local_var_path = "/combined_submissions/{combined_submission_id}".sub('{' + 'combined_submission_id' + '}', combined_submission_id.to_s)
+      local_var_path = '/combined_submissions/{combined_submission_id}'.sub('{' + 'combined_submission_id' + '}', combined_submission_id.to_s)
 
       # query parameters
       query_params = {}
@@ -337,7 +389,7 @@ module FormAPI
         :form_params => form_params,
         :body => post_body,
         :auth_names => auth_names,
-        :return_type => 'InlineResponse201CombinedSubmission')
+        :return_type => 'CombinedSubmission')
       if @api_client.config.debugging
         @api_client.config.logger.debug "API called: PDFApi#get_combined_submission\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
       end
@@ -345,30 +397,28 @@ module FormAPI
     end
 
     # Check the status of a PDF
-    #
-    # @param submission_id
+    # @param submission_id 
     # @param [Hash] opts the optional parameters
-    # @return [TemplatestemplateIdsubmissionsbatchSubmission]
+    # @return [Submission]
     def get_submission(submission_id, opts = {})
       data, _status_code, _headers = get_submission_with_http_info(submission_id, opts)
-      return data
+      data
     end
 
     # Check the status of a PDF
-    #
-    # @param submission_id
+    # @param submission_id 
     # @param [Hash] opts the optional parameters
-    # @return [Array<(TemplatestemplateIdsubmissionsbatchSubmission, Fixnum, Hash)>] TemplatestemplateIdsubmissionsbatchSubmission data, response status code and response headers
+    # @return [Array<(Submission, Fixnum, Hash)>] Submission data, response status code and response headers
     def get_submission_with_http_info(submission_id, opts = {})
       if @api_client.config.debugging
-        @api_client.config.logger.debug "Calling API: PDFApi.get_submission ..."
+        @api_client.config.logger.debug 'Calling API: PDFApi.get_submission ...'
       end
       # verify the required parameter 'submission_id' is set
       if @api_client.config.client_side_validation && submission_id.nil?
         fail ArgumentError, "Missing the required parameter 'submission_id' when calling PDFApi.get_submission"
       end
       # resource path
-      local_var_path = "/submissions/{submission_id}".sub('{' + 'submission_id' + '}', submission_id.to_s)
+      local_var_path = '/submissions/{submission_id}'.sub('{' + 'submission_id' + '}', submission_id.to_s)
 
       # query parameters
       query_params = {}
@@ -390,36 +440,100 @@ module FormAPI
         :form_params => form_params,
         :body => post_body,
         :auth_names => auth_names,
-        :return_type => 'TemplatestemplateIdsubmissionsbatchSubmission')
+        :return_type => 'Submission')
       if @api_client.config.debugging
         @api_client.config.logger.debug "API called: PDFApi#get_submission\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
       end
       return data, status_code, headers
     end
 
+    # Check the status of a submission batch job
+    # @param submission_batch_id 
+    # @param [Hash] opts the optional parameters
+    # @option opts [BOOLEAN] :include_submissions 
+    # @return [SubmissionBatch]
+    def get_submission_batch(submission_batch_id, opts = {})
+      data, _status_code, _headers = get_submission_batch_with_http_info(submission_batch_id, opts)
+      data
+    end
+
+    # Check the status of a submission batch job
+    # @param submission_batch_id 
+    # @param [Hash] opts the optional parameters
+    # @option opts [BOOLEAN] :include_submissions 
+    # @return [Array<(SubmissionBatch, Fixnum, Hash)>] SubmissionBatch data, response status code and response headers
+    def get_submission_batch_with_http_info(submission_batch_id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: PDFApi.get_submission_batch ...'
+      end
+      # verify the required parameter 'submission_batch_id' is set
+      if @api_client.config.client_side_validation && submission_batch_id.nil?
+        fail ArgumentError, "Missing the required parameter 'submission_batch_id' when calling PDFApi.get_submission_batch"
+      end
+      # resource path
+      local_var_path = '/submissions/batches/{submission_batch_id}'.sub('{' + 'submission_batch_id' + '}', submission_batch_id.to_s)
+
+      # query parameters
+      query_params = {}
+      query_params[:'include_submissions'] = opts[:'include_submissions'] if !opts[:'include_submissions'].nil?
+
+      # 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 => 'SubmissionBatch')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: PDFApi#get_submission_batch\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
     # @option opts [Integer] :per_page Default: 50
-    # @return [Array<InlineResponse2001>]
+    # @return [Array<Template>]
     def get_templates(opts = {})
       data, _status_code, _headers = get_templates_with_http_info(opts)
-      return data
+      data
     end
 
     # Get a list of all templates
-    #
     # @param [Hash] opts the optional parameters
     # @option opts [Integer] :page Default: 1
     # @option opts [Integer] :per_page Default: 50
-    # @return [Array<(Array<InlineResponse2001>, Fixnum, Hash)>] Array<InlineResponse2001> data, response status code and response headers
+    # @return [Array<(Array<Template>, Fixnum, Hash)>] Array<Template> data, response status code and response headers
     def get_templates_with_http_info(opts = {})
       if @api_client.config.debugging
-        @api_client.config.logger.debug "Calling API: PDFApi.get_templates ..."
+        @api_client.config.logger.debug 'Calling API: PDFApi.get_templates ...'
+      end
+      if @api_client.config.client_side_validation && !opts[:'page'].nil? && opts[:'page'] < 1
+        fail ArgumentError, 'invalid value for "opts[:"page"]" when calling PDFApi.get_templates, must be greater than or equal to 1.'
+      end
+
+      if @api_client.config.client_side_validation && !opts[:'per_page'].nil? && opts[:'per_page'] > 50
+        fail ArgumentError, 'invalid value for "opts[:"per_page"]" when calling PDFApi.get_templates, must be smaller than or equal to 50.'
+      end
+
+      if @api_client.config.client_side_validation && !opts[:'per_page'].nil? && opts[:'per_page'] < 1
+        fail ArgumentError, 'invalid value for "opts[:"per_page"]" when calling PDFApi.get_templates, must be greater than or equal to 1.'
       end
+
       # resource path
-      local_var_path = "/templates"
+      local_var_path = '/templates'
 
       # query parameters
       query_params = {}
@@ -443,7 +557,7 @@ module FormAPI
         :form_params => form_params,
         :body => post_body,
         :auth_names => auth_names,
-        :return_type => 'Array<InlineResponse2001>')
+        :return_type => 'Array<Template>')
       if @api_client.config.debugging
         @api_client.config.logger.debug "API called: PDFApi#get_templates\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
       end
@@ -451,24 +565,22 @@ module FormAPI
     end
 
     # Test Authentication
-    #
     # @param [Hash] opts the optional parameters
-    # @return [InlineResponse200]
+    # @return [AuthenticationSuccessResponse]
     def test_authentication(opts = {})
       data, _status_code, _headers = test_authentication_with_http_info(opts)
-      return data
+      data
     end
 
     # Test Authentication
-    #
     # @param [Hash] opts the optional parameters
-    # @return [Array<(InlineResponse200, Fixnum, Hash)>] InlineResponse200 data, response status code and response headers
+    # @return [Array<(AuthenticationSuccessResponse, Fixnum, Hash)>] AuthenticationSuccessResponse data, response status code and response headers
     def test_authentication_with_http_info(opts = {})
       if @api_client.config.debugging
-        @api_client.config.logger.debug "Calling API: PDFApi.test_authentication ..."
+        @api_client.config.logger.debug 'Calling API: PDFApi.test_authentication ...'
       end
       # resource path
-      local_var_path = "/authentication"
+      local_var_path = '/authentication'
 
       # query parameters
       query_params = {}
@@ -490,11 +602,12 @@ module FormAPI
         :form_params => form_params,
         :body => post_body,
         :auth_names => auth_names,
-        :return_type => 'InlineResponse200')
+        :return_type => 'AuthenticationSuccessResponse')
       if @api_client.config.debugging
         @api_client.config.logger.debug "API called: PDFApi#test_authentication\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
       end
       return data, status_code, headers
     end
+
   end
 end