form_api 1.4.1 → 1.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ef9cd2af9790f6ab86f86c5a8d07f0cef50a92463a73c701a03a2e5fdf70b6d6
-  data.tar.gz: a1b0e7b91094518f686c435c422d52ac5527be96fe31acfbdd761046c46f9141
+  metadata.gz: f1d068243d4371605f24470720f416a32aa032b0a5425dad32314422a79042e1
+  data.tar.gz: 353135e261d59c05627316d8fa80caa95100058dfd06744d9a4fb27cb3142614
 SHA512:
-  metadata.gz: fc0bc7f68c075fc40a0753a1650125fe700327469844e989761058797987b9d9323a91d9eb693276b38a594e116f684528d2a9a5368fc492f8441aa7035bce4f
-  data.tar.gz: 03bc2be8d1005548d42154060f3d8c409143e6c908846989dcd5fa284ac0c0ce1a6efece34f5b335a250dd46e2eda10f938ed28523aa7f1548143d58c0fbfed2
+  metadata.gz: 5427b856c1276fdd3fedfa6d42ba1c693ac64191c581c7f18341aba34750edfac61ce947abe1efecda174e5232b46b5aabaf884e68b22bcb4f9af26cc67cb43b
+  data.tar.gz: 41625cf306eab595c13cc71882371443ed2dc31dbfa1cd2c83d65e69886523791e9aec316cab5a787745edd7bf323277a384367fedd7b6cca31b1df17e8c3a2e

data/CHANGELOG.md

@@ -1,3 +1,7 @@
+### 1.5.0 [December 13, 2018]
+* Fix model name for newly created Templates (PendingTemplate)
+* Added "actions" to submission and combined_submission responses. Includes information about custom S3 uploads
+
 ### 1.4.1 [December 2, 2018]
 * Fixed crash in 1.4.0, did not include all of the necessary files
 

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    form_api (1.4.1)
+    form_api (1.5.0)
       ffi (~> 1.0, >= 1.9.24)
       json (~> 2.1, >= 2.1.0)
       typhoeus (~> 1.0, >= 1.0.1)

data/README.md

@@ -7,7 +7,7 @@ FormAPI is a service that helps you fill out and sign PDF templates.
 This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
 
 - API version: v1
-- Package version: 1.4.1
+- Package version: 1.5.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.4.1.gem
+gem install ./form_api-1.5.0.gem
 ```
-(for development, run `gem install --dev ./form_api-1.4.1.gem` to install the development dependencies)
+(for development, run `gem install --dev ./form_api-1.5.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.4.1'
+    gem 'form_api', '~> 1.5.0'
 
 ### Install from Git
 
@@ -105,6 +105,7 @@ Class | Method | HTTP request | Description
  - [FormAPI::AuthenticationError](docs/AuthenticationError.md)
  - [FormAPI::AuthenticationSuccessResponse](docs/AuthenticationSuccessResponse.md)
  - [FormAPI::CombinedSubmission](docs/CombinedSubmission.md)
+ - [FormAPI::CombinedSubmissionAction](docs/CombinedSubmissionAction.md)
  - [FormAPI::CombinedSubmissionData](docs/CombinedSubmissionData.md)
  - [FormAPI::CreateCombinedSubmissionResponse](docs/CreateCombinedSubmissionResponse.md)
  - [FormAPI::CreateSubmissionBatchResponse](docs/CreateSubmissionBatchResponse.md)
@@ -118,12 +119,13 @@ Class | Method | HTTP request | Description
  - [FormAPI::CreateSubmissionResponse](docs/CreateSubmissionResponse.md)
  - [FormAPI::Error](docs/Error.md)
  - [FormAPI::InvalidRequest](docs/InvalidRequest.md)
+ - [FormAPI::PendingTemplate](docs/PendingTemplate.md)
  - [FormAPI::Submission](docs/Submission.md)
+ - [FormAPI::SubmissionAction](docs/SubmissionAction.md)
  - [FormAPI::SubmissionBatch](docs/SubmissionBatch.md)
  - [FormAPI::SubmissionBatchData](docs/SubmissionBatchData.md)
  - [FormAPI::SubmissionDataRequest](docs/SubmissionDataRequest.md)
  - [FormAPI::Template](docs/Template.md)
