form_api 1.6.0 → 1.7.0

data/docs/SubmissionBatchData.md

@@ -6,6 +6,6 @@ Name | Type | Description | Notes
 **metadata** | **Object** |  | [optional] 
 **test** | **BOOLEAN** |  | [optional] 
 **template_id** | **String** |  | [optional] 
-**submissions** | [**Array<CreateSubmissionDataBatchRequest>**](CreateSubmissionDataBatchRequest.md) |  | 
+**submissions** | [**Array<SubmissionDataBatchRequest>**](SubmissionDataBatchRequest.md) |  | 
 
 

data/docs/{CreateSubmissionData.md → SubmissionData.md}

@@ -1,4 +1,4 @@
-# FormAPI::CreateSubmissionData
+# FormAPI::SubmissionData
 
 ## Properties
 Name | Type | Description | Notes

data/docs/{CreateSubmissionDataBatchRequest.md → SubmissionDataBatchRequest.md}

@@ -1,13 +1,13 @@
-# FormAPI::CreateSubmissionDataBatchRequest
+# FormAPI::SubmissionDataBatchRequest
 
 ## Properties
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**template_id** | **String** |  | 
-**test** | **BOOLEAN** |  | [optional] 
-**data** | **Object** |  | 
-**html** | **String** |  | [optional] 
 **css** | **String** |  | [optional] 
 **metadata** | **Object** |  | [optional] 
+**test** | **BOOLEAN** |  | [optional] 
+**data** | **Object** |  | [optional] 
+**template_id** | **String** |  | [optional] 
+**html** | **String** |  | [optional] 
 
 

data/docs/Templatesv2Template.md

@@ -0,0 +1,19 @@
+# FormAPI::Templatesv2Template
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**expiration_interval** | **String** |  | [optional] 
+**public_web_form** | **BOOLEAN** |  | [optional] 
+**webhook_url** | **String** |  | [optional] 
+**expire_submissions** | **BOOLEAN** |  | [optional] 
+**expire_after** | **Float** |  | [optional] 
+**allow_additional_properties** | **BOOLEAN** |  | [optional] 
+**document** | [**Templatesv2TemplateDocument**](Templatesv2TemplateDocument.md) |  | [optional] 
+**name** | **String** |  | [optional] 
+**public_submissions** | **BOOLEAN** |  | [optional] 
+**slack_webhook_url** | **String** |  | [optional] 
+**redirect_url** | **String** |  | [optional] 
+**blockchain_timestamp_verification** | **BOOLEAN** |  | [optional] 
+
+

data/docs/Templatesv2TemplateDocument.md

@@ -0,0 +1,10 @@
+# FormAPI::Templatesv2TemplateDocument
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**metadata** | [**Templatesv2TemplateDocumentMetadata**](Templatesv2TemplateDocumentMetadata.md) |  | [optional] 
+**id** | **String** |  | [optional] 
+**storage** | **String** |  | [optional] 
+
+

data/docs/Templatesv2TemplateDocumentMetadata.md

@@ -0,0 +1,10 @@
+# FormAPI::Templatesv2TemplateDocumentMetadata
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**filename** | **String** |  | [optional] 
+**size** | **Integer** |  | [optional] 
+**mime_type** | **String** |  | [optional] 
+
+

data/lib/form_api.rb

@@ -19,19 +19,21 @@ require 'form_api/configuration'
 # Models
 require 'form_api/models/authentication_error'
 require 'form_api/models/authentication_success_response'
+require 'form_api/models/combine_pdfs_data'
 require 'form_api/models/combined_submission'
 require 'form_api/models/combined_submission_action'
 require 'form_api/models/combined_submission_data'
 require 'form_api/models/create_combined_submission_response'
+require 'form_api/models/create_custom_file_data'
+require 'form_api/models/create_custom_file_response'
 require 'form_api/models/create_submission_batch_response'
 require 'form_api/models/create_submission_batch_submissions_response'
-require 'form_api/models/create_submission_data'
-require 'form_api/models/create_submission_data_batch_request'
-require 'form_api/models/create_submission_data_batch_v1'
 require 'form_api/models/create_submission_data_request_data'
 require 'form_api/models/create_submission_data_request_token_response'
 require 'form_api/models/create_submission_data_request_token_response_token'
 require 'form_api/models/create_submission_response'
