docspring 3.5.0 → 4.1.0

data/lib/docspring/models/template_field_changes.rb

@@ -0,0 +1,274 @@
+=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.
+
+The version of the OpenAPI document: v2
+
+Generated by: https://openapi-generator.tech
+Generator version: 7.26.0-DOCSPRING
+
+=end
+
+require 'date'
+require 'time'
+
+module DocSpring
+  # The fields that changed between two versions of a template.
+  class TemplateFieldChanges < ApiModelBase
+    # The fields that `to_version` has and `from_version` doesn't.
+    attr_accessor :added
+
+    # The fields that `from_version` has and `to_version` doesn't, as they were.
+    attr_accessor :removed
+
+    # The fields with changed settings.
+    attr_accessor :changed
+
+    # The fields that moved in the template's field order (the order of its fields across all its pages, as the fields endpoint lists them): fields that swapped places, or the field that moved the furthest. The fields that a move pushed along aren't listed.
+    attr_accessor :reordered
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'added' => :'added',
+        :'removed' => :'removed',
+        :'changed' => :'changed',
+        :'reordered' => :'reordered'
+      }
+    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
+      {
+        :'added' => :'Array<Field>',
+        :'removed' => :'Array<Field>',
+        :'changed' => :'Array<TemplateFieldChange>',
+        :'reordered' => :'Array<TemplateFieldMove>'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+      ])
+    end
+
+    # Returns attribute type mapping
+    def self.acceptable_openapi_types
+      openapi_types
+    end
+
+    # Returns the nullable attributes
+    def self.acceptable_openapi_nullable
+      openapi_nullable
+    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::TemplateFieldChanges` 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::TemplateFieldChanges`. 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?(:'added')
+        if (value = attributes[:'added']).is_a?(Array)
+          self.added = value
+        end
+      else
+        self.added = nil
+      end
+
+      if attributes.key?(:'removed')
+        if (value = attributes[:'removed']).is_a?(Array)
+          self.removed = value
+        end
+      else
+        self.removed = nil
+      end
+
+      if attributes.key?(:'changed')
+        if (value = attributes[:'changed']).is_a?(Array)
+          self.changed = value
+        end
+      else
+        self.changed = nil
+      end
+
+      if attributes.key?(:'reordered')
+        if (value = attributes[:'reordered']).is_a?(Array)
+          self.reordered = value
+        end
+      else
+        self.reordered = nil
+      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 @added.nil?
+        invalid_properties.push('invalid value for "added", added cannot be nil.')
+      end
+
+      if @removed.nil?
+        invalid_properties.push('invalid value for "removed", removed cannot be nil.')
+      end
+
+      if @changed.nil?
+        invalid_properties.push('invalid value for "changed", changed cannot be nil.')
+      end
+
+      if @reordered.nil?
+        invalid_properties.push('invalid value for "reordered", reordered 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 @added.nil?
+      return false if @removed.nil?
+      return false if @changed.nil?
+      return false if @reordered.nil?
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] added Value to be assigned
+    def added=(added)
+      if added.nil?
+        fail ArgumentError, 'added cannot be nil'
+      end
+
+      @added = added
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] removed Value to be assigned
+    def removed=(removed)
+      if removed.nil?
+        fail ArgumentError, 'removed cannot be nil'
+      end
+
+      @removed = removed
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] changed Value to be assigned
+    def changed=(changed)
+      if changed.nil?
+        fail ArgumentError, 'changed cannot be nil'
+      end
+
+      @changed = changed
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] reordered Value to be assigned
+    def reordered=(reordered)
+      if reordered.nil?
+        fail ArgumentError, 'reordered cannot be nil'
+      end
+
+      @reordered = reordered
+    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 &&
+          added == o.added &&
+          removed == o.removed &&
+          changed == o.changed &&
+          reordered == o.reordered
+    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
+      [added, removed, changed, reordered].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)
+      # include attributes inherited from allOf parents (the nearest declaration wins)
+      map = acceptable_attribute_map
+      transformed_hash = {}
+      acceptable_openapi_types.each_pair do |key, type|
+        if attributes.key?(map[key]) && attributes[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[map[key]].is_a?(Array)
+            transformed_hash["#{key}"] = attributes[map[key]].map { |v| _deserialize($1, v) }
+          end
+        elsif !attributes[map[key]].nil?
+          transformed_hash["#{key}"] = _deserialize(type, attributes[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
+
+    # Returns the object in the form of hash
+    # @return [Hash] Returns the object in the form of hash
+    def to_hash
+      hash = {}
+      # include attributes inherited from allOf parents (the nearest declaration wins)
+      self.class.acceptable_attribute_map.each_pair do |attr, param|
+        value = self.send(attr)
+        if value.nil?
+          is_nullable = self.class.acceptable_openapi_nullable.include?(attr)
+          next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
+        end
+
+        hash[param] = _to_hash(value)
+      end
+      hash
+    end
+
+  end
+
+end

data/lib/docspring/models/{success_error_response.rb → template_field_dependency.rb}

@@ -1,12 +1,12 @@
 =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/).
+#Use DocSpring's API to programmatically fill out PDF forms, convert HTML to PDFs, merge PDFs, or request legally binding e-signatures.
 
-The version of the OpenAPI document: v1
+The version of the OpenAPI document: v2
 
 Generated by: https://openapi-generator.tech
-Generator version: 7.16.0-DOCSPRING
+Generator version: 7.26.0-DOCSPRING
 
 =end
 
@@ -14,10 +14,22 @@ require 'date'
 require 'time'
 
 module DocSpring
-  class SuccessErrorResponse
-    attr_accessor :status
+  # A conditional logic rule: when other fields' values meet its conditions, it shows its target fields, makes them required, or both.
+  class TemplateFieldDependency < ApiModelBase
+    # What the rule does to the fields it applies to when its conditions are met.
+    attr_accessor :action
 
-    attr_accessor :error
+    # Whether all of the conditions (the default) or any of them must be met.
+    attr_accessor :match
+
+    # The conditions on other fields' values.
+    attr_accessor :conditions
+
+    # The names of the fields the rule shows or makes required.
+    attr_accessor :targets
+
+    # Marks a rule made for a field group in the template editor. Its targets outside the group are removed when the template is saved, and the rule is removed once the group has no fields.
+    attr_accessor :group
 
     class EnumAttributeValidator
       attr_reader :datatype
@@ -44,8 +56,11 @@ module DocSpring
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
-        :'status' => :'status',
-        :'error' => :'error'
+        :'action' => :'action',
+        :'match' => :'match',
+        :'conditions' => :'conditions',
+        :'targets' => :'targets',
+        :'group' => :'group'
       }
     end
 
@@ -62,8 +77,11 @@ module DocSpring
     # Attribute type mapping.
     def self.openapi_types
       {
-        :'status' => :'String',
-        :'error' => :'String'
+        :'action' => :'TemplateFieldDependencyAction',
+        :'match' => :'TemplateFieldDependencyMatch',
+        :'conditions' => :'Array<TemplateFieldDependencyCondition>',
+        :'targets' => :'Array<String>',
+        :'group' => :'String'
       }
     end
 
@@ -73,30 +91,60 @@ module DocSpring
       ])
     end
 
