form_api 0.1.5 → 0.2.0

data/lib/form_api/models/inline_response_200_1.rb

@@ -0,0 +1,400 @@
+=begin
+#API V1
+
+#No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
+
+OpenAPI spec version: v1
+
+Generated by: https://github.com/swagger-api/swagger-codegen.git
+Swagger Codegen version: 2.3.0-SNAPSHOT
+
+=end
+
+require 'date'
+
+module FormAPI
+
+  class InlineResponse2001
+    attr_accessor :id
+
+    attr_accessor :name
+
+    attr_accessor :template_type
+
+    attr_accessor :public_web_form
+
+    attr_accessor :public_submissions
+
+    attr_accessor :expire_submissions
+
+    attr_accessor :expire_after
+
+    attr_accessor :expiration_interval
+
+    attr_accessor :allow_additional_properties
+
+    attr_accessor :page_dimensions
+
+    attr_accessor :webhook_url
+
+    attr_accessor :slack_webhook_url
+
+    attr_accessor :redirect_url
+
+    attr_accessor :blockchain_timestamp_verification
+
+    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',
+        :'name' => :'name',
+        :'template_type' => :'template_type',
+        :'public_web_form' => :'public_web_form',
+        :'public_submissions' => :'public_submissions',
+        :'expire_submissions' => :'expire_submissions',
+        :'expire_after' => :'expire_after',
+        :'expiration_interval' => :'expiration_interval',
+        :'allow_additional_properties' => :'allow_additional_properties',
+        :'page_dimensions' => :'page_dimensions',
+        :'webhook_url' => :'webhook_url',
+        :'slack_webhook_url' => :'slack_webhook_url',
+        :'redirect_url' => :'redirect_url',
+        :'blockchain_timestamp_verification' => :'blockchain_timestamp_verification'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.swagger_types
+      {
+        :'id' => :'String',
+        :'name' => :'String',
+        :'template_type' => :'String',
+        :'public_web_form' => :'BOOLEAN',
+        :'public_submissions' => :'BOOLEAN',
+        :'expire_submissions' => :'BOOLEAN',
+        :'expire_after' => :'Float',
+        :'expiration_interval' => :'String',
+        :'allow_additional_properties' => :'BOOLEAN',
+        :'page_dimensions' => :'Array<Array<Float>>',
+        :'webhook_url' => :'String',
+        :'slack_webhook_url' => :'String',
+        :'redirect_url' => :'String',
+        :'blockchain_timestamp_verification' => :'BOOLEAN'
+      }
+    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?(:'name')
+        self.name = attributes[:'name']
+      end
+
+      if attributes.has_key?(:'template_type')
+        self.template_type = attributes[:'template_type']
+      end
+
+      if attributes.has_key?(:'public_web_form')
+        self.public_web_form = attributes[:'public_web_form']
+      end
+
+      if attributes.has_key?(:'public_submissions')
+        self.public_submissions = attributes[:'public_submissions']
+      end
+
+      if attributes.has_key?(:'expire_submissions')
+        self.expire_submissions = attributes[:'expire_submissions']
+      end
+
+      if attributes.has_key?(:'expire_after')
+        self.expire_after = attributes[:'expire_after']
+      end
+
+      if attributes.has_key?(:'expiration_interval')
+        self.expiration_interval = attributes[:'expiration_interval']
+      end
+
+      if attributes.has_key?(:'allow_additional_properties')
+        self.allow_additional_properties = attributes[:'allow_additional_properties']
+      end
+
+      if attributes.has_key?(:'page_dimensions')
+        if (value = attributes[:'page_dimensions']).is_a?(Array)
+          self.page_dimensions = value
+        end
+      end
+
+      if attributes.has_key?(:'webhook_url')
+        self.webhook_url = attributes[:'webhook_url']
+      end
+
+      if attributes.has_key?(:'slack_webhook_url')
+        self.slack_webhook_url = attributes[:'slack_webhook_url']
+      end
+
+      if attributes.has_key?(:'redirect_url')
+        self.redirect_url = attributes[:'redirect_url']
+      end
+
+      if attributes.has_key?(:'blockchain_timestamp_verification')
+        self.blockchain_timestamp_verification = attributes[:'blockchain_timestamp_verification']
+      end
+
+    end
+
+    # Show invalid properties with the reasons. Usually used together with valid?
+    # @return Array for valid properies 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 @name.nil?
+        invalid_properties.push("invalid value for 'name', name cannot be nil.")
+      end
+
+      if @template_type.nil?
+        invalid_properties.push("invalid value for 'template_type', template_type cannot be nil.")
+      end
+
+      if @public_web_form.nil?
+        invalid_properties.push("invalid value for 'public_web_form', public_web_form cannot be nil.")
+      end
+
+      if @public_submissions.nil?
+        invalid_properties.push("invalid value for 'public_submissions', public_submissions cannot be nil.")
+      end
+
+      if @expire_submissions.nil?
+        invalid_properties.push("invalid value for 'expire_submissions', expire_submissions cannot be nil.")
+      end
+
+      if @allow_additional_properties.nil?
+        invalid_properties.push("invalid value for 'allow_additional_properties', allow_additional_properties cannot be nil.")
+      end
+
+      if @page_dimensions.nil?
+        invalid_properties.push("invalid value for 'page_dimensions', page_dimensions cannot be nil.")
+      end
+
+      if @webhook_url.nil?
+        invalid_properties.push("invalid value for 'webhook_url', webhook_url cannot be nil.")
+      end
+
+      if @slack_webhook_url.nil?
+        invalid_properties.push("invalid value for 'slack_webhook_url', slack_webhook_url cannot be nil.")
+      end
+
+      if @redirect_url.nil?
+        invalid_properties.push("invalid value for 'redirect_url', redirect_url cannot be nil.")
+      end
+
+      if @blockchain_timestamp_verification.nil?
+        invalid_properties.push("invalid value for 'blockchain_timestamp_verification', blockchain_timestamp_verification cannot be nil.")
+      end
+
+      return 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 @name.nil?
+      return false if @template_type.nil?
+      return false if @public_web_form.nil?
+      return false if @public_submissions.nil?
+      return false if @expire_submissions.nil?
+      expiration_interval_validator = EnumAttributeValidator.new('String', ["minutes", "hours", "days"])
+      return false unless expiration_interval_validator.valid?(@expiration_interval)
+      return false if @allow_additional_properties.nil?
+      return false if @page_dimensions.nil?
+      return false if @webhook_url.nil?
+      return false if @slack_webhook_url.nil?
+      return false if @redirect_url.nil?
+      return false if @blockchain_timestamp_verification.nil?
+      return 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 &&
+          id == o.id &&
+          name == o.name &&
+          template_type == o.template_type &&
+          public_web_form == o.public_web_form &&
+          public_submissions == o.public_submissions &&
+          expire_submissions == o.expire_submissions &&
+          expire_after == o.expire_after &&
+          expiration_interval == o.expiration_interval &&
+          allow_additional_properties == o.allow_additional_properties &&
+          page_dimensions == o.page_dimensions &&
+          webhook_url == o.webhook_url &&
+          slack_webhook_url == o.slack_webhook_url &&
+          redirect_url == o.redirect_url &&
+          blockchain_timestamp_verification == o.blockchain_timestamp_verification
+    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, name, template_type, public_web_form, public_submissions, expire_submissions, expire_after, expiration_interval, allow_additional_properties, page_dimensions, webhook_url, slack_webhook_url, redirect_url, blockchain_timestamp_verification].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.swagger_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/inline_response_201_1.rb

