form_api 1.9.1 → 1.11.0

data/lib/form_api/models/rename_folder_data.rb

@@ -0,0 +1,188 @@
+=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 RenameFolderData
+    attr_accessor :name
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'name' => :'name'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :'name' => :'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?(:'name')
+        self.name = attributes[:'name']
+      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 @name.nil?
+        invalid_properties.push('invalid value for "name", name 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 @name.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 &&
+          name == o.name
+    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
+      [name].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/submission.rb

@@ -195,7 +195,7 @@ module FormAPI
       return false if @test.nil?
       return false if @expired.nil?
       return false if @state.nil?
-      state_validator = EnumAttributeValidator.new('String', ['pending', 'processed', 'invalid_data', 'error', 'image_download_failed', 'image_processing_failed', 'waiting_for_data_requests', 'liquid_syntax_error', 'account_suspended', 'license_revoked'])
+      state_validator = EnumAttributeValidator.new('String', ['pending', 'processed', 'invalid_data', 'error', 'image_download_failed', 'image_processing_failed', 'waiting_for_data_requests', 'syntax_error', 'account_suspended', 'license_revoked'])
       return false unless state_validator.valid?(@state)
       true
     end
@@ -203,7 +203,7 @@ module FormAPI
     # Custom attribute writer method checking allowed values (enum).
     # @param [Object] state Object to be assigned
     def state=(state)
-      validator = EnumAttributeValidator.new('String', ['pending', 'processed', 'invalid_data', 'error', 'image_download_failed', 'image_processing_failed', 'waiting_for_data_requests', 'liquid_syntax_error', 'account_suspended', 'license_revoked'])
+      validator = EnumAttributeValidator.new('String', ['pending', 'processed', 'invalid_data', 'error', 'image_download_failed', 'image_processing_failed', 'waiting_for_data_requests', 'syntax_error', 'account_suspended', 'license_revoked'])
       unless validator.valid?(state)
         fail ArgumentError, 'invalid value for "state", must be one of #{validator.allowable_values}.'
       end

data/lib/form_api/models/template.rb

@@ -18,6 +18,8 @@ module FormAPI
 
     attr_accessor :webhook_url
 
+    attr_accessor :parent_folder_id
+
     attr_accessor :expire_after
 
     attr_accessor :allow_additional_properties
@@ -26,6 +28,8 @@ module FormAPI
 
     attr_accessor :slack_webhook_url
 
+    attr_accessor :path
+
     attr_accessor :public_web_form
 
     attr_accessor :editable_submissions
@@ -34,6 +38,8 @@ module FormAPI
 
     attr_accessor :name
 
+    attr_accessor :permanent_document_url
+
     attr_accessor :template_type
 
     attr_accessor :id
@@ -42,6 +48,8 @@ module FormAPI
 
     attr_accessor :redirect_url
 
+    attr_accessor :document_url
+
     class EnumAttributeValidator
       attr_reader :datatype
       attr_reader :allowable_values
@@ -69,18 +77,22 @@ module FormAPI
       {
         :'expiration_interval' => :'expiration_interval',
         :'webhook_url' => :'webhook_url',
+        :'parent_folder_id' => :'parent_folder_id',
         :'expire_after' => :'expire_after',
         :'allow_additional_properties' => :'allow_additional_properties',
         :'public_submissions' => :'public_submissions',
         :'slack_webhook_url' => :'slack_webhook_url',
+        :'path' => :'path',
         :'public_web_form' => :'public_web_form',
         :'editable_submissions' => :'editable_submissions',
         :'expire_submissions' => :'expire_submissions',
         :'name' => :'name',
+        :'permanent_document_url' => :'permanent_document_url',
         :'template_type' => :'template_type',
         :'id' => :'id',
         :'page_dimensions' => :'page_dimensions',
-        :'redirect_url' => :'redirect_url'
+        :'redirect_url' => :'redirect_url',
+        :'document_url' => :'document_url'
       }
     end
 
@@ -89,18 +101,22 @@ module FormAPI
       {
         :'expiration_interval' => :'String',
         :'webhook_url' => :'String',
+        :'parent_folder_id' => :'String',
         :'expire_after' => :'Float',
         :'allow_additional_properties' => :'BOOLEAN',
         :'public_submissions' => :'BOOLEAN',
         :'slack_webhook_url' => :'String',
+        :'path' => :'String',
         :'public_web_form' => :'BOOLEAN',
         :'editable_submissions' => :'BOOLEAN',
         :'expire_submissions' => :'BOOLEAN',
         :'name' => :'String',
+        :'permanent_document_url' => :'String',
         :'template_type' => :'String',
         :'id' => :'String',
         :'page_dimensions' => :'Array<Array<Float>>',
-        :'redirect_url' => :'String'
+        :'redirect_url' => :'String',
+        :'document_url' => :'String'
       }
     end
 
@@ -120,6 +136,10 @@ module FormAPI
         self.webhook_url = attributes[:'webhook_url']
       end
 
+      if attributes.has_key?(:'parent_folder_id')
+        self.parent_folder_id = attributes[:'parent_folder_id']
+      end
+
       if attributes.has_key?(:'expire_after')
         self.expire_after = attributes[:'expire_after']
       end
@@ -136,6 +156,10 @@ module FormAPI
         self.slack_webhook_url = attributes[:'slack_webhook_url']
       end
 
+      if attributes.has_key?(:'path')
+        self.path = attributes[:'path']
+      end
+
       if attributes.has_key?(:'public_web_form')
         self.public_web_form = attributes[:'public_web_form']
       end
@@ -152,6 +176,10 @@ module FormAPI
         self.name = attributes[:'name']
       end
 
+      if attributes.has_key?(:'permanent_document_url')
+        self.permanent_document_url = attributes[:'permanent_document_url']
+      end
+
       if attributes.has_key?(:'template_type')
         self.template_type = attributes[:'template_type']
       end
@@ -169,6 +197,10 @@ module FormAPI
       if attributes.has_key?(:'redirect_url')
         self.redirect_url = attributes[:'redirect_url']
       end
+
+      if attributes.has_key?(:'document_url')
+        self.document_url = attributes[:'document_url']
+      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -203,18 +235,22 @@ module FormAPI
       self.class == o.class &&
           expiration_interval == o.expiration_interval &&
           webhook_url == o.webhook_url &&
+          parent_folder_id == o.parent_folder_id &&
           expire_after == o.expire_after &&
           allow_additional_properties == o.allow_additional_properties &&
           public_submissions == o.public_submissions &&
           slack_webhook_url == o.slack_webhook_url &&
+          path == o.path &&
           public_web_form == o.public_web_form &&
           editable_submissions == o.editable_submissions &&
           expire_submissions == o.expire_submissions &&
           name == o.name &&
+          permanent_document_url == o.permanent_document_url &&
           template_type == o.template_type &&
           id == o.id &&
           page_dimensions == o.page_dimensions &&
-          redirect_url == o.redirect_url
+          redirect_url == o.redirect_url &&
+          document_url == o.document_url
     end
 
     # @see the `==` method
@@ -226,7 +262,7 @@ module FormAPI
     # 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, public_web_form, editable_submissions, expire_submissions, name, template_type, id, page_dimensions, redirect_url].hash
+      [expiration_interval, webhook_url, parent_folder_id, expire_after, allow_additional_properties, public_submissions, slack_webhook_url, path, public_web_form, editable_submissions, expire_submissions, name, permanent_document_url, template_type, id, page_dimensions, redirect_url, document_url].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.9.1'
+  VERSION = '1.11.0'
 end

data/spec/api/pdf_api_spec_original.skipped.rb

@@ -112,17 +112,33 @@ describe 'PDFApi' do
       expect(result).to_not be_nil
     end
   end
+  # integration tests for create_folder
+  # Create a folder
+  # @param create_folder_data 
+  # @param [Hash] opts the optional parameters
+  # @return [Folder]
+  describe 'create_folder test' do
+    it 'should work' do
+      create_folder_data = FormAPI::CreateFolderData.new # CreateFolderData | 
+      result = api_instance.create_folder(create_folder_data)
+      expect(result).to_not be_nil
+    end
+  end
   # integration tests for create_template
   # Upload a new PDF template with a file upload
   # @param template_document 
   # @param template_name 
   # @param [Hash] opts the optional parameters
+  # @option opts [String] :template_parent_folder_id 
   # @return [PendingTemplate]
   describe 'create_template test' do
     it 'should work' do
       template_document = File.new('/path/to/file') # File | 
       template_name = 'template_name_example' # String | 
-      result = api_instance.create_template(template_document, template_name)
+      opts = {
+        template_parent_folder_id: 'template_parent_folder_id_example' # String | 
+      }
+      result = api_instance.create_template(template_document, template_name, opts)
       expect(result).to_not be_nil
     end
   end
@@ -138,6 +154,18 @@ describe 'PDFApi' do
       expect(result).to_not be_nil
     end
   end
+  # integration tests for delete_folder
+  # Delete a folder
+  # @param folder_id 
+  # @param [Hash] opts the optional parameters
+  # @return [Folder]
+  describe 'delete_folder test' do
+    it 'should work' do
+      folder_id = 'fld_000000000000000001' # String | 
+      result = api_instance.delete_folder(folder_id)
+      expect(result).to_not be_nil
+    end
+  end
   # integration tests for expire_combined_submission
   # Expire a combined submission
   # @param combined_submission_id 
@@ -243,13 +271,13 @@ describe 'PDFApi' do
     end
   end
   # integration tests for get_template
-  # Check the status of an uploaded template
+  # Get a single template
   # @param template_id 
   # @param [Hash] opts the optional parameters
   # @return [Template]
   describe 'get_template test' do
     it 'should work' do
-      template_id = 'tpl_000000000000000001' # String | 
+      template_id = 'tpl_000000000000000011' # String | 
       result = api_instance.get_template(template_id)
       expect(result).to_not be_nil
     end
@@ -266,10 +294,25 @@ describe 'PDFApi' do
       expect(result).to_not be_nil
     end
   end
+  # integration tests for list_folders
+  # Get a list of all folders
+  # @param [Hash] opts the optional parameters
+  # @option opts [String] :parent_folder_id Filter By Folder Id
+  # @return [Array<Folder>]
+  describe 'list_folders test' do
+    it 'should work' do
+      opts = {
+        parent_folder_id: 'fld_000000000000000002' # String | Filter By Folder Id
+      }
+      result = api_instance.list_folders(opts)
+      expect(result).to_not be_nil
+    end
+  end
   # integration tests for list_templates
   # Get a list of all templates
   # @param [Hash] opts the optional parameters
   # @option opts [String] :query Search By Name
+  # @option opts [String] :parent_folder_id Filter By Folder Id
   # @option opts [Integer] :page Default: 1
   # @option opts [Integer] :per_page Default: 50
   # @return [Array<Template>]
@@ -277,6 +320,7 @@ describe 'PDFApi' do
     it 'should work' do
       opts = {
         query: '2', # String | Search By Name
+        parent_folder_id: 'fld_000000000000000001', # String | Filter By Folder Id
         page: 2, # Integer | Default: 1
         per_page: 1 # Integer | Default: 50
       }
@@ -284,6 +328,48 @@ describe 'PDFApi' do
       expect(result).to_not be_nil
     end
   end
+  # integration tests for move_folder_to_folder
+  # Move a folder
+  # @param folder_id 
+  # @param move_folder_data 
+  # @param [Hash] opts the optional parameters
+  # @return [Folder]
+  describe 'move_folder_to_folder test' do
+    it 'should work' do
+      folder_id = 'fld_000000000000000001' # String | 
+      move_folder_data = FormAPI::MoveFolderData.new # MoveFolderData | 
+      result = api_instance.move_folder_to_folder(folder_id, move_folder_data)
+      expect(result).to_not be_nil
+    end
+  end
+  # integration tests for move_template_to_folder
+  # Move Template to folder
+  # @param template_id 
+  # @param move_template_data 
+  # @param [Hash] opts the optional parameters
+  # @return [Template]
+  describe 'move_template_to_folder test' do
+    it 'should work' do
+      template_id = 'tpl_000000000000000001' # String | 
+      move_template_data = FormAPI::MoveTemplateData.new # MoveTemplateData | 
+      result = api_instance.move_template_to_folder(template_id, move_template_data)
+      expect(result).to_not be_nil
+    end
+  end
+  # integration tests for rename_folder
+  # Rename a folder
+  # @param folder_id 
+  # @param rename_folder_data 
+  # @param [Hash] opts the optional parameters
+  # @return [nil]
+  describe 'rename_folder test' do
+    it 'should work' do
+      folder_id = 'fld_000000000000000001' # String | 
+      rename_folder_data = FormAPI::RenameFolderData.new # RenameFolderData | 
+      api_instance.rename_folder(folder_id, rename_folder_data)
+      expect(result).to_not be_nil
+    end
+  end
   # integration tests for test_authentication
   # Test Authentication
   # @param [Hash] opts the optional parameters