form_api 1.1.0 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 2d535019a0b75e174177b3a84f01de0ebae125ea
-  data.tar.gz: 1c7bca8c308f98bd23170dcf4a69f5a1a8e5b0c5
+SHA256:
+  metadata.gz: f6c112bcd18aa30cc3bbe6d81cefd3b9b82382cf7b645ef7844905d594e47c4e
+  data.tar.gz: b14d3023317b5e8eda5d8db3c62fe0537c61213c07c058a6330e8ec44b6ab716
 SHA512:
-  metadata.gz: 12f2c5c6b3b673a6a31f03aa470ea6b2f1c95eb313c4bf7cb0c1090998d0e7e6586db1ef216ff7b806282faa3933d87978200a914fca552bfe097f3a6415a77f
-  data.tar.gz: a51b1d6cfe5ee9934b44db7246a6e29e7020c15b0d76b1bf2048798d7cb29e2c840a9eb0460406735d5640b5b2d0d87e824cec929130982e9cac99ca1bf49c03
+  metadata.gz: 2844d4d2d9744c40a40a78df852f6b59a8fce19210204995fa5e983c17fd14b526f3a671ed8a28609de6ee5ee1b17593d49c186a7fc252e003c6bfc3b59701c9
+  data.tar.gz: 2602eda92790f3aa9cd7c2cfdc76714d47441821077b49577b304ec32a4ade0502bb629a6e7aba1ab3666f9786beadcdf30494a6648e58d876e342036a11a959

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    form_api (1.1.0)
+    form_api (1.0.0)
       json (~> 2.1, >= 2.1.0)
       typhoeus (~> 1.0, >= 1.0.1)
 

data/README.md