- - [FormAPI::Template1](docs/Template1.md)
  - [FormAPI::UpdateDataRequestResponse](docs/UpdateDataRequestResponse.md)
  - [FormAPI::UpdateSubmissionDataRequestData](docs/UpdateSubmissionDataRequestData.md)
 

data/docs/CombinedSubmission.md

@@ -10,5 +10,6 @@ Name | Type | Description | Notes
 **submission_ids** | **Array<String>** |  | [optional] 
 **id** | **String** |  | [optional] 
 **state** | **String** |  | [optional] 
+**actions** | [**Array<CombinedSubmissionAction>**](CombinedSubmissionAction.md) |  | [optional] 
 
 

data/docs/CombinedSubmissionAction.md

@@ -0,0 +1,13 @@
+# FormAPI::CombinedSubmissionAction
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **String** |  | 
+**integration_id** | **String** |  | 
+**state** | **String** |  | 
+**action_category** | **String** |  | 
+**action_type** | **String** |  | 
+**result_data** | **Object** |  | 
+
+

data/docs/PDFApi.md

@@ -222,7 +222,7 @@ Name | Type | Description  | Notes
 
 
 # **create_template**
-> Template1 create_template(template_document, template_name)
+> PendingTemplate create_template(template_document, template_name)
 
 Upload a new PDF template
 
@@ -259,7 +259,7 @@ Name | Type | Description  | Notes
 
 ### Return type
 
-[**Template1**](Template1.md)
+[**PendingTemplate**](PendingTemplate.md)
 
 ### Authorization
 

data/docs/{Template1.md → PendingTemplate.md}

@@ -1,4 +1,4 @@
-# FormAPI::Template1
+# FormAPI::PendingTemplate
 
 ## Properties
 Name | Type | Description | Notes

data/docs/Submission.md

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

data/docs/SubmissionAction.md

@@ -0,0 +1,13 @@
+# FormAPI::SubmissionAction
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **String** |  | 
+**integration_id** | **String** |  | 
+**state** | **String** |  | 
+**action_category** | **String** |  | 
+**action_type** | **String** |  | 
+**result_data** | **Object** |  | 
+
+

data/lib/form_api.rb

@@ -20,6 +20,7 @@ require 'form_api/configuration'
 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_action'
 require 'form_api/models/combined_submission_data'
 require 'form_api/models/create_combined_submission_response'
 require 'form_api/models/create_submission_batch_response'
@@ -33,12 +34,13 @@ require 'form_api/models/create_submission_data_request_token_response_token'
 require 'form_api/models/create_submission_response'
 require 'form_api/models/error'
 require 'form_api/models/invalid_request'
+require 'form_api/models/pending_template'
 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_request'
 require 'form_api/models/template'
-require 'form_api/models/template1'
 require 'form_api/models/update_data_request_response'
 require 'form_api/models/update_submission_data_request_data'
 

data/lib/form_api/api/pdf_api.rb

@@ -239,7 +239,7 @@ module FormAPI
     # @param template_document 
     # @param template_name 
     # @param [Hash] opts the optional parameters
-    # @return [Template1]
+    # @return [PendingTemplate]
     def create_template(template_document, template_name, opts = {})
       data, _status_code, _headers = create_template_with_http_info(template_document, template_name, opts)
       data
@@ -249,7 +249,7 @@ module FormAPI
     # @param template_document 
     # @param template_name 
     # @param [Hash] opts the optional parameters
-    # @return [Array<(Template1, Fixnum, Hash)>] Template1 data, response status code and response headers
+    # @return [Array<(PendingTemplate, Fixnum, Hash)>] PendingTemplate data, response status code and response headers
     def create_template_with_http_info(template_document, template_name, opts = {})
       if @api_client.config.debugging
         @api_client.config.logger.debug 'Calling API: PDFApi.create_template ...'
@@ -289,7 +289,7 @@ module FormAPI
         :form_params => form_params,
         :body => post_body,
         :auth_names => auth_names,
-        :return_type => 'Template1')
+        :return_type => 'PendingTemplate')
       if @api_client.config.debugging
         @api_client.config.logger.debug "API called: PDFApi#create_template\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
       end

data/lib/form_api/models/combined_submission.rb

@@ -28,6 +28,8 @@ module FormAPI
 
     attr_accessor :state
 
+    attr_accessor :actions
+
     class EnumAttributeValidator
       attr_reader :datatype
       attr_reader :allowable_values
