form_api 1.6.0 → 1.7.0

data/lib/form_api/models/{create_submission_data_batch_request.rb → combine_pdfs_data.rb}

@@ -13,40 +13,36 @@ OpenAPI Generator version: 3.3.0-SNAPSHOT
 require 'date'
 
 module FormAPI
-  class CreateSubmissionDataBatchRequest
-    attr_accessor :template_id
-
+  class CombinePdfsData
     attr_accessor :test
 
-    attr_accessor :data
+    attr_accessor :source_pdfs
 
-    attr_accessor :html
+    attr_accessor :metadata
 
-    attr_accessor :css
+    attr_accessor :expires_in
 
-    attr_accessor :metadata
+    attr_accessor :delete_custom_files
 
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
-        :'template_id' => :'template_id',
         :'test' => :'test',
-        :'data' => :'data',
-        :'html' => :'html',
-        :'css' => :'css',
-        :'metadata' => :'metadata'
+        :'source_pdfs' => :'source_pdfs',
+        :'metadata' => :'metadata',
+        :'expires_in' => :'expires_in',
+        :'delete_custom_files' => :'delete_custom_files'
       }
     end
 
     # Attribute type mapping.
     def self.openapi_types
       {
-        :'template_id' => :'String',
         :'test' => :'BOOLEAN',
-        :'data' => :'Object',
-        :'html' => :'String',
-        :'css' => :'String',
-        :'metadata' => :'Object'
+        :'source_pdfs' => :'Array<Object>',
+        :'metadata' => :'Object',
+        :'expires_in' => :'Integer',
+        :'delete_custom_files' => :'BOOLEAN'
       }
     end
 
@@ -58,28 +54,26 @@ module FormAPI
       # convert string to symbol for hash key
       attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }
 
-      if attributes.has_key?(:'template_id')
-        self.template_id = attributes[:'template_id']
-      end
-
       if attributes.has_key?(:'test')
         self.test = attributes[:'test']
       end
 
-      if attributes.has_key?(:'data')
-        self.data = attributes[:'data']
+      if attributes.has_key?(:'source_pdfs')
+        if (value = attributes[:'source_pdfs']).is_a?(Array)
+          self.source_pdfs = value
+        end
       end
 
-      if attributes.has_key?(:'html')
-        self.html = attributes[:'html']
+      if attributes.has_key?(:'metadata')
+        self.metadata = attributes[:'metadata']
       end
 
-      if attributes.has_key?(:'css')
-        self.css = attributes[:'css']
+      if attributes.has_key?(:'expires_in')
+        self.expires_in = attributes[:'expires_in']
       end
 
-      if attributes.has_key?(:'metadata')
-        self.metadata = attributes[:'metadata']
+      if attributes.has_key?(:'delete_custom_files')
+        self.delete_custom_files = attributes[:'delete_custom_files']
       end
     end
 
@@ -87,12 +81,8 @@ module FormAPI
     # @return Array for valid properties with the reasons
     def list_invalid_properties
       invalid_properties = Array.new
-      if @template_id.nil?
-        invalid_properties.push('invalid value for "template_id", template_id cannot be nil.')
-      end
-
-      if @data.nil?
-        invalid_properties.push('invalid value for "data", data cannot be nil.')
+      if @source_pdfs.nil?
+        invalid_properties.push('invalid value for "source_pdfs", source_pdfs cannot be nil.')
       end
 
       invalid_properties
@@ -101,8 +91,7 @@ module FormAPI
     # 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 @template_id.nil?
-      return false if @data.nil?
+      return false if @source_pdfs.nil?
       true
     end
 
@@ -111,12 +100,11 @@ module FormAPI
     def ==(o)
       return true if self.equal?(o)
       self.class == o.class &&
-          template_id == o.template_id &&
           test == o.test &&
-          data == o.data &&
-          html == o.html &&
-          css == o.css &&
-          metadata == o.metadata
+          source_pdfs == o.source_pdfs &&
+          metadata == o.metadata &&
+          expires_in == o.expires_in &&
+          delete_custom_files == o.delete_custom_files
     end
 
     # @see the `==` method