+require 'form_api/models/create_template_data'
+require 'form_api/models/custom_file'
 require 'form_api/models/error'
 require 'form_api/models/invalid_request'
 require 'form_api/models/pending_template'
@@ -39,8 +41,13 @@ require 'form_api/models/submission'
 require 'form_api/models/submission_action'
 require 'form_api/models/submission_batch'
 require 'form_api/models/submission_batch_data'
+require 'form_api/models/submission_data'
+require 'form_api/models/submission_data_batch_request'
 require 'form_api/models/submission_data_request'
 require 'form_api/models/template'
+require 'form_api/models/templatesv2_template'
+require 'form_api/models/templatesv2_template_document'
+require 'form_api/models/templatesv2_template_document_metadata'
 require 'form_api/models/update_data_request_response'
 require 'form_api/models/update_submission_data_request_data'
 

data/lib/form_api/api/client.rb

@@ -13,13 +13,14 @@ module FormAPI
       end
 
       # Wait for job to finish by default.
-      options[:wait] = options.key?(:wait) ? options[:wait] : true
+      wait = options.key?(:wait) ? options[:wait] : true
+      options.delete :wait
 
       template_id = options.delete :template_id
       create_submission_data = options
       response = super(template_id, create_submission_data)
 
-      return response unless options[:wait]
+      return response unless wait
 
       submission = response.submission
       timeout = options[:timeout] || 60
@@ -52,12 +53,13 @@ module FormAPI
       end
 
       # Wait for job to finish by default.
-      options[:wait] = options.key?(:wait) ? options[:wait] : true
+      wait = options.key?(:wait) ? options[:wait] : true
+      options.delete :wait
 
       submission_batch_data = options
       response = super(submission_batch_data)
 
-      return response unless options[:wait]
+      return response unless wait
 
       batch = response.submission_batch
       submission_responses = response.submissions
@@ -103,18 +105,19 @@ module FormAPI
       )
     end
 
-    def combine_submissions(options)
-      unless options[:submission_ids].is_a?(::Array)
-        raise InvalidDataError, "submission_ids is required, and must be an Array."
+    def combine_pdfs(options)
+      unless options[:source_pdfs].is_a?(::Array)
+        raise InvalidDataError, "source_pdfs is required, and must be an Array."
       end
 
       # Wait for job to finish by default.
-      options[:wait] = options.key?(:wait) ? options[:wait] : true
+      wait = options.key?(:wait) ? options[:wait] : true
+      options.delete :wait
 
       # PdfAPI requires a :combined_submission_data option.
       response = super(options)
 
-      return response unless options[:wait]
+      return response unless wait
 
       combined_submission = response.combined_submission
       timeout = options[:timeout] || 600
@@ -136,6 +139,19 @@ module FormAPI
       )
     end
 
+    # Alias for combine_pdfs, for backwards compatibility
+    def combine_submissions(options)
+      unless options[:submission_ids].is_a?(::Array)
+        raise InvalidDataError, "submission_ids is required, and must be an Array."
+      end
+      options[:source_pdfs] = options[:submission_ids].map do |id|
+        { type: 'submission', id: id }
+      end
+      options.delete :submission_ids
+
+      combine_pdfs(options)
+    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

data/lib/form_api/api/pdf_api.rb

@@ -21,20 +21,20 @@ module FormAPI
     end
     # Generates multiple PDFs
     # @param template_id 
-    # @param create_submission_data_batch_v1 
+    # @param request_body 
     # @param [Hash] opts the optional parameters
     # @return [Array<CreateSubmissionResponse>]
-    def batch_generate_pdf_v1(template_id, create_submission_data_batch_v1, opts = {})
-      data, _status_code, _headers = batch_generate_pdf_v1_with_http_info(template_id, create_submission_data_batch_v1, opts)
+    def batch_generate_pdf_v1(template_id, request_body, opts = {})
+      data, _status_code, _headers = batch_generate_pdf_v1_with_http_info(template_id, request_body, opts)
       data
     end
 
     # Generates multiple PDFs
     # @param template_id 