+    # Returns attribute type mapping
+    def self.acceptable_openapi_types
+      openapi_types
+    end
+
+    # Returns the nullable attributes
+    def self.acceptable_openapi_nullable
+      openapi_nullable
+    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::SuccessErrorResponse` initialize method"
+        fail ArgumentError, "The input argument (attributes) must be a hash in `DocSpring::TemplateFieldDependency` 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::SuccessErrorResponse`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect
+          fail ArgumentError, "`#{k}` is not a valid attribute in `DocSpring::TemplateFieldDependency`. 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?(:'status')
-        self.status = attributes[:'status']
+      if attributes.key?(:'action')
+        self.action = attributes[:'action']
       else
-        self.status = nil
+        self.action = nil
+      end
+
+      if attributes.key?(:'match')
+        self.match = attributes[:'match']
       end
 
-      if attributes.key?(:'error')
-        self.error = attributes[:'error']
+      if attributes.key?(:'conditions')
+        if (value = attributes[:'conditions']).is_a?(Array)
+          self.conditions = value
+        end
+      else
+        self.conditions = nil
+      end
+
+      if attributes.key?(:'targets')
+        if (value = attributes[:'targets']).is_a?(Array)
+          self.targets = value
+        end
+      else
+        self.targets = nil
+      end
+
+      if attributes.key?(:'group')
+        self.group = attributes[:'group']
       end
     end
 
@@ -105,8 +153,16 @@ module DocSpring
     def list_invalid_properties
       warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
       invalid_properties = Array.new
-      if @status.nil?
-        invalid_properties.push('invalid value for "status", status cannot be nil.')
+      if @action.nil?
+        invalid_properties.push('invalid value for "action", action cannot be nil.')
+      end
+
+      if @conditions.nil?
+        invalid_properties.push('invalid value for "conditions", conditions cannot be nil.')
+      end
+
+      if @targets.nil?
+        invalid_properties.push('invalid value for "targets", targets cannot be nil.')
       end
 
       invalid_properties
