form_api 1.4.0 → 1.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6dd09b3224514218c63ed4c1752f8d815c6532b65c0189e04e67a923e51a003b
-  data.tar.gz: 73e413951e1122745546ba9532f467be904461f2b05cbc0881ea626899540c9f
+  metadata.gz: ef9cd2af9790f6ab86f86c5a8d07f0cef50a92463a73c701a03a2e5fdf70b6d6
+  data.tar.gz: a1b0e7b91094518f686c435c422d52ac5527be96fe31acfbdd761046c46f9141
 SHA512:
-  metadata.gz: b3eb0272496eccf34f371532c6865364982a5e929a403457baa601e334b5d76892de124f9c5ccd60e15f7f14ced8bc4c197e53909a7406b11fac330843497972
-  data.tar.gz: 59fed76f6536c9e371a96d733923e27bc6d2e9660e8cc22682e95529e05ca9bedf63545aa5ac8086e86543bd02c3e235c93cf867cbe3bd49193fe3f9f36b8c64
+  metadata.gz: fc0bc7f68c075fc40a0753a1650125fe700327469844e989761058797987b9d9323a91d9eb693276b38a594e116f684528d2a9a5368fc492f8441aa7035bce4f
+  data.tar.gz: 03bc2be8d1005548d42154060f3d8c409143e6c908846989dcd5fa284ac0c0ce1a6efece34f5b335a250dd46e2eda10f938ed28523aa7f1548143d58c0fbfed2

data/CHANGELOG.md

@@ -0,0 +1,8 @@
+### 1.4.1 [December 2, 2018]
+* Fixed crash in 1.4.0, did not include all of the necessary files
+
+### 1.4.0 [December 1, 2018]
+* Added Create Template, Get Template, and Get Template Schema endpoints
+
+### 1.3.0 [November 4, 2018]
+* Initial changelog

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    form_api (1.4.0)
+    form_api (1.4.1)
       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.0
+- Package version: 1.4.1
 - 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.0.gem
+gem install ./form_api-1.4.1.gem
 ```
-(for development, run `gem install --dev ./form_api-1.4.0.gem` to install the development dependencies)
+(for development, run `gem install --dev ./form_api-1.4.1.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.0'
+    gem 'form_api', '~> 1.4.1'
 
 ### Install from Git
 

data/docs/Template1.md

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

data/lib/form_api/models/template1.rb

@@ -0,0 +1,325 @@
+=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 Template1
+    attr_accessor :expiration_interval
+
+    attr_accessor :webhook_url
+
+    attr_accessor :expire_after
+
+    attr_accessor :allow_additional_properties
+
+    attr_accessor :public_submissions
+
+    attr_accessor :slack_webhook_url
+
+    attr_accessor :blockchain_timestamp_verification
+
+    attr_accessor :public_web_form
+
+    attr_accessor :expire_submissions
+
+    attr_accessor :name
+
+    attr_accessor :template_type
+
+    attr_accessor :id
+
+    attr_accessor :redirect_url
+
+    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
+      {
+        :'expiration_interval' => :'expiration_interval',
+        :'webhook_url' => :'webhook_url',
+        :'expire_after' => :'expire_after',
+        :'allow_additional_properties' => :'allow_additional_properties',
+        :'public_submissions' => :'public_submissions',
+        :'slack_webhook_url' => :'slack_webhook_url',
+        :'blockchain_timestamp_verification' => :'blockchain_timestamp_verification',
+        :'public_web_form' => :'public_web_form',
+        :'expire_submissions' => :'expire_submissions',
+        :'name' => :'name',
+        :'template_type' => :'template_type',
+        :'id' => :'id',
+        :'redirect_url' => :'redirect_url'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :'expiration_interval' => :'String',
+        :'webhook_url' => :'String',
+        :'expire_after' => :'Float',
+        :'allow_additional_properties' => :'BOOLEAN',
+        :'public_submissions' => :'BOOLEAN',
+        :'slack_webhook_url' => :'String',
+        :'blockchain_timestamp_verification' => :'BOOLEAN',
+        :'public_web_form' => :'BOOLEAN',
+        :'expire_submissions' => :'BOOLEAN',
+        :'name' => :'String',
+        :'template_type' => :'String',
+        :'id' => :'String',
+        :'redirect_url' => :'String'
+      }
+    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?(:'expiration_interval')
+        self.expiration_interval = attributes[:'expiration_interval']
+      end
+
+      if attributes.has_key?(:'webhook_url')
+        self.webhook_url = attributes[:'webhook_url']
+      end
+
+      if attributes.has_key?(:'expire_after')
+        self.expire_after = attributes[:'expire_after']
+      end
+
+      if attributes.has_key?(:'allow_additional_properties')
+        self.allow_additional_properties = attributes[:'allow_additional_properties']
+      end
+
+      if attributes.has_key?(:'public_submissions')
+        self.public_submissions = attributes[:'public_submissions']
+      end
+
+      if attributes.has_key?(:'slack_webhook_url')
+        self.slack_webhook_url = attributes[:'slack_webhook_url']
+      end
+
+      if attributes.has_key?(:'blockchain_timestamp_verification')
+        self.blockchain_timestamp_verification = attributes[:'blockchain_timestamp_verification']
+      end
+
+      if attributes.has_key?(:'public_web_form')
+        self.public_web_form = attributes[:'public_web_form']
+      end
+
+      if attributes.has_key?(:'expire_submissions')
+        self.expire_submissions = attributes[:'expire_submissions']
+      end
+
+      if attributes.has_key?(:'name')
+        self.name = attributes[:'name']
+      end
+
+      if attributes.has_key?(:'template_type')
+        self.template_type = attributes[:'template_type']
+      end
+
+      if attributes.has_key?(:'id')
+        self.id = attributes[:'id']
+      end
+
+      if attributes.has_key?(:'redirect_url')
+        self.redirect_url = attributes[:'redirect_url']
+      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
+      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?
+      expiration_interval_validator = EnumAttributeValidator.new('String', ['minutes', 'hours', 'days'])
+      return false unless expiration_interval_validator.valid?(@expiration_interval)
+      true
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] expiration_interval Object to be assigned
+    def expiration_interval=(expiration_interval)
+      validator = EnumAttributeValidator.new('String', ['minutes', 'hours', 'days'])
+      unless validator.valid?(expiration_interval)
+        fail ArgumentError, 'invalid value for "expiration_interval", must be one of #{validator.allowable_values}.'
+      end
+      @expiration_interval = expiration_interval
+    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 &&
+          expiration_interval == o.expiration_interval &&
+          webhook_url == o.webhook_url &&
+          expire_after == o.expire_after &&
+          allow_additional_properties == o.allow_additional_properties &&
+          public_submissions == o.public_submissions &&
+          slack_webhook_url == o.slack_webhook_url &&
+          blockchain_timestamp_verification == o.blockchain_timestamp_verification &&
+          public_web_form == o.public_web_form &&
+          expire_submissions == o.expire_submissions &&
+          name == o.name &&
+          template_type == o.template_type &&
+          id == o.id &&
+          redirect_url == o.redirect_url
+    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
+      [expiration_interval, webhook_url, expire_after, allow_additional_properties, public_submissions, slack_webhook_url, blockchain_timestamp_verification, public_web_form, expire_submissions, name, template_type, id, redirect_url].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.0'
+  VERSION = '1.4.1'
 end