@@ -53,7 +53,7 @@ module FormAPI
     def self.swagger_types
       {
         :'status' => :'String',
-        :'submission' => :'InlineResponse2011Submission'
+        :'submission' => :'TemplatestemplateIdsubmissionsbatchSubmission'
       }
     end
 

data/lib/form_api/models/{inline_response_201_1_submission.rb → templatestemplate_idsubmissionsbatch_submission.rb}

@@ -14,7 +14,7 @@ require 'date'
 
 module FormAPI
 
-  class InlineResponse2011Submission
+  class TemplatestemplateIdsubmissionsbatchSubmission
     attr_accessor :id
 
     attr_accessor :test

data/lib/form_api/version.rb

@@ -11,5 +11,5 @@ Swagger Codegen version: 2.3.0-SNAPSHOT
 =end
 
 module FormAPI
-  VERSION = "0.1.5"
+  VERSION = "0.2.0"
 end

data/lib/form_api.rb

@@ -17,19 +17,21 @@ require 'form_api/version'
 require 'form_api/configuration'
 
 # Models
-require 'form_api/models/data'
-require 'form_api/models/data_1'
+require 'form_api/models/create_combined_submission_body'
+require 'form_api/models/create_submission_batch_body'
+require 'form_api/models/create_submission_body'
 require 'form_api/models/inline_response_200'