@@ -59,7 +61,8 @@ module FormAPI
         :'download_url' => :'download_url',
         :'submission_ids' => :'submission_ids',
         :'id' => :'id',
-        :'state' => :'state'
+        :'state' => :'state',
+        :'actions' => :'actions'
       }
     end
 
@@ -72,7 +75,8 @@ module FormAPI
         :'download_url' => :'String',
         :'submission_ids' => :'Array<String>',
         :'id' => :'String',
-        :'state' => :'String'
+        :'state' => :'String',
+        :'actions' => :'Array<CombinedSubmissionAction>'
       }
     end
 
@@ -113,6 +117,12 @@ module FormAPI
       if attributes.has_key?(:'state')
         self.state = attributes[:'state']
       end
+
+      if attributes.has_key?(:'actions')
+        if (value = attributes[:'actions']).is_a?(Array)
+          self.actions = value
+        end
+      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -151,7 +161,8 @@ module FormAPI
           download_url == o.download_url &&
           submission_ids == o.submission_ids &&
           id == o.id &&
-          state == o.state
+          state == o.state &&
+          actions == o.actions
     end
 
     # @see the `==` method
@@ -163,7 +174,7 @@ module FormAPI
     # Calculates hash code according to all attributes.
     # @return [Fixnum] Hash code
     def hash
-      [metadata, expired, expires_at, download_url, submission_ids, id, state].hash
+      [metadata, expired, expires_at, download_url, submission_ids, id, state, actions].hash
     end
 
     # Builds the object from hash

data/lib/form_api/models/combined_submission_action.rb

@@ -0,0 +1,316 @@
+=begin
+#API v1
+
+#FormAPI is a service that helps you fill out and sign PDF templates.
+
+OpenAPI spec version: v1
+
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 3.3.0-SNAPSHOT
+
+=end
+
+require 'date'
+
+module FormAPI
+  class CombinedSubmissionAction
+    attr_accessor :id
+
+    attr_accessor :integration_id
+
+    attr_accessor :state
+
+    attr_accessor :action_category
+
+    attr_accessor :action_type
+
+    attr_accessor :result_data
+
+    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
+
+      def valid?(value)
+        !value || allowable_values.include?(value)
+      end
+    end
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'id' => :'id',
+        :'integration_id' => :'integration_id',
+        :'state' => :'state',
+        :'action_category' => :'action_category',
+        :'action_type' => :'action_type',
+        :'result_data' => :'result_data'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :'id' => :'String',
+        :'integration_id' => :'String',
+        :'state' => :'String',
+        :'action_category' => :'String',
+        :'action_type' => :'String',
+        :'result_data' => :'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?(:'id')
+        self.id = attributes[:'id']
+      end
+
+      if attributes.has_key?(:'integration_id')
+        self.integration_id = attributes[:'integration_id']
+      end
+
+      if attributes.has_key?(:'state')
+        self.state = attributes[:'state']
+      end
+
+      if attributes.has_key?(:'action_category')
+        self.action_category = attributes[:'action_category']
+      end
+
+      if attributes.has_key?(:'action_type')
+        self.action_type = attributes[:'action_type']
+      end
+
+      if attributes.has_key?(:'result_data')
+        self.result_data = attributes[:'result_data']
+      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 @id.nil?
+        invalid_properties.push('invalid value for "id", id cannot be nil.')
+      end
+
+      if @integration_id.nil?
+        invalid_properties.push('invalid value for "integration_id", integration_id cannot be nil.')
+      end
+
+      if @state.nil?
+        invalid_properties.push('invalid value for "state", state cannot be nil.')
+      end
+
+      if @action_category.nil?
+        invalid_properties.push('invalid value for "action_category", action_category cannot be nil.')
+      end
+
+      if @action_type.nil?
+        invalid_properties.push('invalid value for "action_type", action_type cannot be nil.')
+      end
+
+      if @result_data.nil?
+        invalid_properties.push('invalid value for "result_data", result_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 @id.nil?
+      return false if @integration_id.nil?
+      return false if @state.nil?
+      state_validator = EnumAttributeValidator.new('String', ['pending', 'processed', 'failed', 'error'])
+      return false unless state_validator.valid?(@state)
+      return false if @action_category.nil?
+      action_category_validator = EnumAttributeValidator.new('String', ['notification', 'file_upload'])
+      return false unless action_category_validator.valid?(@action_category)
+      return false if @action_type.nil?
+      action_type_validator = EnumAttributeValidator.new('String', ['webhook', 'slack_webhook', 'email', 'aws_s3_upload'])
+      return false unless action_type_validator.valid?(@action_type)
+      return false if @result_data.nil?
+      true
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] state Object to be assigned
+    def state=(state)
+      validator = EnumAttributeValidator.new('String', ['pending', 'processed', 'failed', 'error'])
+      unless validator.valid?(state)
+        fail ArgumentError, 'invalid value for "state", must be one of #{validator.allowable_values}.'
+      end
+      @state = state
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] action_category Object to be assigned
+    def action_category=(action_category)
+      validator = EnumAttributeValidator.new('String', ['notification', 'file_upload'])
+      unless validator.valid?(action_category)
+        fail ArgumentError, 'invalid value for "action_category", must be one of #{validator.allowable_values}.'
+      end
+      @action_category = action_category
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] action_type Object to be assigned
+    def action_type=(action_type)
+      validator = EnumAttributeValidator.new('String', ['webhook', 'slack_webhook', 'email', 'aws_s3_upload'])
+      unless validator.valid?(action_type)
+        fail ArgumentError, 'invalid value for "action_type", must be one of #{validator.allowable_values}.'
+      end
+      @action_type = action_type
+    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 &&
+          id == o.id &&
+          integration_id == o.integration_id &&
+          state == o.state &&
+          action_category == o.action_category &&
+          action_type == o.action_type &&
+          result_data == o.result_data
+    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
+      [id, integration_id, state, action_category, action_type, result_data].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/{template1.rb → pending_template.rb}