@@ -116,21 +172,40 @@ module DocSpring
     # @return true if the model is valid
     def valid?
       warn '[DEPRECATED] the `valid?` method is obsolete'
-      return false if @status.nil?
-      status_validator = EnumAttributeValidator.new('String', ["success", "error"])
-      return false unless status_validator.valid?(@status)
+      return false if @action.nil?
+      return false if @conditions.nil?
+      return false if @targets.nil?
       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"])
-      # build_from_hash accepts enum values this client doesn't know about yet
-      unless defined?(@_skip_enum_validation) || validator.valid?(status)
-        fail ArgumentError, "invalid value for \"status\", must be one of #{validator.allowable_values}."
+    # Custom attribute writer method with validation
+    # @param [Object] action Value to be assigned
+    def action=(action)
+      if action.nil?
+        fail ArgumentError, 'action cannot be nil'
+      end
+
+      @action = action
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] conditions Value to be assigned
+    def conditions=(conditions)
+      if conditions.nil?
+        fail ArgumentError, 'conditions cannot be nil'
+      end
+
+      @conditions = conditions
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] targets Value to be assigned
+    def targets=(targets)
+      if targets.nil?
+        fail ArgumentError, 'targets cannot be nil'
       end
-      @status = status
+
+      @targets = targets
     end
 
     # Checks equality by comparing each attribute.
@@ -138,8 +213,11 @@ module DocSpring
     def ==(o)
       return true if self.equal?(o)
       self.class == o.class &&
-          status == o.status &&
-          error == o.error
+          action == o.action &&
+          match == o.match &&
+          conditions == o.conditions &&
+          targets == o.targets &&
+          group == o.group
     end
 
     # @see the `==` method
@@ -151,7 +229,7 @@ module DocSpring
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [status, error].hash
+      [action, match, conditions, targets, group].hash
     end
 
     # Builds the object from hash
@@ -160,18 +238,20 @@ module DocSpring
     def self.build_from_hash(attributes)
       return nil unless attributes.is_a?(Hash)
       attributes = attributes.transform_keys(&:to_sym)
+      # include attributes inherited from allOf parents (the nearest declaration wins)
+      map = acceptable_attribute_map
       transformed_hash = {}
-      openapi_types.each_pair do |key, type|
-        if attributes.key?(attribute_map[key]) && attributes[attribute_map[key]].nil?
+      acceptable_openapi_types.each_pair do |key, type|
+        if attributes.key?(map[key]) && attributes[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) }
+          if attributes[map[key]].is_a?(Array)
+            transformed_hash["#{key}"] = attributes[map[key]].map { |v| _deserialize($1, v) }
           end
-        elsif !attributes[attribute_map[key]].nil?
-          transformed_hash["#{key}"] = _deserialize(type, attributes[attribute_map[key]])
+        elsif !attributes[map[key]].nil?
+          transformed_hash["#{key}"] = _deserialize(type, attributes[map[key]])
         end
       end
       # Responses can include enum values added after this client was released, so the enum setters
@@ -183,69 +263,15 @@ module DocSpring
       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|
+      # include attributes inherited from allOf parents (the nearest declaration wins)
+      self.class.acceptable_attribute_map.each_pair do |attr, param|
         value = self.send(attr)
         if value.nil?
-          is_nullable = self.class.openapi_nullable.include?(attr)
+          is_nullable = self.class.acceptable_openapi_nullable.include?(attr)
           next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
         end
 
@@ -254,24 +280,6 @@ module DocSpring
       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/docspring/models/template_field_dependency_action.rb

@@ -0,0 +1,42 @@
+=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.
+
+The version of the OpenAPI document: v2
+
+Generated by: https://openapi-generator.tech
+Generator version: 7.26.0-DOCSPRING
+
+=end
+
+require 'date'
+require 'time'
+
+module DocSpring
+  class TemplateFieldDependencyAction
+    REQUIRE_AND_SHOW = "require_and_show".freeze
+    SHOW = "show".freeze
+    REQUIRE = "require".freeze
+
+    def self.all_vars
+      @all_vars ||= [REQUIRE_AND_SHOW, SHOW, REQUIRE].freeze
+    end
+
+    # Builds the enum from string
+    # @param [String] The enum value in the form of the string
+    # @return [String] The enum value
+    def self.build_from_hash(value)
+      new.build_from_hash(value)
+    end
+
+    # Builds the enum from string
+    # @param [String] The enum value in the form of the string
+    # @return [String] The enum value
+    def build_from_hash(value)
+      # Only responses are built from hashes, and a value added to the API after this client was released is kept as it
+      # is: the constants are the values this client knows
+      value
+    end
+  end
+end