+require 'form_api/models/inline_response_200_1'
 require 'form_api/models/inline_response_201'
 require 'form_api/models/inline_response_201_1'
-require 'form_api/models/inline_response_201_1_submission'
 require 'form_api/models/inline_response_201_combined_submission'
 require 'form_api/models/inline_response_400'
 require 'form_api/models/inline_response_401'
 require 'form_api/models/inline_response_422'
+require 'form_api/models/templatestemplate_idsubmissionsbatch_submission'
 
 # APIs
-require File.join(File.dirname(__FILE__), '../extensions/lib/form_api/api/client')
+require 'form_api/api/client'
 
 module FormAPI
   class << self

data/spec/api/pdf_api_spec.rb

@@ -32,11 +32,24 @@ describe 'PDFApi' do
     end
   end
 
+  # unit tests for batch_generate_pdf
+  # Generates multiple PDFs
+  #
+  # @param template_id
+  # @param [Hash] opts the optional parameters
+  # @option opts [Array<CreateSubmissionBatchBody>] :create_submission_batch_body
+  # @return [Array<InlineResponse2011>]
+  describe 'batch_generate_pdf test' do
+    it "should work" do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
   # unit tests for combine_submissions
   # Merge generated PDFs together
-  # 
+  #
   # @param [Hash] opts the optional parameters
-  # @option opts [Data] :data 
+  # @option opts [CreateCombinedSubmissionBody] :create_combined_submission_body
   # @return [InlineResponse201]
   describe 'combine_submissions test' do
     it "should work" do
@@ -46,8 +59,8 @@ describe 'PDFApi' do
 
   # unit tests for expire_combined_submission
   # Expire a combined submission
-  # 
-  # @param combined_submission_id 
+  #
+  # @param combined_submission_id
   # @param [Hash] opts the optional parameters
   # @return [InlineResponse201CombinedSubmission]
   describe 'expire_combined_submission test' do
@@ -58,10 +71,10 @@ describe 'PDFApi' do
 
   # unit tests for expire_submission
   # Expire a PDF submission
-  # 
-  # @param submission_id 
+  #
+  # @param submission_id
   # @param [Hash] opts the optional parameters
-  # @return [InlineResponse2011Submission]
+  # @return [TemplatestemplateIdsubmissionsbatchSubmission]
   describe 'expire_submission test' do
     it "should work" do
       # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
@@ -70,10 +83,10 @@ describe 'PDFApi' do
 
   # unit tests for generate_pdf
   # Generates a new PDF
-  # 
-  # @param template_id 
+  #
+  # @param template_id
   # @param [Hash] opts the optional parameters
-  # @option opts [Data1] :data 
+  # @option opts [CreateSubmissionBody] :create_submission_body
   # @return [InlineResponse2011]
   describe 'generate_pdf test' do
     it "should work" do
@@ -83,8 +96,8 @@ describe 'PDFApi' do
 
   # unit tests for get_combined_submission
   # Check the status of a combined submission (merged PDFs)
-  # 
-  # @param combined_submission_id 
+  #
+  # @param combined_submission_id
   # @param [Hash] opts the optional parameters
   # @return [InlineResponse201CombinedSubmission]
   describe 'get_combined_submission test' do
@@ -95,14 +108,27 @@ describe 'PDFApi' do
 
   # unit tests for get_submission
   # Check the status of a PDF
-  # 
-  # @param submission_id 
+  #
+  # @param submission_id
   # @param [Hash] opts the optional parameters
-  # @return [InlineResponse2011Submission]
+  # @return [TemplatestemplateIdsubmissionsbatchSubmission]
   describe 'get_submission test' do
     it "should work" do
       # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
     end
   end
 