@@ -13,7 +13,7 @@ OpenAPI Generator version: 3.3.0-SNAPSHOT
 require 'date'
 
 module FormAPI
-  class Template1
+  class PendingTemplate
     attr_accessor :expiration_interval
 
     attr_accessor :webhook_url

data/lib/form_api/models/submission.rb

@@ -34,6 +34,8 @@ module FormAPI
 
     attr_accessor :data_requests
 
+    attr_accessor :actions
+
     class EnumAttributeValidator
       attr_reader :datatype
       attr_reader :allowable_values
@@ -68,7 +70,8 @@ module FormAPI
         :'metadata' => :'metadata',
         :'download_url' => :'download_url',
         :'batch_id' => :'batch_id',
-        :'data_requests' => :'data_requests'
+        :'data_requests' => :'data_requests',
+        :'actions' => :'actions'
       }
     end
 
@@ -84,7 +87,8 @@ module FormAPI
         :'metadata' => :'Object',
         :'download_url' => :'String',
         :'batch_id' => :'String',
-        :'data_requests' => :'Array<SubmissionDataRequest>'
+        :'data_requests' => :'Array<SubmissionDataRequest>',
+        :'actions' => :'Array<SubmissionAction>'
       }
     end
 
@@ -137,6 +141,12 @@ module FormAPI
           self.data_requests = value
         end
       end
+
+      if attributes.has_key?(:'actions')
+        if (value = attributes[:'actions']).is_a?(Array)
+          self.actions = value
+        end
+      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -198,7 +208,8 @@ module FormAPI
           metadata == o.metadata &&
           download_url == o.download_url &&
           batch_id == o.batch_id &&
-          data_requests == o.data_requests
+          data_requests == o.data_requests &&
+          actions == o.actions
     end
 
     # @see the `==` method
@@ -210,7 +221,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, data_requests].hash
+      [id, test, expired, expires_at, processed_at, state, metadata, download_url, batch_id, data_requests, actions].hash
     end
 
     # Builds the object from hash

data/lib/form_api/models/submission_action.rb