@@ -128,7 +116,7 @@ module FormAPI
     # Calculates hash code according to all attributes.
     # @return [Fixnum] Hash code
     def hash
-      [template_id, test, data, html, css, metadata].hash
+      [test, source_pdfs, metadata, expires_in, delete_custom_files].hash
     end
 
     # Builds the object from hash

data/lib/form_api/models/combined_submission.rb

@@ -20,6 +20,8 @@ module FormAPI
 
     attr_accessor :expires_at
 
+    attr_accessor :source_pdfs
+
     attr_accessor :download_url
 
     attr_accessor :submission_ids
@@ -58,6 +60,7 @@ module FormAPI
         :'metadata' => :'metadata',
         :'expired' => :'expired',
         :'expires_at' => :'expires_at',
+        :'source_pdfs' => :'source_pdfs',
         :'download_url' => :'download_url',
         :'submission_ids' => :'submission_ids',
         :'id' => :'id',
@@ -72,6 +75,7 @@ module FormAPI
         :'metadata' => :'Object',
         :'expired' => :'BOOLEAN',
         :'expires_at' => :'String',
+        :'source_pdfs' => :'Array<Object>',
         :'download_url' => :'String',
         :'submission_ids' => :'Array<String>',
         :'id' => :'String',
@@ -100,6 +104,12 @@ module FormAPI
         self.expires_at = attributes[:'expires_at']
       end
 
+      if attributes.has_key?(:'source_pdfs')
+        if (value = attributes[:'source_pdfs']).is_a?(Array)
+          self.source_pdfs = value
+        end
+      end
+
       if attributes.has_key?(:'download_url')
         self.download_url = attributes[:'download_url']
       end
@@ -158,6 +168,7 @@ module FormAPI
           metadata == o.metadata &&
           expired == o.expired &&
           expires_at == o.expires_at &&
+          source_pdfs == o.source_pdfs &&
           download_url == o.download_url &&
           submission_ids == o.submission_ids &&
           id == o.id &&
@@ -174,7 +185,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, actions].hash
+      [metadata, expired, expires_at, source_pdfs, download_url, submission_ids, id, state, actions].hash
     end
 
     # Builds the object from hash