data/spec/models/template1_spec.rb

@@ -0,0 +1,117 @@
+=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::Template1
+# Automatically generated by openapi-generator (https://openapi-generator.tech)
+# Please update as you see appropriate
+describe 'Template1' do
+  before do
+    # run before each test
+    @instance = FormAPI::Template1.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)
+    end
+  end
+  describe 'test attribute "expiration_interval"' 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', ["minutes", "hours", "days"])
+      # validator.allowable_values.each do |value|
+      #   expect { @instance.expiration_interval = value }.not_to raise_error
+      # end
+    end
+  end
+
+  describe 'test attribute "webhook_url"' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  describe 'test attribute "expire_after"' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  describe 'test attribute "allow_additional_properties"' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  describe 'test attribute "public_submissions"' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  describe 'test attribute "slack_webhook_url"' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  describe 'test attribute "blockchain_timestamp_verification"' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  describe 'test attribute "public_web_form"' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  describe 'test attribute "expire_submissions"' 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 "template_type"' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    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 "redirect_url"' 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.0
+  version: 1.4.1
 platform: ruby
 authors:
 - Form Applications, Inc.
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-11-30 00:00:00.000000000 Z
+date: 2018-12-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: typhoeus
@@ -54,42 +54,42 @@ dependencies:
   name: json
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.1'
     - - ">="
       - !ruby/object:Gem::Version
         version: 2.1.0
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.1'
     - - ">="
       - !ruby/object:Gem::Version
         version: 2.1.0
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.6'
     - - ">="
       - !ruby/object:Gem::Version
         version: 3.6.0
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.6'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.6'
     - - ">="
       - !ruby/object:Gem::Version
         version: 3.6.0
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.6'
 - !ruby/object:Gem::Dependency
   name: vcr
   requirement: !ruby/object:Gem::Requirement
@@ -226,6 +226,7 @@ files:
 - ".swagger-codegen/VERSION"
 - ".swagger-revision"
 - ".travis.yml"
+- CHANGELOG.md
 - Gemfile
 - Gemfile.lock
 - LICENSE
@@ -253,6 +254,7 @@ files:
 - docs/SubmissionBatchData.md
 - docs/SubmissionDataRequest.md
 - docs/Template.md
+- docs/Template1.md
 - docs/UpdateDataRequestResponse.md
 - docs/UpdateSubmissionDataRequestData.md
 - form_api.gemspec
@@ -284,6 +286,7 @@ files:
 - 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
@@ -312,6 +315,7 @@ files:
 - 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
@@ -336,7 +340,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.7.6
+rubygems_version: 2.7.8
 signing_key: 
 specification_version: 4
 summary: FormAPI API Client
@@ -366,6 +370,7 @@ test_files:
 - 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