@@ -0,0 +1,316 @@
+=begin
+#API v1
+
+#FormAPI is a service that helps you fill out and sign PDF templates.
+
+OpenAPI spec version: v1
+
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 3.3.0-SNAPSHOT
+
+=end
+
+require 'date'
+
+module FormAPI
+  class SubmissionAction
+    attr_accessor :id
+
+    attr_accessor :integration_id
+
+    attr_accessor :state
+
+    attr_accessor :action_category
+
+    attr_accessor :action_type
+
+    attr_accessor :result_data
+
+    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
+
+      def valid?(value)
+        !value || allowable_values.include?(value)
+      end
+    end
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'id' => :'id',
+        :'integration_id' => :'integration_id',
+        :'state' => :'state',
+        :'action_category' => :'action_category',
+        :'action_type' => :'action_type',
+        :'result_data' => :'result_data'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :'id' => :'String',
+        :'integration_id' => :'String',
+        :'state' => :'String',
+        :'action_category' => :'String',
+        :'action_type' => :'String',
+        :'result_data' => :'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?(:'id')
+        self.id = attributes[:'id']
+      end
+
+      if attributes.has_key?(:'integration_id')
+        self.integration_id = attributes[:'integration_id']
+      end
+
+      if attributes.has_key?(:'state')
+        self.state = attributes[:'state']
+      end
+
+      if attributes.has_key?(:'action_category')
+        self.action_category = attributes[:'action_category']
+      end
+
+      if attributes.has_key?(:'action_type')
+        self.action_type = attributes[:'action_type']
+      end
+
+      if attributes.has_key?(:'result_data')
+        self.result_data = attributes[:'result_data']
+      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 @id.nil?
+        invalid_properties.push('invalid value for "id", id cannot be nil.')
+      end
+
+      if @integration_id.nil?
+        invalid_properties.push('invalid value for "integration_id", integration_id cannot be nil.')
+      end
+
+      if @state.nil?
+        invalid_properties.push('invalid value for "state", state cannot be nil.')
+      end
+
+      if @action_category.nil?
+        invalid_properties.push('invalid value for "action_category", action_category cannot be nil.')
+      end
+
+      if @action_type.nil?
+        invalid_properties.push('invalid value for "action_type", action_type cannot be nil.')
+      end
+
+      if @result_data.nil?
+        invalid_properties.push('invalid value for "result_data", result_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 @id.nil?
+      return false if @integration_id.nil?
+      return false if @state.nil?
+      state_validator = EnumAttributeValidator.new('String', ['pending', 'processed', 'failed', 'error'])
+      return false unless state_validator.valid?(@state)
+      return false if @action_category.nil?
+      action_category_validator = EnumAttributeValidator.new('String', ['notification', 'file_upload'])
+      return false unless action_category_validator.valid?(@action_category)
+      return false if @action_type.nil?
+      action_type_validator = EnumAttributeValidator.new('String', ['webhook', 'slack_webhook', 'email', 'aws_s3_upload'])
+      return false unless action_type_validator.valid?(@action_type)
+      return false if @result_data.nil?
+      true
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] state Object to be assigned
+    def state=(state)
+      validator = EnumAttributeValidator.new('String', ['pending', 'processed', 'failed', 'error'])
+      unless validator.valid?(state)
+        fail ArgumentError, 'invalid value for "state", must be one of #{validator.allowable_values}.'
+      end
+      @state = state
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] action_category Object to be assigned
+    def action_category=(action_category)
+      validator = EnumAttributeValidator.new('String', ['notification', 'file_upload'])
+      unless validator.valid?(action_category)
+        fail ArgumentError, 'invalid value for "action_category", must be one of #{validator.allowable_values}.'
+      end
+      @action_category = action_category
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] action_type Object to be assigned
+    def action_type=(action_type)
+      validator = EnumAttributeValidator.new('String', ['webhook', 'slack_webhook', 'email', 'aws_s3_upload'])
+      unless validator.valid?(action_type)
+        fail ArgumentError, 'invalid value for "action_type", must be one of #{validator.allowable_values}.'
+      end
+      @action_type = action_type
+    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 &&
+          id == o.id &&
+          integration_id == o.integration_id &&
+          state == o.state &&
+          action_category == o.action_category &&
+          action_type == o.action_type &&
+          result_data == o.result_data
+    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
+      [id, integration_id, state, action_category, action_type, result_data].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/version.rb

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

data/spec/api/pdf_api_spec_original.skipped.rb

@@ -93,7 +93,7 @@ describe 'PDFApi' do
   # @param template_document 
   # @param template_name 
   # @param [Hash] opts the optional parameters
-  # @return [Template1]
+  # @return [PendingTemplate]
   describe 'create_template test' do
     it 'should work' do
       template_document = File.new('/path/to/file') # File | 

data/spec/models/combined_submission_action_spec.rb