@@ -7,7 +7,7 @@ No description provided (generated by Openapi Generator https://github.com/opena
 This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
 
 - API version: v1
-- Package version: 1.1.0
+- Package version: 1.2.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.1.0.gem
+gem install ./form_api-1.2.0.gem
 ```
-(for development, run `gem install --dev ./form_api-1.1.0.gem` to install the development dependencies)
+(for development, run `gem install --dev ./form_api-1.2.0.gem` to install the development dependencies)
 
 or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
 
 Finally add this to the Gemfile:
 
-    gem 'form_api', '~> 1.1.0'
+    gem 'form_api', '~> 1.2.0'
 
 ### Install from Git
 
@@ -63,11 +63,11 @@ end
 
 api_instance = FormAPI::PDFApi.new
 template_id = 'tpl_000000000000000001' # String | 
-create_submission_data = nil # Array<CreateSubmissionData> | 
+create_submission_data_batch_v1 = nil # Array<CreateSubmissionDataBatchV1> | 
 
 begin
   #Generates multiple PDFs
-  result = api_instance.batch_generate_pdf_v1(template_id, create_submission_data)
+  result = api_instance.batch_generate_pdf_v1(template_id, create_submission_data_batch_v1)
   p result
 rescue FormAPI::ApiError => e
   puts "Exception when calling PDFApi->batch_generate_pdf_v1: #{e}"
@@ -105,9 +105,9 @@ Class | Method | HTTP request | Description
  - [FormAPI::CreateCombinedSubmissionResponse](docs/CreateCombinedSubmissionResponse.md)
  - [FormAPI::CreateSubmissionBatchResponse](docs/CreateSubmissionBatchResponse.md)
  - [FormAPI::CreateSubmissionBatchSubmissionsResponse](docs/CreateSubmissionBatchSubmissionsResponse.md)
- - [FormAPI::CreateSubmissionBatchV1SubmissionsResponse](docs/CreateSubmissionBatchV1SubmissionsResponse.md)
  - [FormAPI::CreateSubmissionData](docs/CreateSubmissionData.md)
  - [FormAPI::CreateSubmissionDataBatchRequest](docs/CreateSubmissionDataBatchRequest.md)
+ - [FormAPI::CreateSubmissionDataBatchV1](docs/CreateSubmissionDataBatchV1.md)
  - [FormAPI::CreateSubmissionDataRequestTokenResponse](docs/CreateSubmissionDataRequestTokenResponse.md)
  - [FormAPI::CreateSubmissionDataRequestTokenResponseToken](docs/CreateSubmissionDataRequestTokenResponseToken.md)
  - [FormAPI::CreateSubmissionResponse](docs/CreateSubmissionResponse.md)
@@ -117,6 +117,7 @@ Class | Method | HTTP request | Description
  - [FormAPI::SubmissionBatch](docs/SubmissionBatch.md)
  - [FormAPI::SubmissionBatchData](docs/SubmissionBatchData.md)
  - [FormAPI::SubmissionDataRequest](docs/SubmissionDataRequest.md)
+ - [FormAPI::SubmissionDataRequestData](docs/SubmissionDataRequestData.md)
  - [FormAPI::Template](docs/Template.md)
 
 

data/docs/CombinedSubmissionData.md

@@ -6,6 +6,6 @@ Name | Type | Description | Notes
 **test** | **BOOLEAN** |  | [optional] 
 **submission_ids** | **Array<String>** |  | 
 **metadata** | **Object** |  | [optional] 
-**expires_in** | **Float** |  | [optional] 
+**expires_in** | **Integer** |  | [optional] 
 
 

data/docs/CreateSubmissionData.md

@@ -8,5 +8,6 @@ Name | Type | Description | Notes
 **html** | **String** |  | [optional] 
 **css** | **String** |  | [optional] 
 **metadata** | **Object** |  | [optional] 
+**data_requests** | [**Array<SubmissionDataRequestData>**](SubmissionDataRequestData.md) |  | [optional] 
 
 

data/docs/CreateSubmissionDataBatchV1.md

@@ -0,0 +1,12 @@
+# FormAPI::CreateSubmissionDataBatchV1
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**test** | **BOOLEAN** |  | [optional] 
+**data** | **Object** |  | 
+**html** | **String** |  | [optional] 
+**css** | **String** |  | [optional] 
+**metadata** | **Object** |  | [optional] 
+
+

data/docs/CreateSubmissionResponse.md

@@ -5,7 +5,6 @@ Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **submission** | [**Submission**](Submission.md) |  | [optional] 
 **errors** | **Array<String>** |  | [optional] 
-**data_requests** | [**Array<SubmissionDataRequest>**](SubmissionDataRequest.md) |  | [optional] 
 **status** | **String** |  | [optional] 
 
 

data/docs/PDFApi.md

@@ -20,7 +20,7 @@ Method | HTTP request | Description
 
 
 # **batch_generate_pdf_v1**
-> Array<CreateSubmissionBatchV1SubmissionsResponse> batch_generate_pdf_v1(template_id, create_submission_data)
+> Array<CreateSubmissionResponse> batch_generate_pdf_v1(template_id, create_submission_data_batch_v1)
 
 Generates multiple PDFs
 
@@ -37,11 +37,11 @@ end
 
 api_instance = FormAPI::PDFApi.new
 template_id = 'tpl_000000000000000001' # String | 
-create_submission_data = nil # Array<CreateSubmissionData> | 
+create_submission_data_batch_v1 = nil # Array<CreateSubmissionDataBatchV1> | 
 
 begin
   #Generates multiple PDFs
-  result = api_instance.batch_generate_pdf_v1(template_id, create_submission_data)
+  result = api_instance.batch_generate_pdf_v1(template_id, create_submission_data_batch_v1)
   p result
 rescue FormAPI::ApiError => e
   puts "Exception when calling PDFApi->batch_generate_pdf_v1: #{e}"
@@ -53,11 +53,11 @@ end
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
  **template_id** | **String**|  | 
- **create_submission_data** | [**Array&lt;CreateSubmissionData&gt;**](Array.md)|  | 
+ **create_submission_data_batch_v1** | [**Array&lt;CreateSubmissionDataBatchV1&gt;**](Array.md)|  | 
 
 ### Return type
 
-[**Array&lt;CreateSubmissionBatchV1SubmissionsResponse&gt;**](CreateSubmissionBatchV1SubmissionsResponse.md)
+[**Array&lt;CreateSubmissionResponse&gt;**](CreateSubmissionResponse.md)
 
 ### Authorization
 

data/docs/Submission.md

@@ -12,5 +12,6 @@ Name | Type | Description | Notes
 **metadata** | **Object** |  | [optional] 
 **download_url** | **String** |  | [optional] 
 **batch_id** | **String** |  | [optional] 
+**data_requests** | [**Array<SubmissionDataRequest>**](SubmissionDataRequest.md) |  | [optional] 
 
 

data/docs/SubmissionDataRequest.md

@@ -6,11 +6,11 @@ Name | Type | Description | Notes
 **id** | **String** |  | 
 **name** | **String** |  | 
 **email** | **String** |  | 
-**order** | **Float** |  | 
+**order** | **Integer** |  | 
 **fields** | **Array<String>** |  | 
 **metadata** | **Object** |  | 
 **state** | **String** |  | 
-**viewed_at** | **String** |  | 
-**completed_at** | **String** |  | 
+**viewed_at** | **String** |  | [optional] 
+**completed_at** | **String** |  | [optional] 
 
 

data/docs/SubmissionDataRequestData.md

@@ -0,0 +1,12 @@
+# FormAPI::SubmissionDataRequestData
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**metadata** | **Object** |  | [optional] 
+**name** | **String** |  | [optional] 
+**fields** | **Array<String>** |  | [optional] 
+**email** | **String** |  | [optional] 
+**order** | **Integer** |  | [optional] 
+
+

data/lib/form_api.rb

@@ -24,9 +24,9 @@ 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_batch_submissions_response'
-require 'form_api/models/create_submission_batch_v1_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_token_response'
 require 'form_api/models/create_submission_data_request_token_response_token'
 require 'form_api/models/create_submission_response'
@@ -36,6 +36,7 @@ require 'form_api/models/submission'
 require 'form_api/models/submission_batch'
 require 'form_api/models/submission_batch_data'
 require 'form_api/models/submission_data_request'
+require 'form_api/models/submission_data_request_data'
 require 'form_api/models/template'
 
 # APIs

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 
+    # @param create_submission_data_batch_v1 
     # @param [Hash] opts the optional parameters
-    # @return [Array<CreateSubmissionBatchV1SubmissionsResponse>]
-    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)
+    # @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)
       data
     end
 
     # Generates multiple PDFs
     # @param template_id 
-    # @param create_submission_data 
+    # @param create_submission_data_batch_v1 
     # @param [Hash] opts the optional parameters
-    # @return [Array<(Array<CreateSubmissionBatchV1SubmissionsResponse>, Fixnum, Hash)>] Array<CreateSubmissionBatchV1SubmissionsResponse> data, response status code and response headers
-    def batch_generate_pdf_v1_with_http_info(template_id, create_submission_data, 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_batch_v1, 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' 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"
+      # 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"
       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)
+      post_body = @api_client.object_to_http_body(create_submission_data_batch_v1)
       auth_names = ['api_token_basic']
       data, status_code, headers = @api_client.call_api(:POST, local_var_path,
         :header_params => header_params,
@@ -71,7 +71,7 @@ module FormAPI
         :form_params => form_params,
         :body => post_body,
         :auth_names => auth_names,
-        :return_type => 'Array<CreateSubmissionBatchV1SubmissionsResponse>')
+        :return_type => 'Array<CreateSubmissionResponse>')
       if @api_client.config.debugging
         @api_client.config.logger.debug "API called: PDFApi#batch_generate_pdf_v1\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
       end

data/lib/form_api/models/combined_submission_data.rb

@@ -38,7 +38,7 @@ module FormAPI
         :'test' => :'BOOLEAN',
         :'submission_ids' => :'Array<String>',
         :'metadata' => :'Object',
-        :'expires_in' => :'Float'
+        :'expires_in' => :'Integer'
       }
     end
 

data/lib/form_api/models/create_submission_data.rb

@@ -24,6 +24,8 @@ module FormAPI
 
     attr_accessor :metadata
 
+    attr_accessor :data_requests
+
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
@@ -31,7 +33,8 @@ module FormAPI
         :'data' => :'data',
         :'html' => :'html',
         :'css' => :'css',
-        :'metadata' => :'metadata'
+        :'metadata' => :'metadata',
+        :'data_requests' => :'data_requests'
       }
     end
 
@@ -42,7 +45,8 @@ module FormAPI
         :'data' => :'Object',
         :'html' => :'String',
         :'css' => :'String',
-        :'metadata' => :'Object'
+        :'metadata' => :'Object',
+        :'data_requests' => :'Array<SubmissionDataRequestData>'
       }
     end
 
@@ -73,6 +77,12 @@ module FormAPI
       if attributes.has_key?(:'metadata')
         self.metadata = attributes[:'metadata']
       end
+
+      if attributes.has_key?(:'data_requests')
+        if (value = attributes[:'data_requests']).is_a?(Array)
+          self.data_requests = value
+        end
+      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -102,7 +112,8 @@ module FormAPI
           data == o.data &&
           html == o.html &&
           css == o.css &&
-          metadata == o.metadata
+          metadata == o.metadata &&
+          data_requests == o.data_requests
     end
 
     # @see the `==` method
@@ -114,7 +125,7 @@ module FormAPI
     # Calculates hash code according to all attributes.
     # @return [Fixnum] Hash code
     def hash
-      [test, data, html, css, metadata].hash
+      [test, data, html, css, metadata, data_requests].hash
     end
 
     # Builds the object from hash

data/lib/form_api/models/create_submission_data_batch_v1.rb

@@ -0,0 +1,224 @@
+=begin
+#API V1
+
+#No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+
+OpenAPI spec version: v1
+
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 3.3.0-SNAPSHOT
+
+=end
+
+require 'date'
+
+module FormAPI
+  class CreateSubmissionDataBatchV1
+    attr_accessor :test
+
+    attr_accessor :data
+
+    attr_accessor :html
+
+    attr_accessor :css
+
+    attr_accessor :metadata
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'test' => :'test',
+        :'data' => :'data',
+        :'html' => :'html',
+        :'css' => :'css',
+        :'metadata' => :'metadata'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :'test' => :'BOOLEAN',
+        :'data' => :'Object',
+        :'html' => :'String',
+        :'css' => :'String',
+        :'metadata' => :'Object'
+      }
+    end
+
+    # Initializes the object
+    # @param [Hash] attributes Model attributes in the form of hash
+    def initialize(attributes = {})
+      return unless attributes.is_a?(Hash)
+
+      # convert string to symbol for hash key
+      attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }
+
+      if attributes.has_key?(:'test')
+        self.test = attributes[:'test']
+      end
+
+      if attributes.has_key?(:'data')
+        self.data = attributes[:'data']
+      end
+
+      if attributes.has_key?(:'html')
+        self.html = attributes[:'html']
+      end
+
+      if attributes.has_key?(:'css')
+        self.css = attributes[:'css']
+      end
+
+      if attributes.has_key?(:'metadata')
+        self.metadata = attributes[:'metadata']
+      end
+    end
+
+    # Show invalid properties with the reasons. Usually used together with valid?
+    # @return Array for valid properties with the reasons
+    def list_invalid_properties
+      invalid_properties = Array.new
+      if @data.nil?
+        invalid_properties.push('invalid value for "data", data cannot be nil.')
+      end
+
+      invalid_properties
+    end
+
+    # Check to see if the all the properties in the model are valid
+    # @return true if the model is valid
+    def valid?
+      return false if @data.nil?
+      true
+    end
+
+    # Checks equality by comparing each attribute.
+    # @param [Object] Object to be compared
+    def ==(o)
+      return true if self.equal?(o)
+      self.class == o.class &&
+          test == o.test &&
+          data == o.data &&
+          html == o.html &&
+          css == o.css &&
+          metadata == o.metadata
+    end
+
+    # @see the `==` method
+    # @param [Object] Object to be compared
+    def eql?(o)
+      self == o
+    end
+
+    # Calculates hash code according to all attributes.
+    # @return [Fixnum] Hash code
+    def hash
+      [test, data, html, css, metadata].hash
+    end
+
+    # Builds the object from hash
+    # @param [Hash] attributes Model attributes in the form of hash
+    # @return [Object] Returns the model itself
+    def build_from_hash(attributes)
+      return nil unless attributes.is_a?(Hash)
+      self.class.openapi_types.each_pair do |key, type|
+        if type =~ /\AArray<(.*)>/i
+          # check to ensure the input is an array given that the the attribute
+          # is documented as an array but the input is not
+          if attributes[self.class.attribute_map[key]].is_a?(Array)
+            self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
+          end
+        elsif !attributes[self.class.attribute_map[key]].nil?
+          self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
+        end # or else data not found in attributes(hash), not an issue as the data can be optional
+      end
+
+      self
+    end
+
+    # Deserializes the data based on type
+    # @param string type Data type
+    # @param string value Value to be deserialized
+    # @return [Object] Deserialized data
+    def _deserialize(type, value)
+      case type.to_sym
+      when :DateTime
+        DateTime.parse(value)
+      when :Date
+        Date.parse(value)
+      when :String
+        value.to_s
+      when :Integer
+        value.to_i
+      when :Float
+        value.to_f
+      when :BOOLEAN
+        if value.to_s =~ /\A(true|t|yes|y|1)\z/i
+          true
+        else
+          false
+        end
+      when :Object
+        # generic object (usually a Hash), return directly
+        value
+      when /\AArray<(?<inner_type>.+)>\z/
+        inner_type = Regexp.last_match[:inner_type]
+        value.map { |v| _deserialize(inner_type, v) }
+      when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
+        k_type = Regexp.last_match[:k_type]
+        v_type = Regexp.last_match[:v_type]
+        {}.tap do |hash|
+          value.each do |k, v|
+            hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
+          end
+        end
+      else # model
+        temp_model = FormAPI.const_get(type).new
+        temp_model.build_from_hash(value)
+      end
+    end
+
+    # Returns the string representation of the object
+    # @return [String] String presentation of the object
+    def to_s
+      to_hash.to_s
+    end
+
+    # to_body is an alias to to_hash (backward compatibility)
+    # @return [Hash] Returns the object in the form of hash
+    def to_body
+      to_hash
+    end
+
+    # Returns the object in the form of hash
+    # @return [Hash] Returns the object in the form of hash
+    def to_hash
+      hash = {}
+      self.class.attribute_map.each_pair do |attr, param|
+        value = self.send(attr)
+        next if value.nil?
+        hash[param] = _to_hash(value)
+      end
+      hash
+    end
+
+    # Outputs non-array value in the form of hash
+    # For object, use to_hash. Otherwise, just return the value
+    # @param [Object] value Any valid value
+    # @return [Hash] Returns the value in the form of hash
+    def _to_hash(value)
+      if value.is_a?(Array)
+        value.compact.map { |v| _to_hash(v) }
+      elsif value.is_a?(Hash)
+        {}.tap do |hash|
+          value.each { |k, v| hash[k] = _to_hash(v) }
+        end
+      elsif value.respond_to? :to_hash
+        value.to_hash
+      else
+        value
+      end
+    end
+  end
+end

data/lib/form_api/models/create_submission_response.rb

@@ -18,8 +18,6 @@ module FormAPI
 
     attr_accessor :errors
 
-    attr_accessor :data_requests
-
     attr_accessor :status
 
     class EnumAttributeValidator
@@ -49,7 +47,6 @@ module FormAPI
       {
         :'submission' => :'submission',
         :'errors' => :'errors',
-        :'data_requests' => :'data_requests',
         :'status' => :'status'
       }
     end
@@ -59,7 +56,6 @@ module FormAPI
       {
         :'submission' => :'Submission',
         :'errors' => :'Array<String>',
-        :'data_requests' => :'Array<SubmissionDataRequest>',
         :'status' => :'String'
       }
     end
@@ -82,12 +78,6 @@ module FormAPI
         end
       end
 
-      if attributes.has_key?(:'data_requests')
-        if (value = attributes[:'data_requests']).is_a?(Array)
-          self.data_requests = value
-        end
-      end
-
       if attributes.has_key?(:'status')
         self.status = attributes[:'status']
       end
@@ -125,7 +115,6 @@ module FormAPI
       self.class == o.class &&
           submission == o.submission &&
           errors == o.errors &&
-          data_requests == o.data_requests &&
           status == o.status
     end
 
@@ -138,7 +127,7 @@ module FormAPI
     # Calculates hash code according to all attributes.
     # @return [Fixnum] Hash code
     def hash
-      [submission, errors, data_requests, status].hash
+      [submission, errors, status].hash
     end
 
     # Builds the object from hash

data/lib/form_api/models/submission.rb

@@ -32,6 +32,8 @@ module FormAPI
 
     attr_accessor :batch_id
 
+    attr_accessor :data_requests
+
     class EnumAttributeValidator
       attr_reader :datatype
       attr_reader :allowable_values
@@ -65,7 +67,8 @@ module FormAPI
         :'state' => :'state',
         :'metadata' => :'metadata',
         :'download_url' => :'download_url',
-        :'batch_id' => :'batch_id'
+        :'batch_id' => :'batch_id',
+        :'data_requests' => :'data_requests'
       }
     end
 
@@ -80,7 +83,8 @@ module FormAPI
         :'state' => :'String',
         :'metadata' => :'Object',
         :'download_url' => :'String',
-        :'batch_id' => :'String'
+        :'batch_id' => :'String',
+        :'data_requests' => :'Array<SubmissionDataRequest>'
       }
     end
 
@@ -127,6 +131,12 @@ module FormAPI
       if attributes.has_key?(:'batch_id')
         self.batch_id = attributes[:'batch_id']
       end
+
+      if attributes.has_key?(:'data_requests')
+        if (value = attributes[:'data_requests']).is_a?(Array)
+          self.data_requests = value
+        end
+      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -187,7 +197,8 @@ module FormAPI
           state == o.state &&
           metadata == o.metadata &&
           download_url == o.download_url &&
-          batch_id == o.batch_id
+          batch_id == o.batch_id &&
+          data_requests == o.data_requests
     end
 
     # @see the `==` method
@@ -199,7 +210,7 @@ module FormAPI
     # Calculates hash code according to all attributes.
     # @return [Fixnum] Hash code
     def hash
-      [id, test, expired, expires_at, processed_at, state, metadata, download_url, batch_id].hash
+      [id, test, expired, expires_at, processed_at, state, metadata, download_url, batch_id, data_requests].hash
     end
 
     # Builds the object from hash

data/lib/form_api/models/submission_data_request.rb

@@ -75,7 +75,7 @@ module FormAPI
         :'id' => :'String',
         :'name' => :'String',
         :'email' => :'String',
-        :'order' => :'Float',
+        :'order' => :'Integer',
         :'fields' => :'Array<String>',
         :'metadata' => :'Object',
         :'state' => :'String',
@@ -163,14 +163,6 @@ module FormAPI
         invalid_properties.push('invalid value for "state", state cannot be nil.')
       end
 
-      if @viewed_at.nil?
-        invalid_properties.push('invalid value for "viewed_at", viewed_at cannot be nil.')
-      end
-
-      if @completed_at.nil?
-        invalid_properties.push('invalid value for "completed_at", completed_at cannot be nil.')
-      end
-
       invalid_properties
     end
 
@@ -186,8 +178,6 @@ module FormAPI
       return false if @state.nil?
       state_validator = EnumAttributeValidator.new('String', ['pending', 'complete'])
       return false unless state_validator.valid?(@state)
-      return false if @viewed_at.nil?
-      return false if @completed_at.nil?
       true
     end
 

data/lib/form_api/models/{create_submission_batch_v1_submissions_response.rb → submission_data_request_data.rb}

@@ -13,50 +13,36 @@ OpenAPI Generator version: 3.3.0-SNAPSHOT
 require 'date'
 
 module FormAPI
-  class CreateSubmissionBatchV1SubmissionsResponse
-    attr_accessor :submission
-
-    attr_accessor :errors
-
-    attr_accessor :status
-
-    class EnumAttributeValidator
-      attr_reader :datatype
-      attr_reader :allowable_values
-
-      def initialize(datatype, allowable_values)
-        @allowable_values = allowable_values.map do |value|
-          case datatype.to_s
-          when /Integer/i
-            value.to_i
-          when /Float/i
-            value.to_f
-          else
-            value
-          end
-        end
-      end
+  class SubmissionDataRequestData
+    attr_accessor :metadata
 
-      def valid?(value)
-        !value || allowable_values.include?(value)
-      end
-    end
+    attr_accessor :name
+
+    attr_accessor :fields
+
+    attr_accessor :email
+
+    attr_accessor :order
 
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
-        :'submission' => :'submission',
-        :'errors' => :'errors',
-        :'status' => :'status'
+        :'metadata' => :'metadata',
+        :'name' => :'name',
+        :'fields' => :'fields',
+        :'email' => :'email',
+        :'order' => :'order'
       }
     end
 
     # Attribute type mapping.
     def self.openapi_types
       {
-        :'submission' => :'Submission',
-        :'errors' => :'Array<String>',
-        :'status' => :'String'
+        :'metadata' => :'Object',
+        :'name' => :'String',
+        :'fields' => :'Array<String>',
+        :'email' => :'String',
+        :'order' => :'Integer'
       }
     end
 
@@ -68,18 +54,26 @@ module FormAPI
       # convert string to symbol for hash key
       attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }
 
-      if attributes.has_key?(:'submission')
-        self.submission = attributes[:'submission']
+      if attributes.has_key?(:'metadata')
+        self.metadata = attributes[:'metadata']
       end
 
-      if attributes.has_key?(:'errors')
-        if (value = attributes[:'errors']).is_a?(Array)
-          self.errors = value
+      if attributes.has_key?(:'name')
+        self.name = attributes[:'name']
+      end
+
+      if attributes.has_key?(:'fields')
+        if (value = attributes[:'fields']).is_a?(Array)
+          self.fields = value
         end
       end
 
-      if attributes.has_key?(:'status')
-        self.status = attributes[:'status']
+      if attributes.has_key?(:'email')
+        self.email = attributes[:'email']
+      end
+
+      if attributes.has_key?(:'order')
+        self.order = attributes[:'order']
       end
     end
 
@@ -93,29 +87,19 @@ module FormAPI
     # Check to see if the all the properties in the model are valid
     # @return true if the model is valid
     def valid?
-      status_validator = EnumAttributeValidator.new('String', ['success', 'error'])
-      return false unless status_validator.valid?(@status)
       true
     end
 
-    # Custom attribute writer method checking allowed values (enum).
-    # @param [Object] status Object to be assigned
-    def status=(status)
-      validator = EnumAttributeValidator.new('String', ['success', 'error'])
-      unless validator.valid?(status)
-        fail ArgumentError, 'invalid value for "status", must be one of #{validator.allowable_values}.'
-      end
-      @status = status
-    end
-
     # Checks equality by comparing each attribute.
     # @param [Object] Object to be compared
     def ==(o)
       return true if self.equal?(o)
       self.class == o.class &&
-          submission == o.submission &&
-          errors == o.errors &&
-          status == o.status
+          metadata == o.metadata &&
+          name == o.name &&
+          fields == o.fields &&
+          email == o.email &&
+          order == o.order
     end
 
     # @see the `==` method
@@ -127,7 +111,7 @@ module FormAPI
     # Calculates hash code according to all attributes.
     # @return [Fixnum] Hash code
     def hash
-      [submission, errors, status].hash
+      [metadata, name, fields, email, order].hash
     end
 
     # Builds the object from hash

data/lib/form_api/version.rb

@@ -11,5 +11,5 @@ OpenAPI Generator version: 3.3.0-SNAPSHOT
 =end
 
 module FormAPI
-  VERSION = '1.1.0'
+  VERSION = '1.2.0'
 end

data/spec/api/pdf_api_integration_spec.rb

@@ -204,6 +204,47 @@ describe 'PDFApi' do
       expect(submission.state).to eq 'pending'
     end
   end
+  # integration tests for generate_pdf with data requests
+  # Generates a new PDF
+  # @param template_id
+  # @param create_submission_data
+  # @param [Hash] opts the optional parameters
+  # @return [CreateSubmissionResponse]
+  describe 'generate_pdf test with data_requests' do
+    it 'should work' do
+      template_id = 'tpl_000000000000000001'
+      response = api_instance.generate_pdf(template_id,
+        data: {
+          title: 'Test PDF',
+        },
+        data_requests: [
+          {
+            name: 'John Smith',
+            email: 'jsmith@example.com',
+            fields: ['description'],
+            order: 1,
+          }
+        ]
+      )
+      expect(response.status).to eq 'success'
+      submission = response.submission
+      expect(submission.id).to start_with 'sub_'
+      expect(submission.expired).to eq false
+      expect(submission.state).to eq 'waiting_for_data_requests'
+
+      data_requests = submission.data_requests
+      expect(data_requests.count).to eq 1
+      data_request = data_requests.first
+
+      expect(data_request.id).to start_with 'drq_'
+      expect(data_request.state).to eq 'pending'
+      expect(data_request.fields).to eq ['description']
+      expect(data_request.order).to eq 1
+      expect(data_request.name).to eq 'John Smith'
+      expect(data_request.email).to eq 'jsmith@example.com'
+    end
+  end
+
   # integration tests for get_combined_submission
   # Check the status of a combined submission (merged PDFs)
   # @param combined_submission_id

data/spec/api/pdf_api_spec_original.skipped.rb

@@ -41,14 +41,14 @@ describe 'PDFApi' do
   # integration tests for batch_generate_pdf_v1
   # Generates multiple PDFs
   # @param template_id 
-  # @param create_submission_data 
+  # @param create_submission_data_batch_v1 
   # @param [Hash] opts the optional parameters
-  # @return [Array<CreateSubmissionBatchV1SubmissionsResponse>]
+  # @return [Array<CreateSubmissionResponse>]
   describe 'batch_generate_pdf_v1 test' do
     it 'should work' do
       template_id = 'tpl_000000000000000001' # String | 
-      create_submission_data = nil # Array<CreateSubmissionData> | 
-      result = api_instance.batch_generate_pdf_v1(template_id, create_submission_data)
+      create_submission_data_batch_v1 = nil # Array<CreateSubmissionDataBatchV1> | 
+      result = api_instance.batch_generate_pdf_v1(template_id, create_submission_data_batch_v1)
       expect(result).to_not be_nil
     end
   end

data/spec/models/{create_submission_batch_v1_submissions_response_spec.rb → create_submission_data_batch_v1_spec.rb}

@@ -14,43 +14,51 @@ require 'spec_helper'
 require 'json'
 require 'date'
 
-# Unit tests for FormAPI::CreateSubmissionBatchV1SubmissionsResponse
+# Unit tests for FormAPI::CreateSubmissionDataBatchV1
 # Automatically generated by openapi-generator (https://openapi-generator.tech)
 # Please update as you see appropriate
-describe 'CreateSubmissionBatchV1SubmissionsResponse' do
+describe 'CreateSubmissionDataBatchV1' do
   before do
     # run before each test
-    @instance = FormAPI::CreateSubmissionBatchV1SubmissionsResponse.new
+    @instance = FormAPI::CreateSubmissionDataBatchV1.new
   end
 
   after do
     # run after each test
   end
 
-  describe 'test an instance of CreateSubmissionBatchV1SubmissionsResponse' do
-    it 'should create an instance of CreateSubmissionBatchV1SubmissionsResponse' do
-      expect(@instance).to be_instance_of(FormAPI::CreateSubmissionBatchV1SubmissionsResponse)
+  describe 'test an instance of CreateSubmissionDataBatchV1' do
+    it 'should create an instance of CreateSubmissionDataBatchV1' do
+      expect(@instance).to be_instance_of(FormAPI::CreateSubmissionDataBatchV1)
     end
   end
-  describe 'test attribute "submission"' do
+  describe 'test attribute "test"' do
     it 'should work' do
       # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
     end
   end
 
-  describe 'test attribute "errors"' do
+  describe 'test attribute "data"' do
     it 'should work' do
       # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
     end
   end
 
-  describe 'test attribute "status"' do
+  describe 'test attribute "html"' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  describe 'test attribute "css"' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  describe 'test attribute "metadata"' do
     it 'should work' do
       # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
-      # validator = Petstore::EnumTest::EnumAttributeValidator.new('String', ["success", "error"])
-      # validator.allowable_values.each do |value|
-      #   expect { @instance.status = value }.not_to raise_error
-      # end
     end
   end
 

data/spec/models/create_submission_data_spec.rb

@@ -62,4 +62,10 @@ describe 'CreateSubmissionData' do
     end
   end
 
+  describe 'test attribute "data_requests"' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
 end

data/spec/models/create_submission_response_spec.rb

@@ -44,12 +44,6 @@ describe 'CreateSubmissionResponse' do
     end
   end
 
-  describe 'test attribute "data_requests"' do
-    it 'should work' do
-      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
-    end
-  end
-
   describe 'test attribute "status"' do
     it 'should work' do
       # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers

data/spec/models/submission_data_request_data_spec.rb

@@ -0,0 +1,65 @@
+=begin
+#API V1
+
+#No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+
+OpenAPI spec version: v1
+
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 3.3.0-SNAPSHOT
+
+=end
+
+require 'spec_helper'
+require 'json'
+require 'date'
+
+# Unit tests for FormAPI::SubmissionDataRequestData
+# Automatically generated by openapi-generator (https://openapi-generator.tech)
+# Please update as you see appropriate
+describe 'SubmissionDataRequestData' do
+  before do
+    # run before each test
+    @instance = FormAPI::SubmissionDataRequestData.new
+  end
+
+  after do
+    # run after each test
+  end
+
+  describe 'test an instance of SubmissionDataRequestData' do
+    it 'should create an instance of SubmissionDataRequestData' do
+      expect(@instance).to be_instance_of(FormAPI::SubmissionDataRequestData)
+    end
+  end
+  describe 'test attribute "metadata"' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  describe 'test attribute "name"' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  describe 'test attribute "fields"' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  describe 'test attribute "email"' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  describe 'test attribute "order"' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+end

data/spec/models/submission_spec.rb

@@ -90,4 +90,10 @@ describe 'Submission' do
     end
   end
 
+  describe 'test attribute "data_requests"' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: form_api
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.2.0
 platform: ruby
 authors:
 - Form Applications, Inc.
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-10-23 00:00:00.000000000 Z
+date: 2018-10-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: typhoeus
@@ -213,9 +213,9 @@ files:
 - docs/CreateCombinedSubmissionResponse.md
 - docs/CreateSubmissionBatchResponse.md
 - docs/CreateSubmissionBatchSubmissionsResponse.md
-- docs/CreateSubmissionBatchV1SubmissionsResponse.md
 - docs/CreateSubmissionData.md
 - docs/CreateSubmissionDataBatchRequest.md
+- docs/CreateSubmissionDataBatchV1.md
 - docs/CreateSubmissionDataRequestTokenResponse.md
 - docs/CreateSubmissionDataRequestTokenResponseToken.md
 - docs/CreateSubmissionResponse.md
@@ -226,6 +226,7 @@ files:
 - docs/SubmissionBatch.md
 - docs/SubmissionBatchData.md
 - docs/SubmissionDataRequest.md
+- docs/SubmissionDataRequestData.md
 - docs/Template.md
 - form_api.gemspec
 - git_push.sh
@@ -242,9 +243,9 @@ files:
 - lib/form_api/models/create_combined_submission_response.rb
 - lib/form_api/models/create_submission_batch_response.rb
 - lib/form_api/models/create_submission_batch_submissions_response.rb
-- lib/form_api/models/create_submission_batch_v1_submissions_response.rb
 - lib/form_api/models/create_submission_data.rb
 - lib/form_api/models/create_submission_data_batch_request.rb
+- lib/form_api/models/create_submission_data_batch_v1.rb
 - lib/form_api/models/create_submission_data_request_token_response.rb
 - lib/form_api/models/create_submission_data_request_token_response_token.rb
 - lib/form_api/models/create_submission_response.rb
@@ -254,6 +255,7 @@ files:
 - lib/form_api/models/submission_batch.rb
 - lib/form_api/models/submission_batch_data.rb
 - lib/form_api/models/submission_data_request.rb
+- lib/form_api/models/submission_data_request_data.rb
 - lib/form_api/models/template.rb
 - lib/form_api/version.rb
 - spec/api/client_integration_spec.rb
@@ -268,8 +270,8 @@ files:
 - spec/models/create_combined_submission_response_spec.rb
 - spec/models/create_submission_batch_response_spec.rb
 - spec/models/create_submission_batch_submissions_response_spec.rb
-- spec/models/create_submission_batch_v1_submissions_response_spec.rb
 - spec/models/create_submission_data_batch_request_spec.rb
+- spec/models/create_submission_data_batch_v1_spec.rb
 - spec/models/create_submission_data_request_token_response_spec.rb
 - spec/models/create_submission_data_request_token_response_token_spec.rb
 - spec/models/create_submission_data_spec.rb
@@ -278,6 +280,7 @@ files:
 - spec/models/invalid_request_spec.rb
 - spec/models/submission_batch_data_spec.rb
 - spec/models/submission_batch_spec.rb
+- spec/models/submission_data_request_data_spec.rb
 - spec/models/submission_data_request_spec.rb
 - spec/models/submission_spec.rb
 - spec/models/template_spec.rb
@@ -302,7 +305,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.14
+rubygems_version: 2.7.6
 signing_key: 
 specification_version: 4
 summary: FormAPI API Client
@@ -319,8 +322,8 @@ test_files:
 - spec/models/create_combined_submission_response_spec.rb
 - spec/models/create_submission_batch_response_spec.rb
 - spec/models/create_submission_batch_submissions_response_spec.rb
-- spec/models/create_submission_batch_v1_submissions_response_spec.rb
 - spec/models/create_submission_data_batch_request_spec.rb
+- spec/models/create_submission_data_batch_v1_spec.rb
 - spec/models/create_submission_data_request_token_response_spec.rb
 - spec/models/create_submission_data_request_token_response_token_spec.rb
 - spec/models/create_submission_data_spec.rb
@@ -329,6 +332,7 @@ test_files:
 - spec/models/invalid_request_spec.rb
 - spec/models/submission_batch_data_spec.rb
 - spec/models/submission_batch_spec.rb
+- spec/models/submission_data_request_data_spec.rb
 - spec/models/submission_data_request_spec.rb
 - spec/models/submission_spec.rb
 - spec/models/template_spec.rb

data/docs/CreateSubmissionBatchV1SubmissionsResponse.md

@@ -1,10 +0,0 @@
-# FormAPI::CreateSubmissionBatchV1SubmissionsResponse
-
-## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**submission** | [**Submission**](Submission.md) |  | [optional] 
-**errors** | **Array<String>** |  | [optional] 
-**status** | **String** |  | [optional] 
-
-