docspring 3.5.0 → 4.0.0

data/lib/docspring/models/submission_batch_with_submissions.rb

@@ -1,433 +0,0 @@
-=begin
-#DocSpring API
-
-#Use DocSpring's API to programmatically fill out PDF forms, convert HTML to PDFs, merge PDFs, or request legally binding e-signatures. Requests are rate limited per account, and live PDFs use credits: a request over the limit returns 429 with a Retry-After header, and one your credits can't cover returns 402. See [Credits & Rate Limits](https://docspring.com/docs/api-guide/credits-and-rate-limits/).
-
-The version of the OpenAPI document: v1
-
-Generated by: https://openapi-generator.tech
-Generator version: 7.16.0-DOCSPRING
-
-=end
-
-require 'date'
-require 'time'
-
-module DocSpring
-  class SubmissionBatchWithSubmissions
-    attr_accessor :id
-
-    attr_accessor :state
-
-    attr_accessor :metadata
-
-    attr_accessor :processed_at
-
-    attr_accessor :total_count
-
-    attr_accessor :pending_count
-
-    attr_accessor :error_count
-
-    attr_accessor :completion_percentage
-
-    attr_accessor :submissions
-
-    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',
-        :'state' => :'state',
-        :'metadata' => :'metadata',
-        :'processed_at' => :'processed_at',
-        :'total_count' => :'total_count',
-        :'pending_count' => :'pending_count',
-        :'error_count' => :'error_count',
-        :'completion_percentage' => :'completion_percentage',
-        :'submissions' => :'submissions'
-      }
-    end
-
-    # Returns attribute mapping this model knows about
-    def self.acceptable_attribute_map
-      attribute_map
-    end
-
-    # Returns all the JSON keys this model knows about
-    def self.acceptable_attributes
-      acceptable_attribute_map.values
-    end
-
-    # Attribute type mapping.
-    def self.openapi_types
-      {
-        :'id' => :'String',
-        :'state' => :'String',
-        :'metadata' => :'Object',
-        :'processed_at' => :'String',
-        :'total_count' => :'Integer',
-        :'pending_count' => :'Integer',
-        :'error_count' => :'Integer',
-        :'completion_percentage' => :'Float',
-        :'submissions' => :'Array<SubmissionPreview>'
-      }
-    end
-
-    # List of attributes with nullable: true
-    def self.openapi_nullable
-      Set.new([
-        :'id',
-        :'processed_at',
-      ])
-    end
-
-    # Initializes the object
-    # @param [Hash] attributes Model attributes in the form of hash
-    def initialize(attributes = {})
-      if (!attributes.is_a?(Hash))
-        fail ArgumentError, "The input argument (attributes) must be a hash in `DocSpring::SubmissionBatchWithSubmissions` initialize method"
-      end
-
-      # check to see if the attribute exists and convert string to symbol for hash key
-      acceptable_attribute_map = self.class.acceptable_attribute_map
-      attributes = attributes.each_with_object({}) { |(k, v), h|
-        if (!acceptable_attribute_map.key?(k.to_sym))
-          fail ArgumentError, "`#{k}` is not a valid attribute in `DocSpring::SubmissionBatchWithSubmissions`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect
-        end
-        h[k.to_sym] = v
-      }
-
-      if attributes.key?(:'id')
-        self.id = attributes[:'id']
-      else
-        self.id = nil
-      end
-
-      if attributes.key?(:'state')
-        self.state = attributes[:'state']
-      else
-        self.state = nil
-      end
-
-      if attributes.key?(:'metadata')
-        self.metadata = attributes[:'metadata']
-      else
-        self.metadata = nil
-      end
-
-      if attributes.key?(:'processed_at')
-        self.processed_at = attributes[:'processed_at']
-      else
-        self.processed_at = nil
-      end
-
-      if attributes.key?(:'total_count')
-        self.total_count = attributes[:'total_count']
-      else
-        self.total_count = nil
-      end
-
-      if attributes.key?(:'pending_count')
-        self.pending_count = attributes[:'pending_count']
-      else
-        self.pending_count = nil
-      end
-
-      if attributes.key?(:'error_count')
-        self.error_count = attributes[:'error_count']
-      else
-        self.error_count = nil
-      end
-
-      if attributes.key?(:'completion_percentage')
-        self.completion_percentage = attributes[:'completion_percentage']
-      else
-        self.completion_percentage = nil
-      end
-
-      if attributes.key?(:'submissions')
-        if (value = attributes[:'submissions']).is_a?(Array)
-          self.submissions = value
-        end
-      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
-      warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
-      invalid_properties = Array.new
-      if @state.nil?
-        invalid_properties.push('invalid value for "state", state cannot be nil.')
-      end
-
-      if @metadata.nil?
-        invalid_properties.push('invalid value for "metadata", metadata cannot be nil.')
-      end
-
-      if @total_count.nil?
-        invalid_properties.push('invalid value for "total_count", total_count cannot be nil.')
-      end
-
-      if @pending_count.nil?
-        invalid_properties.push('invalid value for "pending_count", pending_count cannot be nil.')
-      end
-
-      if @error_count.nil?
-        invalid_properties.push('invalid value for "error_count", error_count cannot be nil.')
-      end
-
-      if @completion_percentage.nil?
-        invalid_properties.push('invalid value for "completion_percentage", completion_percentage 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?
-      warn '[DEPRECATED] the `valid?` method is obsolete'
-      return false if @state.nil?
-      state_validator = EnumAttributeValidator.new('String', ["pending", "processed", "error"])
-      return false unless state_validator.valid?(@state)
-      return false if @metadata.nil?
-      return false if @total_count.nil?
-      return false if @pending_count.nil?
-      return false if @error_count.nil?
-      return false if @completion_percentage.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", "error"])
-      # build_from_hash accepts enum values this client doesn't know about yet
-      unless defined?(@_skip_enum_validation) || validator.valid?(state)
-        fail ArgumentError, "invalid value for \"state\", must be one of #{validator.allowable_values}."
-      end
-      @state = state
-    end
-
-    # Custom attribute writer method with validation
-    # @param [Object] metadata Value to be assigned
-    def metadata=(metadata)
-      if metadata.nil?
-        fail ArgumentError, 'metadata cannot be nil'
-      end
-
-      @metadata = metadata
-    end
-
-    # Custom attribute writer method with validation
-    # @param [Object] total_count Value to be assigned
-    def total_count=(total_count)
-      if total_count.nil?
-        fail ArgumentError, 'total_count cannot be nil'
-      end
-
-      @total_count = total_count
-    end
-
-    # Custom attribute writer method with validation
-    # @param [Object] pending_count Value to be assigned
-    def pending_count=(pending_count)
-      if pending_count.nil?
-        fail ArgumentError, 'pending_count cannot be nil'
-      end
-
-      @pending_count = pending_count
-    end
-
-    # Custom attribute writer method with validation
-    # @param [Object] error_count Value to be assigned
-    def error_count=(error_count)
-      if error_count.nil?
-        fail ArgumentError, 'error_count cannot be nil'
-      end
-
-      @error_count = error_count
-    end
-
-    # Custom attribute writer method with validation
-    # @param [Object] completion_percentage Value to be assigned
-    def completion_percentage=(completion_percentage)
-      if completion_percentage.nil?
-        fail ArgumentError, 'completion_percentage cannot be nil'
-      end
-
-      @completion_percentage = completion_percentage
-    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 &&
-          state == o.state &&
-          metadata == o.metadata &&
-          processed_at == o.processed_at &&
-          total_count == o.total_count &&
-          pending_count == o.pending_count &&
-          error_count == o.error_count &&
-          completion_percentage == o.completion_percentage &&
-          submissions == o.submissions
-    end
-
-    # @see the `==` method
-    # @param [Object] Object to be compared
-    def eql?(o)
-      self == o
-    end
-
-    # Calculates hash code according to all attributes.
-    # @return [Integer] Hash code
-    def hash
-      [id, state, metadata, processed_at, total_count, pending_count, error_count, completion_percentage, submissions].hash
-    end
-
-    # Builds the object from hash
-    # @param [Hash] attributes Model attributes in the form of hash
-    # @return [Object] Returns the model itself
-    def self.build_from_hash(attributes)
-      return nil unless attributes.is_a?(Hash)
-      attributes = attributes.transform_keys(&:to_sym)
-      transformed_hash = {}
-      openapi_types.each_pair do |key, type|
-        if attributes.key?(attribute_map[key]) && attributes[attribute_map[key]].nil?
-          transformed_hash["#{key}"] = nil
-        elsif type =~ /\AArray<(.*)>/i
-          # check to ensure the input is an array given that the attribute
-          # is documented as an array but the input is not
-          if attributes[attribute_map[key]].is_a?(Array)
-            transformed_hash["#{key}"] = attributes[attribute_map[key]].map { |v| _deserialize($1, v) }
-          end
-        elsif !attributes[attribute_map[key]].nil?
-          transformed_hash["#{key}"] = _deserialize(type, attributes[attribute_map[key]])
-        end
-      end
-      # Responses can include enum values added after this client was released, so the enum setters
-      # accept any value while the model is built from a response
-      allocate.tap do |model|
-        model.instance_variable_set(:@_skip_enum_validation, true)
-        model.send(:initialize, transformed_hash)
-        model.remove_instance_variable(:@_skip_enum_validation)
-      end
-    end
-
-    # Deserializes the data based on type
-    # @param string type Data type
-    # @param string value Value to be deserialized
-    # @return [Object] Deserialized data
-    def self._deserialize(type, value)
-      case type.to_sym
-      when :Time
-        Time.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
-        # models (e.g. Pet) or oneOf
-        klass = DocSpring.const_get(type)
-        klass.respond_to?(:openapi_any_of) || klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.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)
-        if value.nil?
-          is_nullable = self.class.openapi_nullable.include?(attr)
-          next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
-        end
-
-        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