data/lib/form_api/models/create_custom_file_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 CreateCustomFileData
+    attr_accessor :cache_id
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'cache_id' => :'cache_id'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :'cache_id' => :'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?(:'cache_id')
+        self.cache_id = attributes[:'cache_id']
+      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 @cache_id.nil?
+        invalid_properties.push('invalid value for "cache_id", cache_id 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 @cache_id.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 &&
+          cache_id == o.cache_id
+    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
+      [cache_id].hash
+    end
+
+    # Builds the object from hash
+    # @param [Hash] attributes Model attributes in the form of hash
+    # @return [Object] Returns the model itself
+    def build_from_hash(attributes)
+      return nil unless attributes.is_a?(Hash)
+      self.class.openapi_types.each_pair do |key, type|
+        if type =~ /\AArray<(.*)>/i
+          # check to ensure the input is an array given that the the attribute
+          # is documented as an array but the input is not
+          if attributes[self.class.attribute_map[key]].is_a?(Array)
+            self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
+          end
+        elsif !attributes[self.class.attribute_map[key]].nil?
+          self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
+        end # or else data not found in attributes(hash), not an issue as the data can be optional
+      end
+
+      self
+    end
+
+    # Deserializes the data based on type
+    # @param string type Data type
+    # @param string value Value to be deserialized
+    # @return [Object] Deserialized data
+    def _deserialize(type, value)
+      case type.to_sym
+      when :DateTime
+        DateTime.parse(value)
+      when :Date
+        Date.parse(value)
+      when :String
+        value.to_s
+      when :Integer
+        value.to_i
+      when :Float
+        value.to_f
+      when :BOOLEAN
+        if value.to_s =~ /\A(true|t|yes|y|1)\z/i
+          true
+        else
+          false
+        end
+      when :Object
+        # generic object (usually a Hash), return directly
+        value
+      when /\AArray<(?<inner_type>.+)>\z/
+        inner_type = Regexp.last_match[:inner_type]
+        value.map { |v| _deserialize(inner_type, v) }
+      when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
+        k_type = Regexp.last_match[:k_type]
+        v_type = Regexp.last_match[:v_type]
+        {}.tap do |hash|
+          value.each do |k, v|
+            hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
+          end
+        end
+      else # model
+        temp_model = FormAPI.const_get(type).new
+        temp_model.build_from_hash(value)
+      end
+    end
+
+    # Returns the string representation of the object
+    # @return [String] String presentation of the object
+    def to_s
+      to_hash.to_s
+    end
+
+    # to_body is an alias to to_hash (backward compatibility)
+    # @return [Hash] Returns the object in the form of hash
+    def to_body
+      to_hash
+    end
+
+    # Returns the object in the form of hash
+    # @return [Hash] Returns the object in the form of hash
+    def to_hash
+      hash = {}
+      self.class.attribute_map.each_pair do |attr, param|
+        value = self.send(attr)
+        next if value.nil?
+        hash[param] = _to_hash(value)
+      end
+      hash
+    end
+
+    # Outputs non-array value in the form of hash
+    # For object, use to_hash. Otherwise, just return the value
+    # @param [Object] value Any valid value
+    # @return [Hash] Returns the value in the form of hash
+    def _to_hash(value)
+      if value.is_a?(Array)
+        value.compact.map { |v| _to_hash(v) }
+      elsif value.is_a?(Hash)
+        {}.tap do |hash|
+          value.each { |k, v| hash[k] = _to_hash(v) }
+        end
+      elsif value.respond_to? :to_hash
+        value.to_hash
+      else
+        value
+      end
+    end
+  end
+end

data/lib/form_api/models/create_custom_file_response.rb

@@ -0,0 +1,237 @@
+=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 CreateCustomFileResponse
+    attr_accessor :custom_file
+
+    attr_accessor :errors
+
+    attr_accessor :status
+
+    class EnumAttributeValidator
+      attr_reader :datatype
+      attr_reader :allowable_values
+
+      def initialize(datatype, allowable_values)
+        @allowable_values = allowable_values.map do |value|
+          case datatype.to_s
+          when /Integer/i
+            value.to_i
+          when /Float/i
+            value.to_f
+          else
+            value
+          end
+        end
+      end
+
+      def valid?(value)
+        !value || allowable_values.include?(value)
+      end
+    end
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'custom_file' => :'custom_file',
+        :'errors' => :'errors',
+        :'status' => :'status'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :'custom_file' => :'CustomFile',
+        :'errors' => :'Array<String>',
+        :'status' => :'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?(:'custom_file')
+        self.custom_file = attributes[:'custom_file']
+      end
+
+      if attributes.has_key?(:'errors')
+        if (value = attributes[:'errors']).is_a?(Array)
+          self.errors = value
+        end
+      end
+
+      if attributes.has_key?(:'status')
+        self.status = attributes[:'status']
+      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?
+      status_validator = EnumAttributeValidator.new('String', ['success', 'error'])
+      return false unless status_validator.valid?(@status)
+      true
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] status Object to be assigned
+    def status=(status)
+      validator = EnumAttributeValidator.new('String', ['success', 'error'])
+      unless validator.valid?(status)
+        fail ArgumentError, 'invalid value for "status", must be one of #{validator.allowable_values}.'
+      end
+      @status = status
+    end
+
+    # Checks equality by comparing each attribute.
+    # @param [Object] Object to be compared
+    def ==(o)
+      return true if self.equal?(o)
+      self.class == o.class &&
+          custom_file == o.custom_file &&
+          errors == o.errors &&
+          status == o.status
+    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
+      [custom_file, errors, status].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