+  # unit tests for get_templates
+  # Get a list of all templates
+  #
+  # @param [Hash] opts the optional parameters
+  # @option opts [Integer] :page Default: 1
+  # @option opts [Integer] :per_page Default: 50
+  # @return [Array<InlineResponse2001>]
+  describe 'get_templates test' do
+    it "should work" do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
 end

data/spec/api_client_spec.rb

@@ -124,7 +124,7 @@ describe FormAPI::ApiClient do
       #api_client = FormAPI::ApiClient.new
       #_model = FormAPI::ModelName.new
       # update the model attribute below
-      #_model.id = 1 
+      #_model.id = 1
       # update the expected value (hash) below
       #expected = {id: 1, name: '', tags: []}
       #expect(api_client.object_to_hash(_model)).to eq(expected)

data/spec/models/{data_spec.rb → create_combined_submission_body_spec.rb}

@@ -14,22 +14,22 @@ require 'spec_helper'
 require 'json'
 require 'date'
 
-# Unit tests for FormAPI::Data
+# Unit tests for FormAPI::CreateCombinedSubmissionBody
 # Automatically generated by swagger-codegen (github.com/swagger-api/swagger-codegen)
 # Please update as you see appropriate
-describe 'Data' do
+describe 'CreateCombinedSubmissionBody' do
   before do
     # run before each test
-    @instance = FormAPI::Data.new
+    @instance = FormAPI::CreateCombinedSubmissionBody.new
   end
 
   after do
     # run after each test
   end
 
-  describe 'test an instance of Data' do
-    it 'should create an instance of Data' do
-      expect(@instance).to be_instance_of(FormAPI::Data)
+  describe 'test an instance of CreateCombinedSubmissionBody' do
+    it 'should create an instance of CreateCombinedSubmissionBody' do
+      expect(@instance).to be_instance_of(FormAPI::CreateCombinedSubmissionBody)
     end
   end
   describe 'test attribute "test"' do

data/spec/models/create_submission_batch_body_spec.rb

@@ -0,0 +1,54 @@
+=begin
+#API V1
+
+#No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
+
+OpenAPI spec version: v1
+
+Generated by: https://github.com/swagger-api/swagger-codegen.git
+Swagger Codegen version: 2.3.0-SNAPSHOT
+
+=end
+
+require 'spec_helper'
+require 'json'
+require 'date'
+
+# Unit tests for FormAPI::CreateSubmissionBatchBody
+# Automatically generated by swagger-codegen (github.com/swagger-api/swagger-codegen)
+# Please update as you see appropriate
+describe 'CreateSubmissionBatchBody' do
+  before do
+    # run before each test
+    @instance = FormAPI::CreateSubmissionBatchBody.new
+  end
+
+  after do
+    # run after each test
+  end
+
+  describe 'test an instance of CreateSubmissionBatchBody' do
+    it 'should create an instance of CreateSubmissionBatchBody' do
+      expect(@instance).to be_instance_of(FormAPI::CreateSubmissionBatchBody)
+    end
+  end
+  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 "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 "metadata"' 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/{data_1_spec.rb → create_submission_body_spec.rb}

@@ -14,22 +14,22 @@ require 'spec_helper'
 require 'json'
 require 'date'
 
-# Unit tests for FormAPI::Data1
+# Unit tests for FormAPI::CreateSubmissionBody
 # Automatically generated by swagger-codegen (github.com/swagger-api/swagger-codegen)
 # Please update as you see appropriate
-describe 'Data1' do
+describe 'CreateSubmissionBody' do
   before do
     # run before each test
-    @instance = FormAPI::Data1.new
+    @instance = FormAPI::CreateSubmissionBody.new
   end
 
   after do
     # run after each test
   end
 
-  describe 'test an instance of Data1' do
-    it 'should create an instance of Data1' do
-      expect(@instance).to be_instance_of(FormAPI::Data1)
+  describe 'test an instance of CreateSubmissionBody' do
+    it 'should create an instance of CreateSubmissionBody' do
+      expect(@instance).to be_instance_of(FormAPI::CreateSubmissionBody)
     end
   end
   describe 'test attribute "test"' do