@@ -0,0 +1,83 @@
+=begin
+#API v1
+
+#FormAPI is a service that helps you fill out and sign PDF templates.
+
+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::CombinedSubmissionAction
+# Automatically generated by openapi-generator (https://openapi-generator.tech)
+# Please update as you see appropriate
+describe 'CombinedSubmissionAction' do
+  before do
+    # run before each test
+    @instance = FormAPI::CombinedSubmissionAction.new
+  end
+
+  after do
+    # run after each test
+  end
+
+  describe 'test an instance of CombinedSubmissionAction' do
+    it 'should create an instance of CombinedSubmissionAction' do
+      expect(@instance).to be_instance_of(FormAPI::CombinedSubmissionAction)
+    end
+  end
+  describe 'test attribute "id"' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  describe 'test attribute "integration_id"' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  describe 'test attribute "state"' 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', ["pending", "processed", "failed", "error"])
+      # validator.allowable_values.each do |value|
+      #   expect { @instance.state = value }.not_to raise_error
+      # end
+    end
+  end
+
+  describe 'test attribute "action_category"' 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', ["notification", "file_upload"])
+      # validator.allowable_values.each do |value|
+      #   expect { @instance.action_category = value }.not_to raise_error
+      # end
+    end
+  end
+
+  describe 'test attribute "action_type"' 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', ["webhook", "slack_webhook", "email", "aws_s3_upload"])
+      # validator.allowable_values.each do |value|
+      #   expect { @instance.action_type = value }.not_to raise_error
+      # end
+    end
+  end
+
+  describe 'test attribute "result_data"' 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/combined_submission_spec.rb

@@ -78,4 +78,10 @@ describe 'CombinedSubmission' do
     end
   end
 
+  describe 'test attribute "actions"' 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/{template1_spec.rb → pending_template_spec.rb}

@@ -14,22 +14,22 @@ require 'spec_helper'
 require 'json'
 require 'date'
 
-# Unit tests for FormAPI::Template1
+# Unit tests for FormAPI::PendingTemplate
 # Automatically generated by openapi-generator (https://openapi-generator.tech)
 # Please update as you see appropriate
-describe 'Template1' do
+describe 'PendingTemplate' do
   before do
     # run before each test
-    @instance = FormAPI::Template1.new
+    @instance = FormAPI::PendingTemplate.new
   end
 
   after do
     # run after each test
   end
 
-  describe 'test an instance of Template1' do
-    it 'should create an instance of Template1' do
-      expect(@instance).to be_instance_of(FormAPI::Template1)
+  describe 'test an instance of PendingTemplate' do
+    it 'should create an instance of PendingTemplate' do
+      expect(@instance).to be_instance_of(FormAPI::PendingTemplate)
     end
   end
   describe 'test attribute "expiration_interval"' do

data/spec/models/submission_action_spec.rb

@@ -0,0 +1,83 @@
+=begin
+#API v1
+
+#FormAPI is a service that helps you fill out and sign PDF templates.
+
+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::SubmissionAction
+# Automatically generated by openapi-generator (https://openapi-generator.tech)
+# Please update as you see appropriate
+describe 'SubmissionAction' do
+  before do
+    # run before each test
+    @instance = FormAPI::SubmissionAction.new
+  end
+
+  after do
+    # run after each test
+  end
+
+  describe 'test an instance of SubmissionAction' do
+    it 'should create an instance of SubmissionAction' do
+      expect(@instance).to be_instance_of(FormAPI::SubmissionAction)
+    end
+  end
+  describe 'test attribute "id"' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  describe 'test attribute "integration_id"' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  describe 'test attribute "state"' 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', ["pending", "processed", "failed", "error"])
+      # validator.allowable_values.each do |value|
+      #   expect { @instance.state = value }.not_to raise_error
+      # end
+    end
+  end
+
+  describe 'test attribute "action_category"' 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', ["notification", "file_upload"])
+      # validator.allowable_values.each do |value|
+      #   expect { @instance.action_category = value }.not_to raise_error
+      # end
+    end
+  end
+
+  describe 'test attribute "action_type"' 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', ["webhook", "slack_webhook", "email", "aws_s3_upload"])
+      # validator.allowable_values.each do |value|
+      #   expect { @instance.action_type = value }.not_to raise_error
+      # end
+    end
+  end
+
+  describe 'test attribute "result_data"' 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