-    # @param create_submission_data_batch_v1 
+    # @param request_body 
     # @param [Hash] opts the optional parameters
     # @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_batch_v1, opts = {})
+    def batch_generate_pdf_v1_with_http_info(template_id, request_body, opts = {})
       if @api_client.config.debugging
         @api_client.config.logger.debug 'Calling API: PDFApi.batch_generate_pdf_v1 ...'
       end
@@ -42,9 +42,9 @@ module FormAPI
       if @api_client.config.client_side_validation && template_id.nil?
         fail ArgumentError, "Missing the required parameter 'template_id' when calling PDFApi.batch_generate_pdf_v1"
       end
-      # verify the required parameter 'create_submission_data_batch_v1' is set
-      if @api_client.config.client_side_validation && create_submission_data_batch_v1.nil?
-        fail ArgumentError, "Missing the required parameter 'create_submission_data_batch_v1' when calling PDFApi.batch_generate_pdf_v1"
+      # verify the required parameter 'request_body' is set
+      if @api_client.config.client_side_validation && request_body.nil?
+        fail ArgumentError, "Missing the required parameter 'request_body' 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)
@@ -63,7 +63,7 @@ module FormAPI
       form_params = {}
 
       # http body (model)
-      post_body = @api_client.object_to_http_body(create_submission_data_batch_v1)
+      post_body = @api_client.object_to_http_body(request_body)
       auth_names = ['api_token_basic']
       data, status_code, headers = @api_client.call_api(:POST, local_var_path,
         :header_params => header_params,
@@ -131,6 +131,59 @@ module FormAPI
       return data, status_code, headers
     end
 
+    # Merge submission PDFs, template PDFs, or custom files
+    # @param combine_pdfs_data 
+    # @param [Hash] opts the optional parameters
+    # @return [CreateCombinedSubmissionResponse]
+    def combine_pdfs(combine_pdfs_data, opts = {})
+      data, _status_code, _headers = combine_pdfs_with_http_info(combine_pdfs_data, opts)
+      data
+    end
+
+    # Merge submission PDFs, template PDFs, or custom files
+    # @param combine_pdfs_data 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(CreateCombinedSubmissionResponse, Fixnum, Hash)>] CreateCombinedSubmissionResponse data, response status code and response headers
+    def combine_pdfs_with_http_info(combine_pdfs_data, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: PDFApi.combine_pdfs ...'
+      end
+      # verify the required parameter 'combine_pdfs_data' is set
+      if @api_client.config.client_side_validation && combine_pdfs_data.nil?
+        fail ArgumentError, "Missing the required parameter 'combine_pdfs_data' when calling PDFApi.combine_pdfs"
+      end
+      # resource path
+      local_var_path = '/combined_submissions?v=2'
+
+      # 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(combine_pdfs_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 => 'CreateCombinedSubmissionResponse')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: PDFApi#combine_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
@@ -184,6 +237,59 @@ module FormAPI
       return data, status_code, headers
     end
 
+    # Create a new custom file from a cached presign upload
+    # @param create_custom_file_data 
+    # @param [Hash] opts the optional parameters
+    # @return [CreateCustomFileResponse]
+    def create_custom_file_from_upload(create_custom_file_data, opts = {})
+      data, _status_code, _headers = create_custom_file_from_upload_with_http_info(create_custom_file_data, opts)
+      data
+    end
+
+    # Create a new custom file from a cached presign upload
+    # @param create_custom_file_data 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(CreateCustomFileResponse, Fixnum, Hash)>] CreateCustomFileResponse data, response status code and response headers
+    def create_custom_file_from_upload_with_http_info(create_custom_file_data, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: PDFApi.create_custom_file_from_upload ...'
+      end
+      # verify the required parameter 'create_custom_file_data' is set
+      if @api_client.config.client_side_validation && create_custom_file_data.nil?
+        fail ArgumentError, "Missing the required parameter 'create_custom_file_data' when calling PDFApi.create_custom_file_from_upload"
+      end
+      # resource path
+      local_var_path = '/custom_files'
+
+      # 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(create_custom_file_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 => 'CreateCustomFileResponse')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: PDFApi#create_custom_file_from_upload\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
     # Creates a new data request token for form authentication
     # @param data_request_id 
     # @param [Hash] opts the optional parameters
@@ -235,7 +341,7 @@ module FormAPI
       return data, status_code, headers
     end
 
-    # Upload a new PDF template
+    # Upload a new PDF template with a file upload
     # @param template_document 
     # @param template_name 
     # @param [Hash] opts the optional parameters
@@ -245,7 +351,7 @@ module FormAPI
       data
     end
 
-    # Upload a new PDF template
+    # Upload a new PDF template with a file upload
     # @param template_document 
     # @param template_name 
     # @param [Hash] opts the optional parameters
@@ -296,6 +402,59 @@ module FormAPI
       return data, status_code, headers
     end
 
+    # Create a new PDF template from a cached presign upload
+    # @param create_template_data 
+    # @param [Hash] opts the optional parameters
+    # @return [PendingTemplate]
+    def create_template_from_upload(create_template_data, opts = {})
+      data, _status_code, _headers = create_template_from_upload_with_http_info(create_template_data, opts)
+      data
+    end
+
+    # Create a new PDF template from a cached presign upload
+    # @param create_template_data 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(PendingTemplate, Fixnum, Hash)>] PendingTemplate data, response status code and response headers
+    def create_template_from_upload_with_http_info(create_template_data, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: PDFApi.create_template_from_upload ...'
+      end
+      # verify the required parameter 'create_template_data' is set
+      if @api_client.config.client_side_validation && create_template_data.nil?
+        fail ArgumentError, "Missing the required parameter 'create_template_data' when calling PDFApi.create_template_from_upload"
+      end
+      # resource path
+      local_var_path = '/templates?v=2'
+
+      # 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(create_template_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 => 'PendingTemplate')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: PDFApi#create_template_from_upload\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
@@ -400,20 +559,20 @@ module FormAPI
 
     # Generates a new PDF
     # @param template_id 
-    # @param create_submission_data 
+    # @param submission_data 
     # @param [Hash] opts the optional parameters
     # @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)
+    def generate_pdf(template_id, submission_data, opts = {})
+      data, _status_code, _headers = generate_pdf_with_http_info(template_id, submission_data, opts)
       data
     end
 
     # Generates a new PDF
     # @param template_id 
-    # @param create_submission_data 
+    # @param submission_data 
     # @param [Hash] opts the optional parameters
     # @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 = {})
+    def generate_pdf_with_http_info(template_id, submission_data, opts = {})
       if @api_client.config.debugging
         @api_client.config.logger.debug 'Calling API: PDFApi.generate_pdf ...'
       end
@@ -421,9 +580,9 @@ module FormAPI
       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"
+      # verify the required parameter 'submission_data' is set
+      if @api_client.config.client_side_validation && submission_data.nil?
+        fail ArgumentError, "Missing the required parameter 'submission_data' when calling PDFApi.generate_pdf"
       end
       # resource path
       local_var_path = '/templates/{template_id}/submissions'.sub('{' + 'template_id' + '}', template_id.to_s)
@@ -442,7 +601,7 @@ module FormAPI
       form_params = {}
 
       # http body (model)
-      post_body = @api_client.object_to_http_body(create_submission_data)
+      post_body = @api_client.object_to_http_body(submission_data)
       auth_names = ['api_token_basic']
       data, status_code, headers = @api_client.call_api(:POST, local_var_path,
         :header_params => header_params,
@@ -559,6 +718,51 @@ module FormAPI
       return data, status_code, headers
     end
 
+    # Get a presigned URL so that you can upload a file to our AWS S3 bucket
+    # @param [Hash] opts the optional parameters
+    # @return [Hash<String, Object>]
+    def get_presign_url(opts = {})
+      data, _status_code, _headers = get_presign_url_with_http_info(opts)
+      data
+    end
+
+    # Get a presigned URL so that you can upload a file to our AWS S3 bucket
+    # @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_presign_url_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: PDFApi.get_presign_url ...'
+      end
+      # resource path
+      local_var_path = '/uploads/presign'
+
+      # 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_presign_url\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
     # Check the status of a PDF
     # @param submission_id 
     # @param [Hash] opts the optional parameters