@@ -96,4 +96,10 @@ describe 'Submission' do
     end
   end
 
+  describe 'test attribute "actions"' 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.4.1
+  version: 1.5.0
 platform: ruby
 authors:
 - Form Applications, Inc.
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-12-02 00:00:00.000000000 Z
+date: 2018-12-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: typhoeus
@@ -235,6 +235,7 @@ files:
 - docs/AuthenticationError.md
 - docs/AuthenticationSuccessResponse.md
 - docs/CombinedSubmission.md
+- docs/CombinedSubmissionAction.md
 - docs/CombinedSubmissionData.md
 - docs/CreateCombinedSubmissionResponse.md
 - docs/CreateSubmissionBatchResponse.md
@@ -249,12 +250,13 @@ files:
 - docs/Error.md
 - docs/InvalidRequest.md
 - docs/PDFApi.md
+- docs/PendingTemplate.md
 - docs/Submission.md
+- docs/SubmissionAction.md
 - docs/SubmissionBatch.md
 - docs/SubmissionBatchData.md
 - docs/SubmissionDataRequest.md
 - docs/Template.md
-- docs/Template1.md
 - docs/UpdateDataRequestResponse.md
 - docs/UpdateSubmissionDataRequestData.md
 - form_api.gemspec
@@ -268,6 +270,7 @@ files:
 - lib/form_api/models/authentication_error.rb
 - lib/form_api/models/authentication_success_response.rb
 - lib/form_api/models/combined_submission.rb
+- lib/form_api/models/combined_submission_action.rb
 - lib/form_api/models/combined_submission_data.rb
 - lib/form_api/models/create_combined_submission_response.rb
 - lib/form_api/models/create_submission_batch_response.rb
@@ -281,12 +284,13 @@ files:
 - lib/form_api/models/create_submission_response.rb
 - lib/form_api/models/error.rb
 - lib/form_api/models/invalid_request.rb
+- lib/form_api/models/pending_template.rb
 - lib/form_api/models/submission.rb
+- lib/form_api/models/submission_action.rb
 - 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/template.rb
-- lib/form_api/models/template1.rb
 - lib/form_api/models/update_data_request_response.rb
 - lib/form_api/models/update_submission_data_request_data.rb
 - lib/form_api/version.rb
@@ -297,6 +301,7 @@ files:
 - spec/configuration_spec.rb
 - spec/models/authentication_error_spec.rb
 - spec/models/authentication_success_response_spec.rb
+- spec/models/combined_submission_action_spec.rb
 - spec/models/combined_submission_data_spec.rb
 - spec/models/combined_submission_spec.rb
 - spec/models/create_combined_submission_response_spec.rb
@@ -311,11 +316,12 @@ files:
 - spec/models/create_submission_response_spec.rb
 - spec/models/error_spec.rb
 - spec/models/invalid_request_spec.rb
+- spec/models/pending_template_spec.rb
+- spec/models/submission_action_spec.rb
 - spec/models/submission_batch_data_spec.rb
 - spec/models/submission_batch_spec.rb
 - spec/models/submission_data_request_spec.rb
 - spec/models/submission_spec.rb
-- spec/models/template1_spec.rb
 - spec/models/template_spec.rb
 - spec/models/update_data_request_response_spec.rb
 - spec/models/update_submission_data_request_data_spec.rb
@@ -352,6 +358,7 @@ test_files:
 - spec/configuration_spec.rb
 - spec/models/authentication_error_spec.rb
 - spec/models/authentication_success_response_spec.rb
+- spec/models/combined_submission_action_spec.rb
 - spec/models/combined_submission_data_spec.rb
 - spec/models/combined_submission_spec.rb
 - spec/models/create_combined_submission_response_spec.rb
@@ -366,11 +373,12 @@ test_files:
 - spec/models/create_submission_response_spec.rb
 - spec/models/error_spec.rb
 - spec/models/invalid_request_spec.rb
+- spec/models/pending_template_spec.rb
+- spec/models/submission_action_spec.rb
 - spec/models/submission_batch_data_spec.rb
 - spec/models/submission_batch_spec.rb
 - spec/models/submission_data_request_spec.rb
 - spec/models/submission_spec.rb
-- spec/models/template1_spec.rb
 - spec/models/template_spec.rb
 - spec/models/update_data_request_response_spec.rb
 - spec/models/update_submission_data_request_data_spec.rb